griffon.core.controller

Interface ActionManager

All Known Implementing Classes:

AbstractActionManager, DefaultActionManager, JavaFXActionManager, LanternaActionManager, NoopActionManager, PivotActionManager, SwingActionManager

public interface ActionManager

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION

Method Summary

Modifier and Type	Method and Description
Action	actionFor(GriffonController controller, java.lang.String actionName)
java.util.Map<java.lang.String,Action>	actionsFor(GriffonController controller)
void	addActionHandler(ActionHandler actionHandler) Register an ActionHandler with this instance.
void	addActionInterceptor(ActionInterceptor actionInterceptor) Deprecated. use addActionHandler instead.
void	createActions(GriffonController controller)
void	invokeAction(Action action, java.lang.Object... args) Execute the action using registered ActionHandlers.
void	invokeAction(GriffonController controller, java.lang.String actionName, java.lang.Object... args) Execute the action using registered ActionHandlers.
java.lang.String	normalizeName(java.lang.String actionName)
void	updateAction(Action action) Update the action's properties using registered ActionHandlers.
void	updateAction(GriffonController controller, java.lang.String actionName) Update the action's properties using registered ActionHandlers.
void	updateActions() Updates all actions currently configured.
void	updateActions(GriffonController controller) Updates all actions belonging to the supplied controller.

Field Detail

ACTION

static final java.lang.String ACTION

See Also:

Constant Field Values

Method Detail

actionsFor

@Nonnull
java.util.Map<java.lang.String,Action> actionsFor(@Nonnull
                                                           GriffonController controller)

actionFor

@Nullable
Action actionFor(@Nonnull
                           GriffonController controller,
                           @Nonnull
                           java.lang.String actionName)

createActions

void createActions(@Nonnull
                   GriffonController controller)

normalizeName

@Nonnull
java.lang.String normalizeName(@Nonnull
                                        java.lang.String actionName)

updateActions

void updateActions()

Updates all actions currently configured.

Since:

2.1.0

updateActions

void updateActions(@Nonnull
                   GriffonController controller)

Updates all actions belonging to the supplied controller.

Parameters:

controller - the controller that owns the actions to be updated.

Since:

2.1.0

updateAction

void updateAction(@Nonnull
                  Action action)

Update the action's properties using registered ActionHandlers.

Parameters:

action - the action to be updated

Since:

2.1.0

updateAction

void updateAction(@Nonnull
                  GriffonController controller,
                  @Nonnull
                  java.lang.String actionName)

Update the action's properties using registered ActionHandlers.

Parameters:

controller - the controller that owns the action

actionName - the action's name

Since:

2.1.0

invokeAction

void invokeAction(@Nonnull
                  GriffonController controller,
                  @Nonnull
                  java.lang.String actionName,
                  java.lang.Object... args)

Execute the action using registered ActionHandlers.

Parameters:

controller - the controller that owns the action

actionName - the action's name

args - additional arguments to be sent to the action

invokeAction

void invokeAction(@Nonnull
                  Action action,
                  @Nonnull
                  java.lang.Object... args)

Execute the action using registered ActionHandlers.

Parameters:

action - the action to be invoked

args - additional arguments to be sent to the action

Since:

2.1.0

addActionHandler

void addActionHandler(@Nonnull
                      ActionHandler actionHandler)

Register an ActionHandler with this instance.

Parameters:

actionHandler - the handler to be added to this ActionManager

Since:

2.1.0

addActionInterceptor

@Deprecated
void addActionInterceptor(@Nonnull
                                      ActionInterceptor actionInterceptor)

Deprecated. use addActionHandler instead.

Register an ActionInterceptor with this instance.

Parameters:

actionInterceptor - the interceptor to be added to this ActionManager