Package org.jdesktop.swingx.action
Class ActionContainerFactory
java.lang.Object
org.jdesktop.swingx.action.ActionContainerFactory
Creates user interface elements based on action ids and lists of action ids.
All action ids must represent actions managed by the ActionManager.
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 constructed 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Map
<Integer, ButtonGroup> private ActionMap
private static Insets
Standard margin for toolbar buttons to improve their look -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an container factory which uses the default ActionManager.ActionContainerFactory
(ActionMap manager) Constructs an container factory which uses managed actions. -
Method Summary
Modifier and TypeMethodDescriptionvoid
configureButton
(JToggleButton button, AbstractActionExt a, ButtonGroup group) protected void
configureButtonFromExtActionProperties
(AbstractButton button, Action action) This method will be called after buttons created from an action.protected void
configureMenuItemFromExtActionProperties
(JMenuItem menuItem, Action action) This method will be called after menu items are created.void
configureSelectableButton
(AbstractButton button, AbstractActionExt a, ButtonGroup group) method to configure a "selectable" button from the given AbstractActionExt.createButton
(Object id, JComponent container) Creates, configures and returns an AbstractButton.createButton
(Action action) Creates a button based on the attributes of the action.createButton
(Action action, JComponent container) Creates a button based on the attributes of the action.private JCheckBoxMenuItem
Helper method to add a checkbox menu item.createMenu
(Object[] actionIds) Creates and returns a menu from a List which represents actions, separators and sub-menus.createMenu
(List<?> list) Creates and returns a menu from a List which represents actions, separators and sub-menus.createMenuBar
(Object[] actionIds) Constructs a menu tree from a list of actions or lists of lists or actions.createMenuBar
(List<?> list) Constructs a menu tree from a list of actions or lists of lists or actions.private JMenuItem
createMenuItem
(Object id, JComponent container) Creates a menu item based on the attributes of the action element.createMenuItem
(Action action) Creates a menu item based on the attributes of the action.private JMenuItem
createMenuItem
(Action action, JComponent container) Creates a menu item based on the attributes of the action element.createPopup
(Object[] list) Constructs a popup menu from an array of action ids.createPopup
(List<?> list) Constructs a popup menu from a list of action ids.private JRadioButtonMenuItem
Helper method to add a radio button menu item.private JToggleButton
Adds and configures a toggle button.private JToggleButton
createToggleButton
(AbstractActionExt a, ButtonGroup group) Adds and configures a toggle button.createToolBar
(Object[] list) Constructs a toolbar from an action-list id.createToolBar
(List<?> list) Constructs a toolbar from an action-list id.private Action
Convenience method to get the action from an ActionManager.Gets the ActionManager instance.private ButtonGroup
getGroup
(String groupid, JComponent container) Returns the button group corresponding to the groupidvoid
setActionManager
(ActionMap manager) Sets the ActionManager instance that will be used by this ActionContainerFactory
-
Field Details
-
TOOLBAR_BUTTON_MARGIN
Standard margin for toolbar buttons to improve their look -
manager
-
groupMap
-
-
Constructor Details
-
ActionContainerFactory
public ActionContainerFactory()Constructs an container factory which uses the default ActionManager. -
ActionContainerFactory
Constructs an container factory which uses managed actions.- Parameters:
manager
- use the actions managed with this manager for constructing ui componenents.
-
-
Method Details
-
getActionManager
Gets the ActionManager instance. If the ActionManager has not been explicitly set then the default ActionManager instance will be used.- Returns:
- the ActionManager used by the ActionContainerFactory.
- See Also:
-
setActionManager
Sets the ActionManager instance that will be used by this ActionContainerFactory -
createToolBar
Constructs a toolbar from an action-list id. By convention, the identifier of the main toolbar should be "main-toolbar"- Parameters:
list
- a list of action ids used to construct the toolbar.- Returns:
- the toolbar or null
-
createToolBar
Constructs a toolbar from an action-list id. By convention, the identifier of the main toolbar should be "main-toolbar"- Parameters:
list
- a list of action ids used to construct the toolbar.- Returns:
- the toolbar or null
-
createPopup
Constructs a popup menu from an array of action ids.- Parameters:
list
- an array of action ids used to construct the popup.- Returns:
- the popup or null
-
createPopup
Constructs a popup menu from a list of action ids.- Parameters:
list
- a list of action ids used to construct the popup.- Returns:
- the popup or null
-
createMenuBar
Constructs a menu tree from a list of actions or lists of lists or actions.- Parameters:
actionIds
- an array which represents the root item.- Returns:
- a menu bar which represents the menu bar tree
-
createMenuBar
Constructs a menu tree from a list of actions or lists of lists or actions.- Parameters:
list
- a list which represents the root item.- Returns:
- a menu bar which represents the menu bar tree
-
createMenu
Creates and returns a menu from a List which represents actions, separators and sub-menus. The menu constructed will have the attributes from the first action in the List. Subsequent actions in the list represent menu items.- Parameters:
actionIds
- an array of action ids used to construct the menu and menu items. the first element represents the action used for the menu,- Returns:
- the constructed JMenu or null
-
createMenu
Creates and returns a menu from a List which represents actions, separators and sub-menus. The menu constructed will have the attributes from the first action in the List. Subsequent actions in the list represent menu items.- Parameters:
list
- a list of action ids used to construct the menu and menu items. the first element represents the action used for the menu,- Returns:
- the constructed JMenu or null
-
getAction
Convenience method to get the action from an ActionManager. -
getGroup
Returns the button group corresponding to the groupid- Parameters:
groupid
- the value of the groupid attribute for the action elementcontainer
- a container which will further identify the ButtonGroup
-
createMenuItem
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.- Returns:
- a JMenuItem or subclass depending on type.
-
createMenuItem
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.- Parameters:
action
- a managed Actioncontainer
- the parent container may be null for non-group actions.- Returns:
- a JMenuItem or subclass depending on type.
-
createMenuItem
Creates a menu item based on the attributes of the action. Will return a JMenuItem, JRadioButtonMenuItem or a JCheckBoxMenuItem depending on the context of the Action.- Parameters:
action
- an action used to create the menu item- Returns:
- a JMenuItem or subclass depending on type.
-
createButton
Creates, configures and returns an AbstractButton. The attributes of the action element registered with the ActionManger by the given id. Will return a JButton or a JToggleButton.- Parameters:
id
- the identifiercontainer
- the JComponent which parents the group, if any.- Returns:
- an AbstractButton based on the
-
createButton
Creates a button based on the attributes of the action. If the container parameter is non-null then it will be used to uniquely identify the returned component within a ButtonGroup. If the action doesn't represent a grouped component then this value can be null.- Parameters:
action
- an action used to create the buttoncontainer
- the parent container to uniquely identify grouped components or null- Returns:
- will return a JButton or a JToggleButton.
-
createButton
Creates a button based on the attributes of the action.- Parameters:
action
- an action used to create the button- Returns:
- will return a JButton or a JToggleButton.
-
createToggleButton
Adds and configures a toggle button.- Parameters:
a
- an abstraction of a toggle action.
-
createToggleButton
Adds and configures a toggle button.- Parameters:
a
- an abstraction of a toggle action.group
- the group to add the toggle button or null
-
configureButton
- Parameters:
button
-a
-group
-
-
configureSelectableButton
public void configureSelectableButton(AbstractButton button, AbstractActionExt a, ButtonGroup group) method to configure a "selectable" button from the given AbstractActionExt. As there is some un-/wiring involved to support synch of the selected property between the action and the button, all config and unconfig (== setting a null action!) should be passed through this method.It's up to the client to only pass in button's where selected and/or the group property makes sense. PENDING: the group properties are yet untested. PENDING: think about automated unconfig.
- Parameters:
button
- where selected makes sensea
-group
- the button should be added to.- Throws:
IllegalArgumentException
- if the given action doesn't have the state flag set.
-
configureButtonFromExtActionProperties
This method will be called after buttons created from an action. Override for custom configuration.- Parameters:
button
- the button to be configuredaction
- the action used to construct the menu item.
-
configureMenuItemFromExtActionProperties
This method will be called after menu items are created. Override for custom configuration.- Parameters:
menuItem
- the menu item to be configuredaction
- the action used to construct the menu item.
-
createCheckBoxMenuItem
Helper method to add a checkbox menu item. -
createRadioButtonMenuItem
Helper method to add a radio button menu item.
-