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 setDragType(Node, HeaderDragType) method.

HeaderBar is a layout container that allows applications to place scene graph nodes in three areas: leading, center, and trailing. All areas can be null. The default minHeight of the HeaderBar is set to match the height of the platform-specific default 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 area reserved for the system-provided window 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 incorrectly adds additional padding between the two header bars. In this case, the leadingSystemPadding and trailingSystemPadding properties can be used to remove the padding that is not needed.

Header button height

Applications can specify the preferred height for system-provided header buttons by setting the static setPrefButtonHeight(Stage, double) property on 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.

Custom header buttons

If more control over the header buttons is desired, applications can opt out of the system-provided header buttons by setting setPrefButtonHeight(Stage, double) 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 setting its semantic type with the setButtonType(Node, HeaderButtonType) method.

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 leading and trailing 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 be 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 like 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 static final String	BUTTON_TYPE
private final ObjectProperty<Node>	center The center area of the `HeaderBar`.
private boolean	currentFullScreen
private HeaderButtonMetrics	currentMetrics
private static final String	DRAG_TYPE
private static final Dimension2D	EMPTY
private final ObjectProperty<Node>	leading The leading area of the `HeaderBar`.
private final BooleanProperty	leadingSystemPadding Specifies whether additional padding should be added to the leading side of the `HeaderBar`.
private final ReadOnlyObjectWrapper<Dimension2D>	leftSystemInset Describes the size of the left system-reserved inset, which is an area reserved for the iconify, maximize, and close window buttons.
private static final String	MARGIN
private final ReadOnlyDoubleWrapper	minSystemHeight The system-provided minimum recommended height for the `HeaderBar`, which usually corresponds to the height of the default header buttons.
private final ReadOnlyObjectWrapper<Dimension2D>	rightSystemInset Describes the size of the right system-reserved inset, which is an area reserved for the iconify, maximize, and close window buttons.
private Subscription	subscription
private final ObjectProperty<Node>	trailing The trailing area of the `HeaderBar`.
private final BooleanProperty	trailingSystemPadding Specifies whether additional padding should be added to the trailing side of the `HeaderBar`.
public static final double	USE_DEFAULT_SIZE Sentinel value that can be used for `setPrefButtonHeight(Stage, double)` 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 leading node, or `null` leading, Node the center node, or `null` center, Node the trailing node, or `null` trailing) Creates a new `HeaderBar` with the specified children.

Method Summary

