JavaFX 27 · javafx.scene.layout.HeaderBar · APIdia, the JavaDoc alternative

A client-area header bar that is used as a replacement for the system-provided header bar in stages with the StageStyle#EXTENDED style. This class enables the click-and-drag to move and double-click to maximize behaviors that are usually afforded by system-provided header bars. The entire HeaderBar background is draggable by default, but its content is not. Applications can specify draggable content nodes of the HeaderBar with the dragType attached property.

HeaderBar is a layout container that allows applications to place scene graph nodes in three areas: left, center, and right. All areas can be null. The default minHeight of the HeaderBar is set to match systemMinHeight (unless explicitly set by a stylesheet or application code), which usually corresponds to the height of the system-provided header buttons.

Single header bar

Most applications should only add a single HeaderBar to the scene graph, placed at the top of the scene and extending its entire width. This ensures that the reported values for leftSystemInset and rightSystemInset, which describe the areas reserved for the system-provided header buttons, correctly align with the location of the HeaderBar and are taken into account when the contents of the HeaderBar are laid out.

Multiple header bars

Applications that use multiple header bars might need to configure the additional padding inserted into the layout to account for the system-reserved areas. For example, when two header bars are placed next to each other in the horizontal direction, the default configuration adds unnecessary additional padding between the two header bars. In this case, the leftSystemPadding and rightSystemPadding properties can be used to remove the padding that is not needed.

Header button height

Applications can specify the preferred height for the system-provided header buttons by setting the systemButtonHeight attached property for the Stage associated with the header bar. This can be used to achieve a more cohesive visual appearance by having the system-provided header buttons match the height of the client-area header bar.

Color scheme

The color scheme of the system-provided default header buttons is automatically adjusted to match the scene color scheme. Applications can specify a different color scheme for the system-provided header buttons with the systemColorScheme attached property.

Custom header buttons

If more control over the header buttons is desired, applications can opt out of the system-provided header buttons by setting the systemButtonHeight attached property for the Stage associated with the header bar to zero and place custom header buttons in the JavaFX scene graph instead. Any JavaFX control can be used as a custom header button by specifying its semantic type with the buttonType attached property.

System menu

Some platforms support a system menu that can be summoned by right-clicking the draggable area. The system menu will not be shown when:

the Stage is in full-screen mode, or
the HeaderBar has consumed the ContextMenuEvent#CONTEXT_MENU_REQUESTED event.

Layout constraints

The left and right children will be resized to their preferred widths and extend the height of the HeaderBar. The center child will be resized to fill the available space. HeaderBar honors the minimum, preferred, and maximum sizes of its children. If a child's resizable range prevents it from being resized to fit within its position, it will be vertically centered relative to the available space; this alignment can be customized with a layout constraint.

An application may set constraints on individual children to customize their layout. For each constraint, HeaderBar provides static getter and setter methods.

Layout constraints of `HeaderBar`
Constraint	Type	Description
alignment	`Pos`	The alignment of the child within its area of the `HeaderBar`.
margin	`Insets`	Margin space around the outside of the child.

Special layout of centered child

