Class MenuBarSkin

java.lang.Object

javafx.scene.control.SkinBase<MenuBar>

javafx.scene.control.skin.MenuBarSkin

All Implemented Interfaces:

Skin<MenuBar>

public class MenuBarSkin
extends SkinBase<MenuBar>

Default skin implementation for the MenuBar control. In essence it is a simple toolbar. For the time being there is no overflow behavior and we just hide nodes which fall outside the bounds.

Since:

9

See Also:

• MenuBar

Property Summary

Properties

Type	Property	Description
final ObjectProperty<Pos>	containerAlignment	Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).
final DoubleProperty	spacing	Specifies the spacing between menu buttons on the MenuBar.

Constructor Summary

Constructors

Constructor	Description
MenuBarSkin(MenuBar control)	Creates a new MenuBarSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Method Summary

Modifier and Type	Method	Description
final ObjectProperty<Pos>	containerAlignmentProperty()	Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
final Pos	getContainerAlignment()	Gets the value of the containerAlignment property.
final double	getSpacing()	Gets the value of the spacing property.
final void	setContainerAlignment(Pos value)	Sets the value of the containerAlignment property.
static void	setDefaultSystemMenuBar(MenuBar menuBar)	Set the default system menu bar.
final void	setSpacing(double value)	Sets the value of the spacing property.
final DoubleProperty	spacingProperty()	Specifies the spacing between menu buttons on the MenuBar.

Methods declared in class SkinBase

computeBaselineOffset, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, consumeMouseEvents, dispose, executeAccessibleAction, getChildren, getCssMetaData, getNode, getSkinnable, layoutChildren, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, queryAccessibleAttribute, registerChangeListener, registerInvalidationListener, registerListChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners, unregisterInvalidationListeners, unregisterListChangeListeners

Modifier and Type	Method	Description
protected double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the baseline offset based on the first managed child.
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable height of the Skin, based on the provided width.
protected double	computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable width of the Skin, based on the provided height.
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable width of the Skin, based on the provided height.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
protected final void	consumeMouseEvents(boolean value)	Determines whether all mouse events should be automatically consumed.
void	dispose()	Called when a previously installed skin is about to be removed from its associated control.
protected void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final ObservableList<Node>	getChildren()	Returns the children of the skin.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
final Node	getNode()	Gets the Node which represents this Skin.
final MenuBar	getSkinnable()	Gets the Skinnable to which this Skin is assigned.
protected void	layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)	Called during the layout pass of the scenegraph.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
protected final void	registerChangeListener(ObservableValue<?> observable, Consumer<ObservableValue<?>> operation)	Registers an operation to perform when the given observable sends a change event.
protected final void	registerInvalidationListener(Observable observable, Consumer<Observable> operation)	Registers an operation to perform when the given observable sends an invalidation event.
protected final void	registerListChangeListener(ObservableList<?> observableList, Consumer<ListChangeListener.Change<?>> operation)	Registers an operation to perform when the given observableList sends a list change event.
protected double	snappedBottomInset()	Utility method to get the bottom inset which includes padding and border inset.
protected double	snappedLeftInset()	Utility method to get the left inset which includes padding and border inset.
protected double	snappedRightInset()	Utility method to get the right inset which includes padding and border inset.
protected double	snappedTopInset()	Utility method to get the top inset which includes padding and border inset.
protected double	snapPosition(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapPositionX() and snapPositionY()
protected double	snapPositionX(double value)	Convenience method for accessing the snapPositionX() method on the skinnable.
protected double	snapPositionY(double value)	Convenience method for accessing the snapPositionY() method on the skinnable.
protected double	snapSize(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSizeX() and snapSizeY()
protected double	snapSizeX(double value)	Convenience method for accessing the snapSizeX() method on the skinnable.
protected double	snapSizeY(double value)	Convenience method for accessing the snapSizeY() method on the skinnable.
protected double	snapSpace(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSpaceX() and snapSpaceY()
protected double	snapSpaceX(double value)	Convenience method for accessing the snapSpaceX() method on the skinnable.
protected double	snapSpaceY(double value)	Convenience method for accessing the snapSpaceY() method on the skinnable.
protected final Consumer<ObservableValue<?>>	unregisterChangeListeners(ObservableValue<?> observable)	Unregisters all operations that have been registered using SkinBase.registerChangeListener(ObservableValue, Consumer) for the given observable.
protected final Consumer<Observable>	unregisterInvalidationListeners(Observable observable)	Unregisters all operations that have been registered using SkinBase.registerInvalidationListener(Observable, Consumer) for the given observable.
protected final Consumer<ListChangeListener.Change<?>>	unregisterListChangeListeners(ObservableList<?> observableList)	Unregisters all operations that have been registered using SkinBase.registerListChangeListener(ObservableList, Consumer) for the given observableList.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods declared in interface Skin

install

Modifier and Type	Method	Description
default void	install()	Called once when Skin is set.

Property Details

spacing

public final DoubleProperty spacingProperty

Specifies the spacing between menu buttons on the MenuBar.

See Also:

• getSpacing()
• setSpacing(double)
• spacingProperty()

containerAlignment

public final ObjectProperty<Pos> containerAlignmentProperty

Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).

See Also:

• getContainerAlignment()
• setContainerAlignment(Pos)
• containerAlignmentProperty()

Constructor Details

MenuBarSkin

public MenuBarSkin(MenuBar control)

Creates a new MenuBarSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Parameters:

control - The control that this skin should be installed onto.

Method Details

setDefaultSystemMenuBar

public static void setDefaultSystemMenuBar(MenuBar menuBar)

Set the default system menu bar. This allows an application to keep menu in the system menu bar after the last Window is closed.

Parameters:

menuBar - the menu bar

setSpacing

public final void setSpacing(double value)

Sets the value of the spacing property.

Property description:

Specifies the spacing between menu buttons on the MenuBar.

Parameters:

value - the value for the spacing property

See Also:

• getSpacing()
• spacingProperty()

getSpacing

public final double getSpacing()

Gets the value of the spacing property.

Property description:

Specifies the spacing between menu buttons on the MenuBar.

Returns:

the value of the spacing property

See Also:

• setSpacing(double)
• spacingProperty()

spacingProperty

public final DoubleProperty spacingProperty()

Specifies the spacing between menu buttons on the MenuBar.

Returns:

the spacing property

See Also:

• getSpacing()
• setSpacing(double)

setContainerAlignment

public final void setContainerAlignment(Pos value)

Sets the value of the containerAlignment property.

Property description:

Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).

Parameters:

value - the value for the containerAlignment property

See Also:

• getContainerAlignment()
• containerAlignmentProperty()

getContainerAlignment

public final Pos getContainerAlignment()

Gets the value of the containerAlignment property.

Property description:

Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).

Returns:

the value of the containerAlignment property

See Also:

• setContainerAlignment(Pos)
• containerAlignmentProperty()

containerAlignmentProperty

public final ObjectProperty<Pos> containerAlignmentProperty()

Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).

Returns:

the containerAlignment property

See Also:

• getContainerAlignment()
• setContainerAlignment(Pos)

getClassCssMetaData

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:

the CssMetaData associated with this class, which may include the CssMetaData of its superclasses