com.haulmont.cuba.gui.xml

Class DeclarativeTrackingAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.actions.ListAction

com.haulmont.cuba.gui.xml.DeclarativeTrackingAction

All Implemented Interfaces:

Action, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction

public class DeclarativeTrackingAction
extends ListAction
implements Action.HasTarget, Action.SecuredAction, Action.HasSecurityConstraint

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.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	constraintCode
protected ConstraintOperationType	constraintOperationType
protected Frame	frame
protected java.lang.String	methodName
protected Security	security

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

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

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

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
DeclarativeTrackingAction(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, ActionsHolder holder)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
protected void	checkActionsHolder(ActionsHolder holder)
java.lang.String	getCaption()
java.lang.String	getConstraintCode()
ConstraintOperationType	getConstraintOperationType()
protected boolean	isApplicable() Callback method which is invoked by the action to determine its enabled state.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
void	setConstraintCode(java.lang.String constraintCode)
void	setConstraintOperationType(ConstraintOperationType constraintOperationType)

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

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

addActionPerformedListener, addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

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

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

Methods inherited from class java.lang.Object

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

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

getTarget, setTarget

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

isEnabledByUiPermissions, isVisibleByUiPermissions, setEnabledByUiPermissions, setVisibleByUiPermissions

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

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

Field Detail

frame

protected Frame frame

methodName

protected java.lang.String methodName

security

protected Security security

constraintOperationType

protected ConstraintOperationType constraintOperationType

constraintCode

protected java.lang.String constraintCode

Constructor Detail

DeclarativeTrackingAction

public DeclarativeTrackingAction(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,
                                 ActionsHolder holder)

Method Detail

checkActionsHolder

protected void checkActionsHolder(ActionsHolder holder)

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

isApplicable

protected boolean isApplicable()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isApplicable in class BaseAction

Returns:

true if the action is enabled for the current context, e.g. there is a selected row in a table

isPermitted

protected boolean isPermitted()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isPermitted in class BaseAction

Returns:

true if the action is enabled for the current user

getConstraintOperationType

public ConstraintOperationType getConstraintOperationType()

Specified by:

getConstraintOperationType in interface Action.HasSecurityConstraint

setConstraintOperationType

public void setConstraintOperationType(ConstraintOperationType constraintOperationType)

Specified by:

setConstraintOperationType in interface Action.HasSecurityConstraint

getConstraintCode

public java.lang.String getConstraintCode()

Specified by:

getConstraintCode in interface Action.HasSecurityConstraint

setConstraintCode

public void setConstraintCode(java.lang.String constraintCode)

Specified by:

setConstraintCode in interface Action.HasSecurityConstraint