If a child is configured to be centered in the center area (i.e. its alignment constraint is either null, Pos#CENTER, Pos#TOP_CENTER, or Pos#BOTTOM_CENTER), it will be centered with respect to the entire header bar, and not with respect to the center area only. This means that, for a header bar that extends the entire width of the Stage, the child will appear to be horizontally centered within the Stage.

If a child should instead be centered with respect to the center area only, a possible solution is to place another layout container (such as BorderPane) in the center area, and then center the child within the other layout container.

Example

Usually, HeaderBar is placed in a root container like BorderPane to align it with the top of the scene:

public class MyApp extends Application {
    @Override
    public void start(Stage stage) {
        var button = new Button("My button");
        HeaderBar.setAlignment(button, Pos.CENTER_LEFT);
        HeaderBar.setMargin(button, new Insets(5));

        var headerBar = new HeaderBar();
        headerBar.setCenter(button);

        var root = new BorderPane();
        root.setTop(headerBar);

        stage.setScene(new Scene(root));
        stage.initStyle(StageStyle.EXTENDED);
        stage.show();
    }
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	HeaderBar.NodeProperty

Field Summary

Modifier and Type	Field and Description
private static final String	ALIGNMENT
private ObjectProperty<Node>	center The center area of the `HeaderBar`.
private ObjectProperty<Node>	left Hides javafx.scene.Parent.left. The left area of the `HeaderBar`.
private BooleanProperty	leftSystemPadding Specifies whether additional padding should be added to the left side of the `HeaderBar`.
private static final String	MARGIN
private ObjectProperty<Node>	right Hides javafx.scene.Parent.right. The right area of the `HeaderBar`.
private BooleanProperty	rightSystemPadding Specifies whether additional padding should be added to the right side of the `HeaderBar`.
private Subscription	subscriptions
public static final double	USE_DEFAULT_SIZE Sentinel value that can be used for the `systemButtonHeight` attached property to indicate that the platform should choose the platform-specific default button height.

Inherited from javafx.scene.layout.Region:: TEMP_VEC2D USE_COMPUTED_SIZE USE_PREF_SIZE

Constructor Summary

Access	Constructor and Description
public	HeaderBar() Creates a new `HeaderBar`.
public	HeaderBar(Node the left node, or `null` left, Node the center node, or `null` center, Node the right node, or `null` right) Creates a new `HeaderBar` with the specified children.

Method Summary

Modifier and Type	Method and Description
public static ObjectProperty<HeaderButtonType>	Returns: the `buttonType` property buttonTypeProperty(Node the child node child) Specifies the `HeaderButtonType` of the child, indicating its semantic use in the header bar.
public final ObjectProperty<Node>	centerProperty()
private boolean	childHasContentBias(Node child, Orientation orientation)
protected double	computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region.
protected double	computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
public static ObjectProperty<HeaderDragType>	Returns: the `dragType` property dragTypeProperty(Node the child node child) Specifies the `HeaderDragType` of the child, indicating whether it is a draggable part of the `HeaderBar`.
public static Pos	Returns: the alignment position for the child, or `null` if no alignment was set getAlignment(Node the child node child) Returns the child's alignment in the `HeaderBar`.
private double	getAreaHeight(Node child, double width, boolean minimum)
private double	getAreaWidth(Node child, double height, boolean minimum)
public static HeaderButtonType	Returns: the `HeaderButtonType`, or `null` getButtonType(Node the child node child) Gets the value of the `buttonType` attached property for the specified child.
public final Node	getCenter()
public static HeaderDragType	Returns: the `HeaderDragType`, or `null` if not set getDragType(Node the child node child) Gets the value of the `dragType` attached property for the specified child.
public final Node	getLeft()
public static Dimension2D	Returns: the size of the left system-reserved inset getLeftSystemInset(Stage the `Stage` stage) Gets the value of the `leftSystemInset` attached property for the specified `Stage`.
public static Insets	Returns: the margin for the child, or `null` if no margin was set getMargin(Node the child node child) Returns the child's margin.
private Insets	getNodeMargin(Node child)
public final Node	getRight()
public static Dimension2D	Returns: the size of the right system-reserved inset getRightSystemInset(Stage the `Stage` stage) Gets the value of the `rightSystemInset` attached property for the specified `Stage`.
public static double	Returns: the preferred height of the system-provided header buttons getSystemButtonHeight(Stage the `Stage` stage) Gets the value of the `systemButtonHeight` attached property for the specified `Stage`.
public static ColorScheme	Returns: the color scheme getSystemColorScheme(Stage the `Stage` stage) Gets the value of the `systemColorScheme` attached property for the specified `Stage`.
public static double	Returns: the system-recommended minimum height for the `HeaderBar` getSystemMinHeight(Stage the `Stage` stage) Gets the value of the `systemMinHeight` attached property for the specified `Stage`.
public final boolean	isLeftSystemPadding()
public final boolean	isRightSystemPadding()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObjectProperty<Node>	leftProperty()
public static ReadOnlyObjectProperty<Dimension2D>	Returns: the `leftSystemInset` attached property leftSystemInsetProperty(Stage the `Stage` stage) Describes the size of the left system-reserved inset for the specified `Stage`, which is an area reserved for the iconify, maximize, and close window buttons.
public final BooleanProperty	leftSystemPaddingProperty()
private void	onStageChanged(Stage stage)
private double	resizeChild(Node child, double adjustedWidth, boolean fillWidth, double insideHeight, Insets margin)
public final ObjectProperty<Node>	rightProperty()
public static ReadOnlyObjectProperty<Dimension2D>	Returns: the `rightSystemInset` attached property rightSystemInsetProperty(Stage the `Stage` stage) Describes the size of the right system-reserved inset for the specified `Stage`, which is an area reserved for the iconify, maximize, and close window buttons.
public final BooleanProperty	rightSystemPaddingProperty()
public static void	setAlignment(Node the child node child, Pos the alignment position value) Sets the alignment for the child when contained in a `HeaderBar`.
public static void	setButtonType(Node the child node child, HeaderButtonType the `HeaderButtonType`, or `null` value) Sets the value of the `buttonType` attached property for the specified child.
public final void	setCenter(Node value)
public static void	setDragType(Node the child node child, HeaderDragType the `HeaderDragType`, or `null` to remove the flag value) Sets the value of the `dragType` attached property for the specified child.
public final void	setLeft(Node value)
public final void	setLeftSystemPadding(boolean value)
public static void	setMargin(Node the child node child, Insets the margin of space around the child value) Sets the margin for the child when contained in a `HeaderBar`.
public final void	setRight(Node value)
public final void	setRightSystemPadding(boolean value)
public static void	setSystemButtonHeight(Stage the `Stage` stage, double the preferred height, or 0 to hide the system-provided header buttons height) Sets the value of the `systemButtonHeight` attached property for the specified `Stage`.
public static void	setSystemColorScheme(Stage the `Stage` stage, ColorScheme the color scheme, or `null` to indicate no preference value) Sets the value of the `systemColorScheme` attached property for the specified `Stage`.
public static DoubleProperty	Returns: the `systemButtonHeight` attached property systemButtonHeightProperty(Stage the `Stage` stage) Specifies the preferred height of the system-provided header buttons for the specified `Stage`.
public static ObjectProperty<ColorScheme>	Returns: the `systemColorScheme` attached property systemColorSchemeProperty(Stage the `Stage` stage) Specifies the color scheme of the system-provided header buttons for the specified `Stage`.
public static ReadOnlyDoubleProperty	Returns: the `systemMinHeight` attached property systemMinHeightProperty(Stage the `Stage` stage) Specifies the system-recommended minimum height for the `HeaderBar` for the specified `Stage`, which usually corresponds to the height of the default header buttons.

Inherited from javafx.scene.layout.Region:: addImageListener adjustHeightByMargin adjustWidthByMargin backgroundProperty borderProperty boundedNodeSizeWithBias boundedSize cacheShapeProperty centerShapeProperty computeChildMaxAreaHeight computeChildMaxAreaWidth computeChildMinAreaHeight computeChildMinAreaHeight computeChildMinAreaWidth computeChildMinAreaWidth computeChildPrefAreaHeight computeChildPrefAreaHeight computeChildPrefAreaWidth computeChildPrefAreaWidth computeMaxHeight computeMaxMinAreaHeight computeMaxMinAreaHeight computeMaxMinAreaHeight computeMaxMinAreaWidth computeMaxMinAreaWidth computeMaxMinAreaWidth computeMaxPrefAreaHeight computeMaxPrefAreaHeight computeMaxPrefAreaHeight computeMaxPrefAreaWidth computeMaxPrefAreaWidth computeMaxPrefAreaWidth computeMaxWidth computePrefWidth computeXOffset computeYOffset createDoubleArray getAreaBaselineOffset getAreaBaselineOffset getAreaBaselineOffset getAreaBaselineOffset getAreaBaselineOffset getAreaBaselineOffset getBackground getBorder getClassCssMetaData getCssMetaData getHeight getInsets getMaxBaselineComplement getMaxHeight getMaxWidth getMinBaselineComplement getMinHeight getMinWidth getOpaqueInsets getPadding getPrefBaselineComplement getPrefHeight getPrefWidth getShape getSnapScaleX getSnapScaleY getUserAgentStylesheet getWidth heightProperty insetsProperty isCacheShape isCenterShape isResizable isScaleShape isSnapToPixel layoutInArea layoutInArea layoutInArea layoutInArea maxHeight maxHeightProperty maxWidth maxWidthProperty minHeight minHeightProperty minWidth minWidthProperty opaqueInsetsProperty paddingProperty positionInArea positionInArea prefHeight prefHeightProperty prefWidth prefWidthProperty removeImageListener resize scaleShapeProperty setBackground setBorder setCacheShape setCenterShape setHeight setMaxHeight setMaxSize setMaxWidth setMinHeight setMinSize setMinWidth setOpaqueInsets setPadding setPrefHeight setPrefSize setPrefWidth setScaleShape setShape setSnapToPixel setWidth shapeProperty snappedBottomInset snappedLeftInset snappedRightInset snappedTopInset snapPortionX snapPortionY snapPosition snapPositionX snapPositionY snapSize snapSizeX snapSizeY snapSpace snapSpaceX snapSpaceY snapToPixelProperty widthProperty

Field Detail

ALIGNMENT	back to summary
private static final String ALIGNMENT

center back to summary

center	back to summary
private ObjectProperty<Node> center The center area of the `HeaderBar`. Default Value `null`

private ObjectProperty<Node> center

The center area of the HeaderBar.

Default Value: null

left back to summary

left	back to summary
private ObjectProperty<Node> left Hides javafx.scene.Parent.left. The left area of the `HeaderBar`. Default Value `null`

private ObjectProperty<Node> left

Hides javafx.scene.Parent.left.

The left area of the HeaderBar.

Default Value: null

leftSystemPadding back to summary

leftSystemPadding	back to summary
private BooleanProperty leftSystemPadding Specifies whether additional padding should be added to the left side of the `HeaderBar`. The size of the additional padding corresponds to the size of the system-reserved area that contains the default header buttons (iconify, maximize, and close). If the system-reserved area contains no header buttons, no additional padding is added to the left side of the `HeaderBar`. Applications that use a single `HeaderBar` extending the entire width of the window should set this property to `true` to prevent the header buttons from overlapping the content of the `HeaderBar`. Default Value `true` See Also `rightSystemPadding`

private BooleanProperty leftSystemPadding

Specifies whether additional padding should be added to the left side of the HeaderBar. The size of the additional padding corresponds to the size of the system-reserved area that contains the default header buttons (iconify, maximize, and close). If the system-reserved area contains no header buttons, no additional padding is added to the left side of the HeaderBar.

Applications that use a single HeaderBar extending the entire width of the window should set this property to true to prevent the header buttons from overlapping the content of the HeaderBar.

Default Value: true
See Also: rightSystemPadding

MARGIN	back to summary
private static final String MARGIN

right back to summary

right	back to summary
private ObjectProperty<Node> right Hides javafx.scene.Parent.right. The right area of the `HeaderBar`. Default Value `null`

private ObjectProperty<Node> right

Hides javafx.scene.Parent.right.

The right area of the HeaderBar.

Default Value: null

rightSystemPadding back to summary

rightSystemPadding	back to summary
private BooleanProperty rightSystemPadding Specifies whether additional padding should be added to the right side of the `HeaderBar`. The size of the additional padding corresponds to the size of the system-reserved area that contains the default header buttons (iconify, maximize, and close). If the system-reserved area contains no header buttons, no additional padding is added to the right side of the `HeaderBar`. Applications that use a single `HeaderBar` extending the entire width of the window should set this property to `true` to prevent the header buttons from overlapping the content of the `HeaderBar`. Default Value `true` See Also `leftSystemPadding`

private BooleanProperty rightSystemPadding

Specifies whether additional padding should be added to the right side of the HeaderBar. The size of the additional padding corresponds to the size of the system-reserved area that contains the default header buttons (iconify, maximize, and close). If the system-reserved area contains no header buttons, no additional padding is added to the right side of the HeaderBar.

Applications that use a single HeaderBar extending the entire width of the window should set this property to true to prevent the header buttons from overlapping the content of the HeaderBar.

Default Value: true
See Also: leftSystemPadding

subscriptions	back to summary
private Subscription subscriptions

USE_DEFAULT_SIZE	back to summary
public static final double USE_DEFAULT_SIZE Sentinel value that can be used for the `systemButtonHeight` attached property to indicate that the platform should choose the platform-specific default button height.

Constructor Detail

HeaderBar	back to summary
public HeaderBar() Creates a new `HeaderBar`.

HeaderBar back to summary

HeaderBar	back to summary
public HeaderBar(Node left, Node center, Node right) Creates a new `HeaderBar` with the specified children. Parameters left:Node the left node, or `null` center:Node the center node, or `null` right:Node the right node, or `null`

public HeaderBar(Node left, Node center, Node right)

Creates a new HeaderBar with the specified children.

Parameters

left:Node: the left node, or null
center:Node: the center node, or null
right:Node: the right node, or null

Method Detail

buttonTypeProperty back to summary

buttonTypeProperty	back to summary
public static ObjectProperty<HeaderButtonType> buttonTypeProperty(Node child) Specifies the `HeaderButtonType` of the child, indicating its semantic use in the header bar. This property can be set on any `Node`. Specifying a `HeaderButtonType` also provides the behavior associated with the button type. If the default behavior is not desired, applications can register an event filter on the child node that consumes the `MouseEvent#MOUSE_RELEASED` event. Parameters child:Node the child node Returns:ObjectProperty<HeaderButtonType> the `buttonType` property Annotations @SuppressWarnings:unchecked Default Value `null`

public static ObjectProperty<HeaderButtonType> buttonTypeProperty(Node child)

Specifies the HeaderButtonType of the child, indicating its semantic use in the header bar.

This property can be set on any Node. Specifying a HeaderButtonType also provides the behavior associated with the button type. If the default behavior is not desired, applications can register an event filter on the child node that consumes the MouseEvent#MOUSE_RELEASED event.

Parameters

child:Node: the child node

Returns:ObjectProperty<HeaderButtonType>

the buttonType property

Annotations

@SuppressWarnings:unchecked

Default Value

null

centerProperty	back to summary
public final ObjectProperty<Node> centerProperty()

childHasContentBias	back to summary
private boolean childHasContentBias(Node child, Orientation orientation)

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Doc from javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

dragTypeProperty back to summary

dragTypeProperty	back to summary
public static ObjectProperty<HeaderDragType> dragTypeProperty(Node child) Specifies the `HeaderDragType` of the child, indicating whether it is a draggable part of the `HeaderBar`. A value of `null` indicates that the drag type is not set. Parameters child:Node the child node Returns:ObjectProperty<HeaderDragType> the `dragType` property Annotations @SuppressWarnings:unchecked Default Value `null`

public static ObjectProperty<HeaderDragType> dragTypeProperty(Node child)

Specifies the HeaderDragType of the child, indicating whether it is a draggable part of the HeaderBar. A value of null indicates that the drag type is not set.

Parameters

child:Node: the child node

Returns:ObjectProperty<HeaderDragType>

the dragType property

Annotations

@SuppressWarnings:unchecked

Default Value

null

getAlignment back to summary

getAlignment	back to summary
public static Pos getAlignment(Node child) Returns the child's alignment in the `HeaderBar`. Parameters child:Node the child node Returns:Pos the alignment position for the child, or `null` if no alignment was set

public static Pos getAlignment(Node child)

Returns the child's alignment in the HeaderBar.

Parameters

child:Node: the child node

Returns:Pos

the alignment position for the child, or null if no alignment was set

getAreaHeight	back to summary
private double getAreaHeight(Node child, double width, boolean minimum)

getAreaWidth	back to summary
private double getAreaWidth(Node child, double height, boolean minimum)

getButtonType back to summary

getButtonType	back to summary
public static HeaderButtonType getButtonType(Node child) Gets the value of the `buttonType` attached property for the specified child. Parameters child:Node the child node Returns:HeaderButtonType the `HeaderButtonType`, or `null` Annotations @SuppressWarnings:unchecked

public static HeaderButtonType getButtonType(Node child)

Gets the value of the buttonType attached property for the specified child.

Parameters

child:Node: the child node

Returns:HeaderButtonType

the HeaderButtonType, or null

Annotations

@SuppressWarnings:unchecked

getCenter	back to summary
public final Node getCenter()

getDragType back to summary

getDragType	back to summary
public static HeaderDragType getDragType(Node child) Gets the value of the `dragType` attached property for the specified child. Parameters child:Node the child node Returns:HeaderDragType the `HeaderDragType`, or `null` if not set Annotations @SuppressWarnings:unchecked

public static HeaderDragType getDragType(Node child)

Gets the value of the dragType attached property for the specified child.

Parameters

child:Node: the child node

Returns:HeaderDragType

the HeaderDragType, or null if not set

Annotations

@SuppressWarnings:unchecked

getLeft	back to summary
public final Node getLeft()

getLeftSystemInset back to summary

getLeftSystemInset	back to summary
public static Dimension2D getLeftSystemInset(Stage stage) Gets the value of the `leftSystemInset` attached property for the specified `Stage`. Parameters stage:Stage the `Stage` Returns:Dimension2D the size of the left system-reserved inset

public static Dimension2D getLeftSystemInset(Stage stage)

Gets the value of the leftSystemInset attached property for the specified Stage.

Parameters

stage:Stage: the Stage

Returns:Dimension2D

the size of the left system-reserved inset

getMargin back to summary

getMargin	back to summary
public static Insets getMargin(Node child) Returns the child's margin. Parameters child:Node the child node Returns:Insets the margin for the child, or `null` if no margin was set

public static Insets getMargin(Node child)

Returns the child's margin.

Parameters

child:Node: the child node

Returns:Insets

the margin for the child, or null if no margin was set

getNodeMargin	back to summary
private Insets getNodeMargin(Node child)

getRight	back to summary
public final Node getRight()

getRightSystemInset back to summary

getRightSystemInset	back to summary
public static Dimension2D getRightSystemInset(Stage stage) Gets the value of the `rightSystemInset` attached property for the specified `Stage`. Parameters stage:Stage the `Stage` Returns:Dimension2D the size of the right system-reserved inset

public static Dimension2D getRightSystemInset(Stage stage)

Gets the value of the rightSystemInset attached property for the specified Stage.

Parameters

stage:Stage: the Stage

Returns:Dimension2D

the size of the right system-reserved inset

getSystemButtonHeight back to summary

getSystemButtonHeight	back to summary
public static double getSystemButtonHeight(Stage stage) Gets the value of the `systemButtonHeight` attached property for the specified `Stage`. Parameters stage:Stage the `Stage` Returns:double the preferred height of the system-provided header buttons

public static double getSystemButtonHeight(Stage stage)

Gets the value of the systemButtonHeight attached property for the specified Stage.

Parameters

stage:Stage: the Stage

Returns:double

the preferred height of the system-provided header buttons

getSystemColorScheme back to summary

getSystemColorScheme	back to summary
public static ColorScheme getSystemColorScheme(Stage stage) Gets the value of the `systemColorScheme` attached property for the specified `Stage`. Parameters stage:Stage the `Stage` Returns:ColorScheme the color scheme

public static ColorScheme getSystemColorScheme(Stage stage)

Gets the value of the systemColorScheme attached property for the specified Stage.

Parameters

stage:Stage: the Stage

Returns:ColorScheme

the color scheme

getSystemMinHeight back to summary

getSystemMinHeight	back to summary
public static double getSystemMinHeight(Stage stage) Gets the value of the `systemMinHeight` attached property for the specified `Stage`. Parameters stage:Stage the `Stage` Returns:double the system-recommended minimum height for the `HeaderBar`

public static double getSystemMinHeight(Stage stage)

Gets the value of the systemMinHeight attached property for the specified Stage.

Parameters

stage:Stage: the Stage

Returns:double

the system-recommended minimum height for the HeaderBar

isLeftSystemPadding	back to summary
public final boolean isLeftSystemPadding()

isRightSystemPadding	back to summary
public final boolean isRightSystemPadding()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Doc from javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning. Subclasses should override this function to layout content as needed. Annotations @Override

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

leftProperty	back to summary
public final ObjectProperty<Node> leftProperty()

leftSystemInsetProperty back to summary

leftSystemInsetProperty	back to summary
public static ReadOnlyObjectProperty<Dimension2D> leftSystemInsetProperty(Stage stage) Describes the size of the left system-reserved inset for the specified `Stage`, which is an area reserved for the iconify, maximize, and close window buttons. If there are no window buttons on the left side of the window, the returned area is an empty `Dimension2D`. Parameters stage:Stage the `Stage` Returns:ReadOnlyObjectProperty<Dimension2D> the `leftSystemInset` attached property

public static ReadOnlyObjectProperty<Dimension2D> leftSystemInsetProperty(Stage stage)

Describes the size of the left system-reserved inset for the specified Stage, which is an area reserved for the iconify, maximize, and close window buttons. If there are no window buttons on the left side of the window, the returned area is an empty Dimension2D.

Parameters

stage:Stage: the Stage

Returns:ReadOnlyObjectProperty<Dimension2D>

the leftSystemInset attached property

leftSystemPaddingProperty	back to summary
public final BooleanProperty leftSystemPaddingProperty()

onStageChanged	back to summary
private void onStageChanged(Stage stage)

resizeChild	back to summary
private double resizeChild(Node child, double adjustedWidth, boolean fillWidth, double insideHeight, Insets margin)

rightProperty	back to summary
public final ObjectProperty<Node> rightProperty()

rightSystemInsetProperty back to summary

rightSystemInsetProperty	back to summary
public static ReadOnlyObjectProperty<Dimension2D> rightSystemInsetProperty(Stage stage) Describes the size of the right system-reserved inset for the specified `Stage`, which is an area reserved for the iconify, maximize, and close window buttons. If there are no window buttons on the right side of the window, the returned area is an empty `Dimension2D`. Parameters stage:Stage the `Stage` Returns:ReadOnlyObjectProperty<Dimension2D> the `rightSystemInset` attached property

public static ReadOnlyObjectProperty<Dimension2D> rightSystemInsetProperty(Stage stage)

Describes the size of the right system-reserved inset for the specified Stage, which is an area reserved for the iconify, maximize, and close window buttons. If there are no window buttons on the right side of the window, the returned area is an empty Dimension2D.

Parameters

stage:Stage: the Stage

Returns:ReadOnlyObjectProperty<Dimension2D>

the rightSystemInset attached property

rightSystemPaddingProperty	back to summary
public final BooleanProperty rightSystemPaddingProperty()

setAlignment back to summary

setAlignment	back to summary
public static void setAlignment(Node child, Pos value) Sets the alignment for the child when contained in a `HeaderBar`. If set, it will override the header bar's default alignment for the child's position. Setting the value to `null` will remove the constraint. Parameters child:Node the child node value:Pos the alignment position

public static void setAlignment(Node child, Pos value)

Sets the alignment for the child when contained in a HeaderBar. If set, it will override the header bar's default alignment for the child's position. Setting the value to null will remove the constraint.

Parameters

child:Node: the child node
value:Pos: the alignment position

setButtonType back to summary

public static void setButtonType(Node child, HeaderButtonType value)

Sets the value of the buttonType attached property for the specified child.

Parameters

child:Node: the child node
value:HeaderButtonType: the HeaderButtonType, or null

setCenter	back to summary
public final void setCenter(Node value)

setDragType back to summary

public static void setDragType(Node child, HeaderDragType value)

Sets the value of the dragType attached property for the specified child.

Parameters

child:Node: the child node
value:HeaderDragType: the HeaderDragType, or null to remove the flag

setLeft	back to summary
public final void setLeft(Node value)

setLeftSystemPadding	back to summary
public final void setLeftSystemPadding(boolean value)

setMargin back to summary

public static void setMargin(Node child, Insets value)

Sets the margin for the child when contained in a HeaderBar. If set, the header bar will lay it out with the margin space around it. Setting the value to null will remove the constraint.

Parameters

child:Node: the child node
value:Insets: the margin of space around the child

setRight	back to summary
public final void setRight(Node value)

setRightSystemPadding	back to summary
public final void setRightSystemPadding(boolean value)

setSystemButtonHeight back to summary

public static void setSystemButtonHeight(Stage stage, double height)

Sets the value of the systemButtonHeight attached property for the specified Stage.

Parameters

stage:Stage: the Stage
height:double: the preferred height, or 0 to hide the system-provided header buttons

setSystemColorScheme back to summary

public static void setSystemColorScheme(Stage stage, ColorScheme value)

Sets the value of the systemColorScheme attached property for the specified Stage.

Parameters

stage:Stage: the Stage
value:ColorScheme: the color scheme, or null to indicate no preference

systemButtonHeightProperty back to summary

public static DoubleProperty systemButtonHeightProperty(Stage stage)

Specifies the preferred height of the system-provided header buttons for the specified Stage.

Any value except zero and USE_DEFAULT_SIZE is only a hint for the platform window toolkit. The platform might accommodate the preferred height in various ways, such as by stretching the header buttons (fully or partially) to fill the preferred height, or centering the header buttons (fully or partially) within the preferred height. Some platforms might only accommodate the preferred height within platform-specific constraints, or ignore it entirely.

Setting the preferred height to zero hides the system-provided header buttons, allowing applications to use custom header buttons instead (see setButtonType(Node, HeaderButtonType)).

The default value USE_DEFAULT_SIZE indicates that the platform should choose the button height.

Parameters

stage:Stage: the Stage

Returns:DoubleProperty

the systemButtonHeight attached property

Default Value

USE_DEFAULT_SIZE

systemColorSchemeProperty back to summary

public static ObjectProperty<ColorScheme> systemColorSchemeProperty(Stage stage)

Specifies the color scheme of the system-provided header buttons for the specified Stage.

This is a null-coalescing property: if set to null (using the setter method, Property#setValue(Object), or with a binding), the property evaluates to the value of Scene.Preferences#colorSchemeProperty(). Likewise, specifying a non-null value will override the scene-provided value. Overriding the scene-provided color scheme is usually only necessary in the rare case when an application needs different color schemes for header buttons and the window content (bright title bar in dark mode, or a dark title bar in light mode).

The specified color scheme is only a hint for the platform window toolkit and may be ignored.

Parameters

stage:Stage: the Stage

Returns:ObjectProperty<ColorScheme>

the systemColorScheme attached property

Default Value

Scene.Preferences#getColorScheme()

systemMinHeightProperty back to summary

public static ReadOnlyDoubleProperty systemMinHeightProperty(Stage stage)

Specifies the system-recommended minimum height for the HeaderBar for the specified Stage, which usually corresponds to the height of the default header buttons. Applications can use this value as a sensible lower limit for the height of the HeaderBar.

By default, minHeight is set to the value of systemMinHeight, unless minHeight is explicitly set by a stylesheet or application code.

Parameters

stage:Stage: the Stage

Returns:ReadOnlyDoubleProperty

the systemMinHeight attached property

Modifier and Type	Field and Description
private final String	name
private Node	value Hides javafx.beans.property.ObjectPropertyBase.value.

Modifier and Type	Method and Description
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
protected void	invalidated() Overrides javafx.beans.property.ObjectPropertyBase.invalidated. The method `invalidated()` can be overridden to receive invalidation notifications.

public Class HeaderBar

Single header bar

Multiple header bars

Header button height

Color scheme

Custom header buttons

System menu

Layout constraints

Special layout of centered child

Example

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HeaderBar.NodeProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail