com.ehsbe.commons.action
Class ActionContainerFactory

java.lang.Object
  com.ehsbe.commons.action.ActionContainerFactory

public class ActionContainerFactory
extends Object

Creates user interface elements based on action and action IDs. All actions and action IDs must represent actions managed by the passed ActionManager. Otherwise no UI element is created.

Action Lists

Use the createXXX(List) methods to construct containers of actions like menu bars, menus, popups and toolbars from actions represented as action ids in a java.util.List. Each element in the action-list can be one of 3 types:

• action id: corresponds to an action managed by the ActionManager
• null: indicates a separator should be inserted.
• java.util.List: represents a submenu. See the note below which describes the configuration of menus.
The order of elements in an action-list determines the arrangement of the ui components which are contructed from the action-list.

For a menu or submenu, the first element in the action-list represents a menu and subsequent elements represent menu items or separators (if null).

This class can be used as a general component factory which will construct components from Actions if the create<comp>(Action,...) methods are used.

See Also:

ActionManager

Constructor Summary

ActionContainerFactory()


Method Summary

static void	configure(AbstractButton button, Action action, ActionManager manager) Configure the given button by the given action using the given action manager ;-) At the moment it configures just the extended properties provided by AbstractActionExt actions.
static AbstractButton	createButton(Action action, ActionManager manager) Creates a button based on the attributes of the given action.
static AbstractButton	createButton(Object id, ActionManager manager) Creates a button based on the action with the given ID.
static AbstractButton	createButton(Object id, ActionManager manager, boolean copy) Creates a button based on the action with the given ID.
static AbstractButton[]	createButtons(List<Action> list, ActionManager manager) Creates an array of buttons using the given list.
static AbstractButton[]	createButtons(String id, ActionManager manager) Creates an array of buttons using the possible nested list of action IDs with the given id.
static JComponent	createMenu(List<?> list, JComponent parent, ActionManager manager) Create a menu tree from the given list of action IDs and lists of action IDs.
static JMenu	createMenu(Object actionId, ActionManager manager) Create a single JMenu from the action with the given id.
static JMenuBar	createMenuBar(List<?> list, ActionManager manager) Populate a menubar from a action list.
static JMenuItem	createMenuItem(Action action, ActionManager manager) Creates a menu item based on the attributes of the given action.
static JMenuItem	createMenuItem(Object id, ActionManager manager) Creates a menu item based on the attributes of the action element.
static JPopupMenu	createPopup(List<?> list, ActionManager manager) Constructs a popup menu from a list of action ids.
static JToolBar	createToolBar(List<?> list, ActionManager manager) Constructs a toolbar from an action-list id.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionContainerFactory

public ActionContainerFactory()

Method Detail

createToolBar

public static JToolBar createToolBar(List<?> list,
                                     ActionManager manager)

Constructs a toolbar from an action-list id.

For each ID, which refers to an action managed by the submitted action manager, a button gets created and append to the toolbar. If a ID is null, a JSeparator will be added instead.

Parameters:

list - a list of action IDs

manager - the manager, which contains the actions referenced by the action IDs

Returns:

a toolbar, which might be empty

See Also:

createButton(Action, ActionManager)

createPopup

public static JPopupMenu createPopup(List<?> list,
                                     ActionManager manager)

Constructs a popup menu from a list of action ids.

Parameters:

list - a possibkly nested list of action IDs to be used to construct the popup.

manager - the manager, which contains the actions referenced by the action IDs and action IDS in the action lists

Returns:

the popup, which might be empty

See Also:

createMenu(List, JComponent, ActionManager)

createMenuBar

public static JMenuBar createMenuBar(List<?> list,
                                     ActionManager manager)

Populate a menubar from a action list.

Parameters:

list - a possibly nested list of action IDs to used to construct the popup.

manager - the manager, which contains the actions referenced by the action IDs and action IDs in the action lists

Returns:

a menu bar, which might be empty

See Also:

createMenu(List, JComponent, ActionManager)

createMenu

public static JMenu createMenu(Object actionId,
                               ActionManager manager)

Create a single JMenu from the action with the given id.

Parameters:

actionId - ID of the action to be used for JMenu configuration

manager - the manager, which contains the action with the given ID

Returns:

null if the action for the given ID has not been found, the new JMenu otherwise.

createMenu

public static JComponent createMenu(List<?> list,
                                    JComponent parent,
                                    ActionManager manager)

