Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.button

Interface MenuBuilder

All Superinterfaces:

ComponentBuilder<Void,JMenu,MenuBuilder>

public interface MenuBuilder
extends ComponentBuilder<Void,JMenu,MenuBuilder>

A builder for menus.

Field Summary

Fields inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

COMPONENT_VALUE, TRANSFER_FOCUS_ON_ENTER

Method Summary

Modifier and Type	Method	Description
MenuBuilder	action(Action action)
static MenuBuilder	builder()
static MenuBuilder	builder(Controls controls)
static MenuBuilder	builder(Controls.ControlsBuilder controlsBuilder)
JMenuBar	buildMenuBar()
JPopupMenu	buildPopupMenu()
MenuBuilder	control(Control control)
MenuBuilder	controls(Controls controls)	Adds all actions from the given Controls instance
MenuBuilder	menuItemBuilder(MenuItemBuilder<?,?> menuItemBuilder)
MenuBuilder	menuListener(MenuListener menuListener)
MenuBuilder	popupMenuListener(PopupMenuListener popupMenuListener)	Has no effect if a popup menu is not created.
MenuBuilder	separator()	Adds a separator
MenuBuilder	toggleMenuItemBuilder(ToggleMenuItemBuilder<?,?> toggleMenuItemBuilder)

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

background, border, build, build, buildValue, buildValue, clientProperty, componentListener, componentOrientation, consumer, enabled, enabled, focusable, focusCycleRoot, focusListener, font, foreground, keyEvent, keyListener, label, link, link, listener, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onBuildValue, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, transferFocusOnEnter, transferHandler, validator, value, visible

Method Details

action

MenuBuilder action(Action action)

Parameters:

action - the action to add

Returns:

this builder instance

control

MenuBuilder control(Control control)

Parameters:

control - the control to add

Returns:

this builder instance

controls

MenuBuilder controls(Controls controls)

Adds all actions from the given Controls instance

Parameters:

controls - the Controls instance

Returns:

this builder instance

separator

MenuBuilder separator()

Adds a separator

Returns:

this builder instance

See Also:

• JMenu.addSeparator()

menuListener

MenuBuilder menuListener(MenuListener menuListener)

Parameters:

menuListener - the menu listener

Returns:

this builder instance

See Also:

• JMenu.addMenuListener(MenuListener)

popupMenuListener

MenuBuilder popupMenuListener(PopupMenuListener popupMenuListener)

Has no effect if a popup menu is not created.

Parameters:

popupMenuListener - the popup menu listener

Returns:

this builder instance

See Also:

• buildPopupMenu()
• JPopupMenu.addPopupMenuListener(PopupMenuListener)

menuItemBuilder

MenuBuilder menuItemBuilder(MenuItemBuilder<?,?> menuItemBuilder)

Parameters:

menuItemBuilder - the menu item builder to use when creating menu items

Returns:

this builder instance

toggleMenuItemBuilder

MenuBuilder toggleMenuItemBuilder(ToggleMenuItemBuilder<?,?> toggleMenuItemBuilder)

Parameters:

toggleMenuItemBuilder - the toggle menu item builder to use when creating toggle menu items

Returns:

this builder instance

buildPopupMenu

JPopupMenu buildPopupMenu()

Returns:

a new JPopupMenu based on this menu builder

buildMenuBar

JMenuBar buildMenuBar()

Returns:

a new JMenuBar based on this menu builder

builder

static MenuBuilder builder()

Returns:

a new MenuBuilder

builder

static MenuBuilder builder(Controls controls)

Parameters:

controls - the controls to base the menu on

Returns:

a new MenuBuilder based on the given controls

builder

static MenuBuilder builder(Controls.ControlsBuilder controlsBuilder)

Parameters:

controlsBuilder - the controls builder to base the menu on

Returns:

a new MenuBuilder based on the given controls