Modifier and Type	Method and Description
private Insets	adjustMarginForRTL(Insets margin, boolean rtl)
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 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) References Deprecated `HeaderButtonType` is deprecated or references (maybe indirectly) at least one deprecated element. Returns the `HeaderButtonType` of the specified child.
public final Node	getCenter()
public static HeaderDragType	Returns: the `HeaderDragType`, or `null` if not set getDragType(Node the child node child) References Deprecated `HeaderDragType` is deprecated or references (maybe indirectly) at least one deprecated element. Returns the `HeaderDragType` of the specified child.
public final Node	getLeading()
public final Dimension2D	getLeftSystemInset()
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.
public final double	getMinSystemHeight()
private Insets	getNodeMargin(Node child)
public static double	Returns: the preferred height of the system-provided header buttons getPrefButtonHeight(Stage the `Stage` stage) Returns the preferred height of the system-provided header buttons of the specified stage.
public final Dimension2D	getRightSystemInset()
public final Node	getTrailing()
public final boolean	isLeadingSystemPadding()
private boolean	isLeftSystemPadding(NodeOrientation nodeOrientation)
private boolean	isRightSystemPadding(NodeOrientation nodeOrientation)
public final boolean	isTrailingSystemPadding()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObjectProperty<Node>	leadingProperty()
public final BooleanProperty	leadingSystemPaddingProperty()
public final ReadOnlyObjectProperty<Dimension2D>	leftSystemInsetProperty()
public final ReadOnlyDoubleProperty	minSystemHeightProperty()
private void	onFullScreenChanged(boolean fullScreen)
private void	onMetricsChanged(HeaderButtonMetrics metrics)
private void	onStageChanged(Stage stage)
private double	resizeChild(Node child, double adjustedWidth, boolean fillWidth, double insideHeight, Insets margin)
public final ReadOnlyObjectProperty<Dimension2D>	rightSystemInsetProperty()
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) References Deprecated `HeaderButtonType` is deprecated or references (maybe indirectly) at least one deprecated element. Specifies the `HeaderButtonType` of the child, indicating its semantic use in the header bar.
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) References Deprecated `HeaderDragType` is deprecated or references (maybe indirectly) at least one deprecated element. Specifies the `HeaderDragType` of the child, indicating whether it is a draggable part of the `HeaderBar`.
public final void	setLeading(Node value)
public final void	setLeadingSystemPadding(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 static void	setPrefButtonHeight(Stage the `Stage` stage, double the preferred height, or 0 to hide the system-provided header buttons height) Specifies the preferred height of the system-provided header buttons of the specified stage.
public final void	setTrailing(Node value)
public final void	setTrailingSystemPadding(boolean value)
public final ObjectProperty<Node>	trailingProperty()
public final BooleanProperty	trailingSystemPaddingProperty()
private void	updateInsets()
public boolean	usesMirroring() Overrides javafx.scene.Node.usesMirroring. Determines whether a node should be mirrored when node orientation is right-to-left.

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

BUTTON_TYPE	back to summary
private static final String BUTTON_TYPE

center back to summary

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

private final ObjectProperty<Node> center

The center area of the HeaderBar.

Default Value: null

currentFullScreen	back to summary
private boolean currentFullScreen

currentMetrics	back to summary
private HeaderButtonMetrics currentMetrics

DRAG_TYPE	back to summary
private static final String DRAG_TYPE

EMPTY	back to summary
private static final Dimension2D EMPTY

leading back to summary

leading	back to summary
private final ObjectProperty<Node> leading The leading area of the `HeaderBar`. The leading area corresponds to the left area in a left-to-right layout, and to the right area in a right-to-left layout. Default Value `null`

private final ObjectProperty<Node> leading

The leading area of the HeaderBar.

The leading area corresponds to the left area in a left-to-right layout, and to the right area in a right-to-left layout.

Default Value: null

leadingSystemPadding back to summary

leadingSystemPadding	back to summary
private final BooleanProperty leadingSystemPadding Specifies whether additional padding should be added to the leading 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 leading 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 `trailingSystemPadding`

private final BooleanProperty leadingSystemPadding

Specifies whether additional padding should be added to the leading 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 leading 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: trailingSystemPadding

leftSystemInset back to summary

leftSystemInset	back to summary
private final ReadOnlyObjectWrapper<Dimension2D> leftSystemInset Describes the size of the left system-reserved inset, 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`. Note that the left system inset refers to the left side of the window, independent of layout orientation.

private final ReadOnlyObjectWrapper<Dimension2D> leftSystemInset

Describes the size of the left system-reserved inset, 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.

Note that the left system inset refers to the left side of the window, independent of layout orientation.

MARGIN	back to summary
private static final String MARGIN

minSystemHeight back to summary

minSystemHeight	back to summary
private final ReadOnlyDoubleWrapper minSystemHeight The system-provided minimum recommended height for the `HeaderBar`, 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 `minSystemHeight`, unless `minHeight` is explicitly set by a stylesheet or application code.

private final ReadOnlyDoubleWrapper minSystemHeight

The system-provided minimum recommended height for the HeaderBar, 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 minSystemHeight, unless minHeight is explicitly set by a stylesheet or application code.

rightSystemInset back to summary

rightSystemInset	back to summary
private final ReadOnlyObjectWrapper<Dimension2D> rightSystemInset Describes the size of the right system-reserved inset, 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`. Note that the right system inset refers to the right side of the window, independent of layout orientation.

private final ReadOnlyObjectWrapper<Dimension2D> rightSystemInset

Describes the size of the right system-reserved inset, 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.

Note that the right system inset refers to the right side of the window, independent of layout orientation.

subscription	back to summary
private Subscription subscription

trailing back to summary

trailing	back to summary
private final ObjectProperty<Node> trailing The trailing area of the `HeaderBar`. The trailing area corresponds to the right area in a left-to-right layout, and to the left area in a right-to-left layout. Default Value `null`

private final ObjectProperty<Node> trailing

The trailing area of the HeaderBar.

The trailing area corresponds to the right area in a left-to-right layout, and to the left area in a right-to-left layout.

Default Value: null

trailingSystemPadding back to summary

trailingSystemPadding	back to summary
private final BooleanProperty trailingSystemPadding Specifies whether additional padding should be added to the trailing 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 trailing 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 `leadingSystemPadding`

private final BooleanProperty trailingSystemPadding

Specifies whether additional padding should be added to the trailing 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 trailing 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: leadingSystemPadding

USE_DEFAULT_SIZE	back to summary
public static final double USE_DEFAULT_SIZE Sentinel value that can be used for `setPrefButtonHeight(Stage, double)` 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 leading, Node center, Node trailing) Creates a new `HeaderBar` with the specified children. Parameters leading:Node the leading node, or `null` center:Node the center node, or `null` trailing:Node the trailing node, or `null`

public HeaderBar(Node leading, Node center, Node trailing)

Creates a new HeaderBar with the specified children.

Parameters

leading:Node: the leading node, or null
center:Node: the center node, or null
trailing:Node: the trailing node, or null

Method Detail

adjustMarginForRTL	back to summary
private Insets adjustMarginForRTL(Insets margin, boolean rtl)

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

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) References Deprecated `HeaderButtonType` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns the `HeaderButtonType` of the specified child. Parameters child:Node the child node Returns:HeaderButtonType the `HeaderButtonType`, or `null`

public static HeaderButtonType getButtonType(Node child)

References Deprecated

HeaderButtonType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns the HeaderButtonType of the specified child.

Parameters

child:Node: the child node

Returns:HeaderButtonType

the HeaderButtonType, or null

getCenter	back to summary
public final Node getCenter()

getDragType back to summary

