org.controlsfx.control.action

Class ActionMap

java.lang.Object

org.controlsfx.control.action.ActionMap

public class ActionMap
extends Object

Action Map provides an ability to create an action map of any object. Attempts to convert methods annotated with ActionProxy to Action.

Code Example

Here's a very simple example of how to use ActionMap to register a class (in this class it is the application class itself), and to then retrieve actions out of the ActionMap (via the static action(String) method:

 public class ActionMapDemo extends Application {
     public ActionMapDemo() {
         ActionMap.register(this);
         Action action11 = ActionMap.action("action11");
         Button actionButton = ActionUtils.createButton(action11);
     }
  
     @ActionProxy(text="Action 1.1", graphic="start.png", accelerator="ctrl+shift+T")
     private void action11() {
         System.out.println( "Action 1.1 is executed");
     }
 }
 

See Also:

ActionProxy, Action

Method Summary

Modifier and Type	Method and Description
static Action	action(String id) Returns action by it's id
static Collection<Action>	actions(String... ids) Returns collection of actions by ids.
static void	register(Object target) Attempts to convert target's methods annotated with ActionProxy to Actions.
void	unregister(Object target) Removes all the actions associated with target object from the action amp

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register(Object target)

Attempts to convert target's methods annotated with ActionProxy to Actions. Only two types of methods are currently converted: parameter-less methods and methods with one parameter of type ActionEvent. Actions are registered with their id or method name if id is not defined.

Parameters:

target - object to work on

Throws:

IllegalArgumentException - on duplicate action id

unregister

public void unregister(Object target)

Removes all the actions associated with target object from the action amp

Parameters:

target - object to work on

action

public static Action action(String id)

Returns action by it's id

Parameters:

id - action id

Returns:

action or null if id was found

actions

public static Collection<Action> actions(String... ids)

Returns collection of actions by ids. Useful to create ActionGroups. Ids starting with "---" are converted to ActionUtils.ACTION_SEPARATOR Incorrect ids are ignored.

Parameters:

ids - action ids

Returns:

collection of actions