JavaFX 24 · javafx.scene.control.skin.MenuBarSkin · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final CssMetaData<MenuBar, Pos>	ALIGNMENT
private boolean	altKeyPressed
private final HBox	container contains MenuBarButton's children only
private ObjectProperty<Pos>	containerAlignment Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).
private static Stage	currentMenuBarStage
pack-priv Runnable	firstMenuRunnable
private int	focusedMenuIndex index of focused MenuBarButton
private EventHandler<ActionEvent>	menuActionEventHandler
private ChangeListener<Boolean>	menuBarFocusedPropertyListener
private ListChangeListener<MenuItem>	menuItemListener
private ChangeListener<Boolean>	menuVisibilityChangeListener
private Menu	openMenu
private MenuBarButton	openMenuButton
private boolean	pendingDismiss
private ChangeListener<Scene>	sceneChangeListener
private ListenerHelper	sceneListenerHelper
private DoubleProperty	spacing Specifies the spacing between menu buttons on the MenuBar.
private static final CssMetaData<MenuBar, Number>	SPACING
private static final ObservableList<Window>	stages
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static WeakHashMap<Stage, Reference<MenuBarSkin>>	systemMenuMap
private WeakChangeListener<Boolean>	weakMenuBarFocusedPropertyListener
private WeakChangeListener<Boolean>	weakMenuVisibilityChangeListener
private IDisconnectable	windowFocusHelper
private static List<MenuBase>	wrappedDefaultMenus
private List<MenuBase>	wrappedMenus

