com.haulmont.cuba.gui.xml

Class DeclarativeAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

com.haulmont.cuba.gui.xml.DeclarativeAction

All Implemented Interfaces:

Action, Action.HasTarget, Action.UiPermissionAware

Direct Known Subclasses:

DeclarativeTrackingAction

public class DeclarativeAction
extends BaseAction

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Action

Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.Status, Action.UiPermissionAware

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
DeclarativeAction(java.lang.String id, java.lang.String caption, java.lang.String description, java.lang.String icon, boolean enabled, boolean visible, java.lang.String methodName, Component.ActionsHolder holder)
DeclarativeAction(java.lang.String id, java.lang.String caption, java.lang.String description, java.lang.String icon, java.lang.String enable, java.lang.String visible, java.lang.String methodName, java.lang.String shortcut, Component.ActionsHolder holder)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
java.lang.String	getCaption()

Methods inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setTarget, setVisible, setVisibleByUiPermissions, withCaption, withDescription, withHandler, withIcon, withShortcut

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

addOwner, addPropertyChangeListener, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, setPrimary, setShortcut, setShortcutCombination

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Action

addOwner, addPropertyChangeListener, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, setShortcut, setShortcutCombination

Constructor Detail

DeclarativeAction

public DeclarativeAction(java.lang.String id,
                         java.lang.String caption,
                         java.lang.String description,
                         java.lang.String icon,
                         java.lang.String enable,
                         java.lang.String visible,
                         java.lang.String methodName,
                         @Nullable
                         java.lang.String shortcut,
                         Component.ActionsHolder holder)

DeclarativeAction

public DeclarativeAction(java.lang.String id,
                         java.lang.String caption,
                         java.lang.String description,
                         java.lang.String icon,
                         boolean enabled,
                         boolean visible,
                         java.lang.String methodName,
                         Component.ActionsHolder holder)

Method Detail

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component when an action occurs.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Action

Overrides:

getCaption in class AbstractAction

Returns:

action's localized caption