com.nomagic.actions

Class ActionsMenuCreator

java.lang.Object

com.nomagic.actions.ActionsMenuCreator

@OpenApiAll
public class ActionsMenuCreator
extends java.lang.Object

Class for creating GUI menu items from actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ActionsMenuCreator.AMC_ActionsVisitor
static class	ActionsMenuCreator.CustomJMenuItem
(package private) static class	ActionsMenuCreator.MenuItemActionListener Class which listens for actions changes and updates menu item.
class	ActionsMenuCreator.MutableActionListener Class for handling ActionsCategory changes.
(package private) static class	ActionsMenuCreator.StateActionListener Class which listens state action state changes and updates CheckBox component according changes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION
static java.lang.String	CATEGORY_HEADER
static java.lang.String	HIDDEN_ALWAYS
(package private) static java.lang.String	MUTABLE_ACTION_LISTENERS_LIST
static java.lang.String	POPUP_HEADER_ITEM_NAME

Constructor Summary

Constructors

Constructor and Description
ActionsMenuCreator()

Method Summary

Modifier and Type	Method and Description
protected void	addCleanupParticipant(java.lang.Runnable participant)
protected void	addJMenuItem(java.awt.Component item, NMAction action) Adds menu item, according to index item will be added to end when index less than 0, or to specified by index position.
void	appendMenuItems(java.awt.Container container, ActionsManager manager) Appends menu items to given container.
void	appendMenuItems(javax.swing.JPopupMenu popup, ActionsManager manager) Appends menu items to the given pop up menu.
void	appendMenuItems(javax.swing.JPopupMenu popup, ActionsManager manager, boolean addSeparator) Appends menu items to given popup.
protected ActionsVisitor	createActionsVisitor()
javax.swing.JPopupMenu	createPopupMenu(ActionsManager manager) Creates popup menu for given actions manager
javax.swing.JPopupMenu	createPopupMenu(ActionsManager manager, java.util.function.Supplier<javax.swing.JPopupMenu> factory) Creates popup menu for given actions manager
com.nomagic.actions.MenuComponentFactory	getFactory() Return menu component factory
protected void	internalAppendMenuItems(java.awt.Container container, ActionsManager manager)
protected void	internalAppendMenuItems(javax.swing.JPopupMenu popup, ActionsManager manager, boolean addSeparator)
static boolean	isSeparatorComponent(java.awt.Component component)
void	setFactory(com.nomagic.actions.MenuComponentFactory factory) Set menu component factory
static void	setPropertiesToMenuItem(javax.swing.JMenuItem item, NMAction action) Sets properties to given JMenuItem from given action.
void	setUseMenuListener(boolean useMenuListener) Do we need to use MenuListener on category? This flag should be set to true only if software is running on mac and using -Dapple.laf.useScreenMenuBar=true system property.

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN_ALWAYS

public static final java.lang.String HIDDEN_ALWAYS

See Also:

Constant Field Values

ACTION

public static final java.lang.String ACTION

See Also:

Constant Field Values

CATEGORY_HEADER

public static final java.lang.String CATEGORY_HEADER

See Also:

Constant Field Values

MUTABLE_ACTION_LISTENERS_LIST

static final java.lang.String MUTABLE_ACTION_LISTENERS_LIST

See Also:

Constant Field Values

POPUP_HEADER_ITEM_NAME

public static final java.lang.String POPUP_HEADER_ITEM_NAME

See Also:

Constant Field Values

Constructor Detail

ActionsMenuCreator

public ActionsMenuCreator()

Method Detail

createPopupMenu

public final javax.swing.JPopupMenu createPopupMenu(ActionsManager manager)

Creates popup menu for given actions manager

Parameters:

manager - manager

Returns:

popup menu

createPopupMenu

public final javax.swing.JPopupMenu createPopupMenu(ActionsManager manager,
                                                    java.util.function.Supplier<javax.swing.JPopupMenu> factory)

Creates popup menu for given actions manager

Parameters:

manager - manager

factory - new popup menu factory

Returns:

popup menu

appendMenuItems

public final void appendMenuItems(javax.swing.JPopupMenu popup,
                                  ActionsManager manager)

Appends menu items to the given pop up menu. Adds separator before new items if given pop up is not empty.

Parameters:

popup - where items will be appended

manager - manager from which actions menu items will be created

appendMenuItems

public final void appendMenuItems(javax.swing.JPopupMenu popup,
                                  ActionsManager manager,
                                  boolean addSeparator)

Appends menu items to given popup.

Parameters:

popup - where items will be appended

manager - manager from which actions menu items will be created

addSeparator - add separator after last item in the given popup or not

internalAppendMenuItems

protected void internalAppendMenuItems(javax.swing.JPopupMenu popup,
                                       ActionsManager manager,
                                       boolean addSeparator)

appendMenuItems

public final void appendMenuItems(java.awt.Container container,
                                  ActionsManager manager)

Appends menu items to given container.

Parameters:

container - container where items will be appended

manager - manager from which actions items will be created

createActionsVisitor

protected ActionsVisitor createActionsVisitor()

internalAppendMenuItems

protected void internalAppendMenuItems(java.awt.Container container,
                                       ActionsManager manager)

addJMenuItem

protected void addJMenuItem(java.awt.Component item,
                            NMAction action)

Adds menu item, according to index item will be added to end when index less than 0, or to specified by index position.

Parameters:

item - item to add.

action - action

setPropertiesToMenuItem

public static void setPropertiesToMenuItem(javax.swing.JMenuItem item,
                                           NMAction action)

Sets properties to given JMenuItem from given action.

Parameters:

item - item to set properties.

action - for getting properties.

setUseMenuListener

public void setUseMenuListener(boolean useMenuListener)

Do we need to use MenuListener on category? This flag should be set to true only if software is running on mac and using -Dapple.laf.useScreenMenuBar=true system property.

Parameters:

useMenuListener - true if need to use.

getFactory

public com.nomagic.actions.MenuComponentFactory getFactory()

Return menu component factory

Returns:

factory

setFactory

public void setFactory(com.nomagic.actions.MenuComponentFactory factory)

Set menu component factory

Parameters:

factory - factory

isSeparatorComponent

public static boolean isSeparatorComponent(@CheckForNull
                                           java.awt.Component component)

addCleanupParticipant

protected void addCleanupParticipant(java.lang.Runnable participant)