Create a menu tree from the given list of action IDs and lists of action IDs.

If parent is null, it is tried to to create a JMenu from the first entry in the given list (which should actually represent an ID of an action). If that fails, null is returned. Otherwise the created JMenu is used as parent and returned after the creation of the menu tree.

For each subsequent entry in the given list a JMenuItem (for action IDs) or JMenus (for action ID lists) or JSeparators (for null) will be created and append to the parent.

Parameters:

list - a possibly nested list of action IDs

parent - where to append created JMenus and JMenuItems

manager - the manager, which contains the actions referenced by the action IDs in the given list and its sublists.

Returns:

if parent is NOT null, the parent itself. Otherwise the newly created JMenu (which might be null, if the given list is empty or its first entry references an unknown action).

See Also:

createMenu(Object, ActionManager), createMenuItem(Object, ActionManager), ActionManager.getAction(Object)

createMenuItem

public static JMenuItem createMenuItem(Object id,
                                       ActionManager manager)

Creates a menu item based on the attributes of the action element. Will return a JMenuItem, JRadioButtonMenuItem or a JCheckBoxMenuItem depending on the context of the Action with the given id.

Parameters:

id - action ID

manager - the manager, which contains the actions referenced the given action ID

Returns:

null if the manager has no action with the given id or is null, a JMenuItem or subclass depending on type otherwise.

See Also:

createMenuItem(Action, ActionManager)

createMenuItem

public static JMenuItem createMenuItem(Action action,
                                       ActionManager manager)

Creates a menu item based on the attributes of the given action.

Parameters:

action - an action managed by the given action manager

manager - the manager, which contains the given action. If null, menu button groups are not initialized (see configure(AbstractButton, Action, ActionManager).

Returns:

a JMenuItem or a subclass of JMenuItem depending on the context of the action OR null if the given action is null.

See Also:

AbstractButton.setAction(Action)

createButton

public static AbstractButton createButton(Object id,
                                          ActionManager manager,
                                          boolean copy)

Creates a button based on the action with the given ID.

Parameters:

id - the id of the managed action to use

manager - the manager, which contains the actions with the given ID

copy - if true ask the action manager for an action copy and use the copy to create the button

Returns:

a JButton, JToggleButton or null.

See Also:

createButton(Action, ActionManager)

createButton

public static AbstractButton createButton(Object id,
                                          ActionManager manager)

Creates a button based on the action with the given ID. Convinience method for createButton(id, manager, false);

Parameters:

id - the id of the managed action to use

manager - the manager, which contains the actions with the given ID

Returns:

a JButton, JToggleButton or null.

See Also:

createButton(Action, ActionManager)

createButton

public static AbstractButton createButton(Action action,
                                          ActionManager manager)

Creates a button based on the attributes of the given action.

Parameters:

action - an action managed by the given action manager

manager - the manager, which contains the given action. If null, button groups are not initialized (see configure(AbstractButton, Action, ActionManager).

Returns:

a JButton, JToggleButton or subclass of JToggleButton depending on the context of the action OR null if the given action is null.

See Also:

AbstractButton.setAction(Action)

createButtons

public static AbstractButton[] createButtons(List<Action> list,
                                             ActionManager manager)

Creates an array of buttons using the given list.

Parameters:

list - list of actions or action IDs

manager - manager to use to retrieve related actions

Returns:

a possible empty array

createButtons

public static AbstractButton[] createButtons(String id,
                                             ActionManager manager)

Creates an array of buttons using the possible nested list of action IDs with the given id.

Parameters:

id - ID of the action ID list to use.

manager - manager to use to retrieve the related action list

Returns:

a possible empty array

configure

public static void configure(AbstractButton button,
                             Action action,
                             ActionManager manager)

Configure the given button by the given action using the given action manager ;-)

At the moment it configures just the extended properties provided by AbstractActionExt actions. I.e. will set selection state of the button, long description as tooltip, large icon as button icon (if available) and add the action as ItemListener, if it is a stateful action (see AbstractActionExt.isStateAction()).

It does not configure basic properties like name etc., since this is usually already done, when the button has been created. If you need to do a basic configuration, AbstractButton.setAction(Action) might be one easy variant to do that.

Parameters:

button - button to configure

action - action to use for configuration

manager - manager, which manages the given action. If null, group buttons are not bound to any button group.