com.nomagic.actions

Class ActionsMenuCreator

java.lang.Object

com.nomagic.actions.ActionsMenuCreator

All Implemented Interfaces:

ActionsVisitor

@OpenApiAll
public class ActionsMenuCreator
extends java.lang.Object
implements ActionsVisitor

Class for creating GUI menu items from actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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) 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	CATEGORY_HEADER
static java.lang.String	HIDDEN_ALWAYS
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	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, com.nomagic.actions.ActionsManager manager) Appends menu items to given container.
void	appendMenuItems(javax.swing.JPopupMenu popup, com.nomagic.actions.ActionsManager manager) Appends menu items to given pop up menu.
void	appendMenuItems(javax.swing.JPopupMenu popup, com.nomagic.actions.ActionsManager manager, boolean addSeparator) Appends menu items to given popup.
javax.swing.JPopupMenu	createPopupMenu(com.nomagic.actions.ActionsManager manager) Creates popup menu for given actions manager
com.nomagic.actions.MenuComponentFactory	getFactory() Return menu component factory
static boolean	isSeparatorComponent(java.awt.Component component)
void	setFactory(com.nomagic.actions.MenuComponentFactory factory) Set menu component factory
void	setIndex(int index) Sets index attribute with the given index.
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.
void	visit(ActionsCategory category) Creates menu of nested category or appends separator for not nested.
void	visit(NMAction action) Constructs the JMenuItem from this action.
void	visit(NMStateAction action) Visits state action and creates JCheckBoxMenuItem.

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

CATEGORY_HEADER

public static final java.lang.String CATEGORY_HEADER

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

appendMenuItems

public void appendMenuItems(javax.swing.JPopupMenu popup,
                            com.nomagic.actions.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.

appendMenuItems

public void appendMenuItems(javax.swing.JPopupMenu popup,
                            com.nomagic.actions.ActionsManager manager)

Appends menu items to 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.

createPopupMenu

public javax.swing.JPopupMenu createPopupMenu(com.nomagic.actions.ActionsManager manager)

Creates popup menu for given actions manager

Parameters:

manager - manager

Returns:

popup menu

appendMenuItems

public void appendMenuItems(java.awt.Container container,
                            com.nomagic.actions.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.

visit

public void visit(NMStateAction action)

Visits state action and creates JCheckBoxMenuItem.

Specified by:

visit in interface ActionsVisitor

Parameters:

action - action to visit.

setIndex

public void setIndex(int index)

Sets index attribute with the given index.

Parameters:

index - The given index.

visit

public void visit(NMAction action)

Constructs the JMenuItem from this action. Sets the action name as menu item name. Sets the command key as menu item accelerator. Sets the action as menu item action listener.

Specified by:

visit in interface ActionsVisitor

Parameters:

action - action to visit.

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.

visit

public void visit(ActionsCategory category)

Creates menu of nested category or appends separator for not nested.

Specified by:

visit in interface ActionsVisitor

Parameters:

category - category to visit.

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)