getDragType	back to summary
public static HeaderDragType getDragType(Node child) References Deprecated `HeaderDragType` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns the `HeaderDragType` of the specified child. Parameters child:Node the child node Returns:HeaderDragType the `HeaderDragType`, or `null` if not set

public static HeaderDragType getDragType(Node child)

References Deprecated

HeaderDragType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns the HeaderDragType of the specified child.

Parameters

child:Node: the child node

Returns:HeaderDragType

the HeaderDragType, or null if not set

getLeading	back to summary
public final Node getLeading()

getLeftSystemInset	back to summary
public final Dimension2D getLeftSystemInset()

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

getMinSystemHeight	back to summary
public final double getMinSystemHeight()

getNodeMargin	back to summary
private Insets getNodeMargin(Node child)

getPrefButtonHeight back to summary

getPrefButtonHeight	back to summary
public static double getPrefButtonHeight(Stage stage) Returns the preferred height of the system-provided header buttons of the specified stage. Parameters stage:Stage the `Stage` Returns:double the preferred height of the system-provided header buttons

public static double getPrefButtonHeight(Stage stage)

Returns the preferred height of the system-provided header buttons of the specified stage.

Parameters

stage:Stage: the Stage

Returns:double

the preferred height of the system-provided header buttons

getRightSystemInset	back to summary
public final Dimension2D getRightSystemInset()

getTrailing	back to summary
public final Node getTrailing()

isLeadingSystemPadding	back to summary
public final boolean isLeadingSystemPadding()

isLeftSystemPadding	back to summary
private boolean isLeftSystemPadding(NodeOrientation nodeOrientation)

isRightSystemPadding	back to summary
private boolean isRightSystemPadding(NodeOrientation nodeOrientation)

isTrailingSystemPadding	back to summary
public final boolean isTrailingSystemPadding()

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

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

leadingSystemPaddingProperty	back to summary
public final BooleanProperty leadingSystemPaddingProperty()

leftSystemInsetProperty	back to summary
public final ReadOnlyObjectProperty<Dimension2D> leftSystemInsetProperty()

minSystemHeightProperty	back to summary
public final ReadOnlyDoubleProperty minSystemHeightProperty()

onFullScreenChanged	back to summary
private void onFullScreenChanged(boolean fullScreen)

onMetricsChanged	back to summary
private void onMetricsChanged(HeaderButtonMetrics metrics)

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)

rightSystemInsetProperty	back to summary
public final ReadOnlyObjectProperty<Dimension2D> rightSystemInsetProperty()

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, 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)

References Deprecated

HeaderButtonType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

This property can be set on any Node. Specifying a header button type 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
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)

References Deprecated

HeaderDragType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Specifies the HeaderDragType of the child, indicating whether it is a draggable part of the HeaderBar.

Setting the value to null will remove the flag.

Parameters

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

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

setLeadingSystemPadding	back to summary
public final void setLeadingSystemPadding(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

setPrefButtonHeight back to summary

public static void setPrefButtonHeight(Stage stage, double height)

Specifies the preferred height of the system-provided header buttons of 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
height:double: the preferred height, or 0 to hide the system-provided header buttons

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

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

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

trailingSystemPaddingProperty	back to summary
public final BooleanProperty trailingSystemPaddingProperty()

updateInsets	back to summary
private void updateInsets()

usesMirroring back to summary

public boolean usesMirroring()

Overrides javafx.scene.Node.usesMirroring.

Doc from javafx.scene.Node.usesMirroring.

Determines whether a node should be mirrored when node orientation is right-to-left.

When a node is mirrored, the origin is automatically moved to the top right corner causing the node to layout children and draw from right to left using a mirroring transformation. Some nodes may wish to draw from right to left without using a transformation. These nodes will answer false and implement right-to-left orientation without using the automatic transformation.

Annotations

@Override

javafx.scene.layout back to summary

private final Class HeaderBar.NodeProperty

Class Inheritance

extends ObjectPropertyBase<Node>

java.lang.Object
javafx.beans.binding.ObjectExpression
javafx.beans.property.ReadOnlyObjectProperty
javafx.beans.property.ObjectProperty
javafx.beans.property.ObjectPropertyBase
javafx.scene.layout.HeaderBar.NodeProperty

Field Summary

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

Constructor Summary

Access	Constructor and Description
pack-priv	NodeProperty(String name)

Method Summary

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.

Inherited from javafx.beans.property.ObjectPropertyBase:: addListener addListener bind fireValueChangedEvent get isBound removeListener removeListener set toString unbind

Field Detail

name	back to summary
private final String name

value	back to summary
private Node value Hides javafx.beans.property.ObjectPropertyBase.value.

Constructor Detail

NodeProperty	back to summary
pack-priv NodeProperty(String name)

Method Detail

getBean back to summary

public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Annotations

@Override

getName back to summary

public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Annotations

@Override

invalidated back to summary

protected void invalidated()

Overrides javafx.beans.property.ObjectPropertyBase.invalidated.

Doc from javafx.beans.property.ObjectPropertyBase.invalidated.

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

Annotations

@Override

public Class HeaderBar

Single header bar

Multiple header bars

Header button height

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