Access	Constructor and Description
public	MenuBarSkin(final MenuBar The control that this skin should be installed onto. 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 and Description
private void	cleanUpListeners()
private void	cleanUpSystemMenu()
private void	clearMenuButtonHover()
protected double	computeMaxHeight(double The width of the Skin, in case this value might dictate the maximum height. width, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computeMaxHeight. Computes the maximum allowable height of the Skin, based on the provided width.
protected double	computeMinHeight(double The width of the Skin, in case this value might dictate the minimum height. width, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computeMinHeight. Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computeMinWidth(double The height of the Skin, in case this value might dictate the minimum width. height, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computeMinWidth. Computes the minimum allowable width of the Skin, based on the provided height.
protected double	computePrefHeight(double the width that should be used if preferred height depends on it width, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computePrefHeight. Calculates the preferred height of this `SkinBase`.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it height, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computePrefWidth. Calculates the preferred width of this `SkinBase`.
public final ObjectProperty<Pos>	containerAlignmentProperty()
public void	dispose() Overrides javafx.scene.control.SkinBase.dispose. Implements javafx.scene.control.Skin.dispose. Called when a previously installed skin is about to be removed from its associated control.
private Optional<Pair<Menu, Integer>>	findSibling(Direction dir, int startIndex)
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses getClassCssMetaData() Hides javafx.scene.control.SkinBase.getClassCssMetaData. Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
public final Pos	getContainerAlignment()
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.control.SkinBase.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
pack-priv int	getFocusedMenuIndex()
private int	getMenuBarButtonIndex(MenuBarButton m)
private static MenuBarSkin	getMenuBarSkin(Stage stage)
public final double	getSpacing()
private static void	initSystemMenuBar()
private boolean	isMenuEmpty(Menu menu)
protected void	layoutChildren(final double the x position x, final double the y position y, final double the width w, final double the height h) Overrides javafx.scene.control.SkinBase.layoutChildren. Called during the layout pass of the scenegraph.
pack-priv MenuBarButton	menuBarButtonAt(int i)
private boolean	menuContainsCustomMenuItem(Menu menu)
private void	menuModeEnd()
private void	menuModeStart(int newIndex)
private boolean	menusContainCustomMenuItem()
private void	moveToMenu(Direction dir, boolean doShow)
protected Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.control.SkinBase.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
private void	rebuildUI()
private void	resetOpenMenu()
public final void	setContainerAlignment(Pos value)
public static void	setDefaultSystemMenuBar(final MenuBar the menu bar menuBar) Set the default system menu bar.
pack-priv void	setFocusedMenuIndex(int index) This method is package scoped as it is used in this class as well as for testing
public final void	setSpacing(double value)
private static void	setSystemMenu(Stage stage)
private void	showMenu(Menu menu)
private void	showMenu(Menu menu, boolean selectFirstItem)
protected double	snappedBottomInset() Overrides javafx.scene.control.SkinBase.snappedBottomInset. Utility method to get the bottom inset which includes padding and border inset.
protected double	snappedLeftInset() Overrides javafx.scene.control.SkinBase.snappedLeftInset. Utility method to get the left inset which includes padding and border inset.
protected double	snappedRightInset() Overrides javafx.scene.control.SkinBase.snappedRightInset. Utility method to get the right inset which includes padding and border inset.
protected double	snappedTopInset() Overrides javafx.scene.control.SkinBase.snappedTopInset. Utility method to get the top inset which includes padding and border inset.
public final DoubleProperty	spacingProperty()
private void	unSelectMenus()
private void	updateActionListeners(MenuItem item, boolean add)
private void	updateFocusedIndex()

ALIGNMENT	back to summary
private static final CssMetaData<MenuBar, Pos> ALIGNMENT

altKeyPressed	back to summary
private boolean altKeyPressed

container	back to summary
private final HBox container contains MenuBarButton's children only

containerAlignment	back to summary
private ObjectProperty<Pos> containerAlignment Specifies the alignment of the menu buttons inside the MenuBar (by default it is Pos.TOP_LEFT).

currentMenuBarStage	back to summary
private static Stage currentMenuBarStage

firstMenuRunnable	back to summary
pack-priv Runnable firstMenuRunnable

focusedMenuIndex	back to summary
private int focusedMenuIndex index of focused MenuBarButton

menuActionEventHandler	back to summary
private EventHandler<ActionEvent> menuActionEventHandler

menuBarFocusedPropertyListener	back to summary
private ChangeListener<Boolean> menuBarFocusedPropertyListener

menuItemListener	back to summary
private ListChangeListener<MenuItem> menuItemListener

menuVisibilityChangeListener	back to summary
private ChangeListener<Boolean> menuVisibilityChangeListener

openMenu	back to summary
private Menu openMenu

openMenuButton	back to summary
private MenuBarButton openMenuButton

pendingDismiss	back to summary
private boolean pendingDismiss

sceneChangeListener	back to summary
private ChangeListener<Scene> sceneChangeListener

sceneListenerHelper	back to summary
private ListenerHelper sceneListenerHelper

spacing	back to summary
private DoubleProperty spacing Specifies the spacing between menu buttons on the MenuBar.

SPACING	back to summary
private static final CssMetaData<MenuBar, Number> SPACING

stages	back to summary
private static final ObservableList<Window> stages

STYLEABLES	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

systemMenuMap	back to summary
private static WeakHashMap<Stage, Reference<MenuBarSkin>> systemMenuMap

weakMenuBarFocusedPropertyListener	back to summary
private WeakChangeListener<Boolean> weakMenuBarFocusedPropertyListener

weakMenuVisibilityChangeListener	back to summary
private WeakChangeListener<Boolean> weakMenuVisibilityChangeListener

windowFocusHelper	back to summary
private IDisconnectable windowFocusHelper

wrappedDefaultMenus	back to summary
private static List<MenuBase> wrappedDefaultMenus

wrappedMenus	back to summary
private List<MenuBase> wrappedMenus

MenuBarSkin	back to summary
public MenuBarSkin(final 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:MenuBar The control that this skin should be installed onto.

Method Detail

cleanUpListeners	back to summary
private void cleanUpListeners()

cleanUpSystemMenu	back to summary
private void cleanUpSystemMenu()

clearMenuButtonHover	back to summary
private void clearMenuButtonHover()

computeMaxHeight	back to summary
protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Overrides javafx.scene.control.SkinBase.computeMaxHeight. Doc from javafx.scene.control.SkinBase.computeMaxHeight. Computes the maximum allowable height of the Skin, based on the provided width. Parameters width:double The width of the Skin, in case this value might dictate the maximum height. topInset:double the pixel snapped top inset rightInset:double the pixel snapped right inset bottomInset:double the pixel snapped bottom inset leftInset:double the pixel snapped left inset Returns:double A double representing the maximum height of this Skin. Annotations @Override

computeMaxHeight

back to summary

protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMaxHeight.

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

Computes the maximum allowable height of the Skin, based on the provided width.

Parameters

width:double: The width of the Skin, in case this value might dictate the maximum height.
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

A double representing the maximum height of this Skin.

Annotations

@Override

computeMinHeight	back to summary
protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Overrides javafx.scene.control.SkinBase.computeMinHeight. Doc from javafx.scene.control.SkinBase.computeMinHeight. Computes the minimum allowable height of the Skin, based on the provided width. Parameters width:double The width of the Skin, in case this value might dictate the minimum height. topInset:double the pixel snapped top inset rightInset:double the pixel snapped right inset bottomInset:double the pixel snapped bottom inset leftInset:double the pixel snapped left inset Returns:double A double representing the minimum height of this Skin. Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMinHeight.

Doc from javafx.scene.control.SkinBase.computeMinHeight.

Computes the minimum allowable height of the Skin, based on the provided width.

Parameters

width:double: The width of the Skin, in case this value might dictate the minimum height.
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

A double representing the minimum height of this Skin.

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) Overrides javafx.scene.control.SkinBase.computeMinWidth. Doc from javafx.scene.control.SkinBase.computeMinWidth. Computes the minimum allowable width of the Skin, based on the provided height. Parameters height:double The height of the Skin, in case this value might dictate the minimum width. topInset:double the pixel snapped top inset rightInset:double the pixel snapped right inset bottomInset:double the pixel snapped bottom inset leftInset:double the pixel snapped left inset Returns:double A double representing the minimum width of this Skin. Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMinWidth.

Doc from javafx.scene.control.SkinBase.computeMinWidth.

Computes the minimum allowable width of the Skin, based on the provided height.

Parameters

height:double: The height of the Skin, in case this value might dictate the minimum width.
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

A double representing the minimum width of this Skin.

Annotations

@Override

computePrefHeight back to summary

computePrefHeight	back to summary
protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Overrides javafx.scene.control.SkinBase.computePrefHeight. Doc from javafx.scene.control.SkinBase.computePrefHeight. Calculates the preferred height of this `SkinBase`. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights. Parameters width:double the width that should be used if preferred height depends on it topInset:double the pixel snapped top inset rightInset:double the pixel snapped right inset bottomInset:double the pixel snapped bottom inset leftInset:double the pixel snapped left inset Returns:double the calculated preferred height Annotations @Override

protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computePrefHeight.

Doc from javafx.scene.control.SkinBase.computePrefHeight.

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

Parameters

width:double: the width that should be used if preferred height depends on it
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

the calculated preferred height

Annotations

@Override

computePrefWidth back to summary

computePrefWidth	back to summary
protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) Overrides javafx.scene.control.SkinBase.computePrefWidth. Doc from javafx.scene.control.SkinBase.computePrefWidth. Calculates the preferred width of this `SkinBase`. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths. Parameters height:double the height that should be used if preferred width depends on it topInset:double the pixel snapped top inset rightInset:double the pixel snapped right inset bottomInset:double the pixel snapped bottom inset leftInset:double the pixel snapped left inset Returns:double the calculated preferred width Annotations @Override

protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computePrefWidth.

Doc from javafx.scene.control.SkinBase.computePrefWidth.

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

Parameters

height:double: the height that should be used if preferred width depends on it
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

the calculated preferred width

Annotations

@Override

containerAlignmentProperty	back to summary
public final ObjectProperty<Pos> containerAlignmentProperty()

dispose back to summary

dispose	back to summary
public void dispose() Overrides javafx.scene.control.SkinBase.dispose. Implements javafx.scene.control.Skin.dispose. Doc from javafx.scene.control.SkinBase.dispose. Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, `getSkinnable()` and `getNode()` should return `null`. Calling `dispose()` more than once has no effect. Annotations @Override

public void dispose()

Overrides javafx.scene.control.SkinBase.dispose.

Implements javafx.scene.control.Skin.dispose.

Doc from javafx.scene.control.SkinBase.dispose.

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, getSkinnable() and getNode() should return null.

Calling dispose() more than once has no effect.

Annotations

@Override

findSibling	back to summary
private Optional<Pair<Menu, Integer>> findSibling(Direction dir, int startIndex)

getClassCssMetaData

back to summary

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

Hides javafx.scene.control.SkinBase.getClassCssMetaData.

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

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses

getContainerAlignment	back to summary
public final Pos getContainerAlignment()

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.control.SkinBase.getCssMetaData.

Doc from javafx.scene.control.SkinBase.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Annotations

@Override

getFocusedMenuIndex	back to summary
pack-priv int getFocusedMenuIndex()

getMenuBarButtonIndex	back to summary
private int getMenuBarButtonIndex(MenuBarButton m)

getMenuBarSkin	back to summary
private static MenuBarSkin getMenuBarSkin(Stage stage)

getSpacing	back to summary
public final double getSpacing()

initSystemMenuBar	back to summary
private static void initSystemMenuBar()

isMenuEmpty	back to summary
private boolean isMenuEmpty(Menu menu)

layoutChildren

back to summary

protected void layoutChildren(final double x, final double y, final double w, final double h)

Overrides javafx.scene.control.SkinBase.layoutChildren.

Doc from javafx.scene.control.SkinBase.layoutChildren.

Called during the layout pass of the scenegraph.

Parameters

x:double: the x position
y:double: the y position
w:double: the width
h:double: the height

Annotations

@Override

menuBarButtonAt	back to summary
pack-priv MenuBarButton menuBarButtonAt(int i)

menuModeEnd	back to summary
private void menuModeEnd()

menuModeStart	back to summary
private void menuModeStart(int newIndex)

menusContainCustomMenuItem	back to summary
private boolean menusContainCustomMenuItem()

moveToMenu	back to summary
private void moveToMenu(Direction dir, boolean doShow)

queryAccessibleAttribute

back to summary

protected Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.SkinBase.queryAccessibleAttribute.

Doc from javafx.scene.control.SkinBase.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Parameters

attribute:AccessibleAttribute: the requested attribute
parameters:Object[]: optional list of parameters

Returns:Object

the value for the requested attribute

Annotations

@Override

rebuildUI	back to summary
private void rebuildUI()

resetOpenMenu	back to summary
private void resetOpenMenu()

setContainerAlignment	back to summary
public final void setContainerAlignment(Pos value)

setDefaultSystemMenuBar

back to summary

public static void setDefaultSystemMenuBar(final 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:MenuBar: the menu bar

setFocusedMenuIndex	back to summary
pack-priv void setFocusedMenuIndex(int index) This method is package scoped as it is used in this class as well as for testing

setSpacing	back to summary
public final void setSpacing(double value)

setSystemMenu	back to summary
private static void setSystemMenu(Stage stage)

snappedBottomInset

back to summary

protected double snappedBottomInset()

Overrides javafx.scene.control.SkinBase.snappedBottomInset.

Doc from javafx.scene.control.SkinBase.snappedBottomInset.

Utility method to get the bottom inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

Returns:double

Rounded up insets bottom

Annotations

@Override

snappedLeftInset

back to summary

protected double snappedLeftInset()

Overrides javafx.scene.control.SkinBase.snappedLeftInset.

Doc from javafx.scene.control.SkinBase.snappedLeftInset.

Utility method to get the left inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

Returns:double

Rounded up insets left

Annotations

@Override

snappedRightInset

back to summary

protected double snappedRightInset()

Overrides javafx.scene.control.SkinBase.snappedRightInset.

Doc from javafx.scene.control.SkinBase.snappedRightInset.

Utility method to get the right inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

Returns:double

Rounded up insets right

Annotations

@Override

snappedTopInset

back to summary

protected double snappedTopInset()

Overrides javafx.scene.control.SkinBase.snappedTopInset.

Doc from javafx.scene.control.SkinBase.snappedTopInset.

Utility method to get the top inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

Returns:double

Rounded up insets top

Annotations

@Override

spacingProperty	back to summary
public final DoubleProperty spacingProperty()

unSelectMenus	back to summary
private void unSelectMenus()

updateActionListeners	back to summary
private void updateActionListeners(MenuItem item, boolean add)

updateFocusedIndex	back to summary
private void updateFocusedIndex()

public Class MenuBarSkin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail