Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXContextMenu.Builder

java.lang.Object

io.github.palexdev.materialfx.controls.MFXContextMenu.Builder

Enclosing class:

MFXContextMenu

public static class MFXContextMenu.Builder
extends Object

Builder class that facilitates the creation of context menus with fluent api.

An example:

 

 MFXContextMenuItem item1 = ...;
 MFXContextMenuItem item2 = ...;
 MFXContextMenuItem item3 = ...;
 MFXContextMenuItem item4 = ...;
 MFXContextMenuItem item5 = ...;
 MFXContextMenuItem item6 = ...;

 MFXContextMenu.Builder.build(owner)
         .addItems(item1, item2)
         .addLineSeparator()
         .addItems(item3, item4)
         .addLineSeparator()
         .addItems(item5, item6)
         .installAndGet();
 
 

See Also:

• MFXContextMenuItem

Method Summary

Modifier and Type	Method	Description
MFXContextMenu.Builder	addItem(MFXContextMenuItem item)	Adds the giver menu item to the items list.
MFXContextMenu.Builder	addItem(MFXContextMenuItem item, EventHandler<ActionEvent> action)	Sets the given action on the given item, then adds it to the items list.
MFXContextMenu.Builder	addItems(MFXContextMenuItem... items)	Adds the given menu items to the items list.
MFXContextMenu.Builder	addLineSeparator()	Adds the given line which acts as a separator to the items list.
MFXContextMenu.Builder	addLineSeparator(Insets insets)	Adds the given line which acts as a separator to the items list.
MFXContextMenu.Builder	addSeparator(Node node)	Adds the given node which acts as a separator to the items list.
static MFXContextMenu.Builder	build(Node owner)
MFXContextMenu	get()
static Line	getLineSeparator()	Calls getLineSeparator(Insets) with top-bottom insets of 4.
static Line	getLineSeparator(Insets insets)	Builds a Line separator with startX of 0 and the given Insets, which are used as VBox margins, VBox.setMargin(Node, Insets).
MFXContextMenu	installAndGet()	Installs the built context menu then returns it.
MFXContextMenu.Builder	setPopupStyleableParent(Parent parent)	Sets the node that has the necessary stylesheets to customize the popup.
MFXContextMenu.Builder	setShowAction(Consumer<MouseEvent> showAction)	Sets the action to perform when a valid MouseEvent occurs.
MFXContextMenu.Builder	setShowCondition(Function<MouseEvent,Boolean> showCondition)	Sets the condition on which the given MouseEvent should trigger the MFXContextMenu.showActionProperty().

Methods inherited from class java.lang.Object

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

Method Details

build

public static MFXContextMenu.Builder build(Node owner)

Returns:

a new Builder instance with the given owner for the MFXContextMenu

addItem

public MFXContextMenu.Builder addItem(MFXContextMenuItem item)

Adds the giver menu item to the items list.

addItems

public MFXContextMenu.Builder addItems(MFXContextMenuItem... items)

Adds the given menu items to the items list.

addItem

public MFXContextMenu.Builder addItem(MFXContextMenuItem item,
 EventHandler<ActionEvent> action)

Sets the given action on the given item, then adds it to the items list.

addSeparator

public MFXContextMenu.Builder addSeparator(Node node)

Adds the given node which acts as a separator to the items list.

addLineSeparator

public MFXContextMenu.Builder addLineSeparator()

Adds the given line which acts as a separator to the items list.

The line is generated using getLineSeparator().

addLineSeparator

public MFXContextMenu.Builder addLineSeparator(Insets insets)

Adds the given line which acts as a separator to the items list.

The line is generated using getLineSeparator(Insets).

setShowCondition

public MFXContextMenu.Builder setShowCondition(Function<MouseEvent,Boolean> showCondition)

Sets the condition on which the given MouseEvent should trigger the MFXContextMenu.showActionProperty().

setShowAction

public MFXContextMenu.Builder setShowAction(Consumer<MouseEvent> showAction)

Sets the action to perform when a valid MouseEvent occurs.

See Also:

• MFXContextMenu.showActionProperty()

setPopupStyleableParent

public MFXContextMenu.Builder setPopupStyleableParent(Parent parent)

Sets the node that has the necessary stylesheets to customize the popup.

get

public MFXContextMenu get()

Returns:

the built context menu

installAndGet

public MFXContextMenu installAndGet()

Installs the built context menu then returns it.

getLineSeparator

public static Line getLineSeparator()

Calls getLineSeparator(Insets) with top-bottom insets of 4.

getLineSeparator

public static Line getLineSeparator(Insets insets)

Builds a Line separator with startX of 0 and the given Insets, which are used as VBox margins, VBox.setMargin(Node, Insets).