com.haulmont.cuba.gui.components

Interface Action

All Known Subinterfaces:

Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasTarget, Action.UiPermissionAware

All Known Implementing Classes:

AbstractAction, AddAction, BaseAction, BulkEditAction, ChangeSubstUserAction, CreateAction, DeclarativeAction, DeclarativeTrackingAction, DialogAction, DoNotChangeSubstUserAction, EditAction, ExcelAction, ExcludeAction, FilterApplyAction, FilteringLookupAction, ItemTrackingAction, PickerField.ClearAction, PickerField.LookupAction, PickerField.OpenAction, PickerField.StandardAction, RefreshAction, RelatedAction, RemoveAction, SelectAction, ShowInfoAction, UserRemoveAction

public interface Action

The Action interface abstracts away a function from a visual component. When an action occurs, actionPerform(Component) method is invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Action.ActionPerformedEvent
static interface	Action.BeforeActionPerformedHandler Callback interface which is invoked by the action before execution.
static interface	Action.HasBeforeActionPerformedHandler Interface defining methods for adding and removing Action.BeforeActionPerformedHandlers
static interface	Action.HasOpenType Indicates that the action can be assigned a WindowManager.OpenType to open a related screen.
static interface	Action.HasSecurityConstraint Interface defining constraintOperationType and constraintCode options.
static interface	Action.HasTarget
static class	Action.Status Used in dialogs to assign a special visual style for a button representing the action.
static interface	Action.UiPermissionAware Indicates that the action can be affected by UI permissions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_CAPTION
static java.lang.String	PROP_DESCRIPTION
static java.lang.String	PROP_ENABLED
static java.lang.String	PROP_ICON
static java.lang.String	PROP_SHORTCUT
static java.lang.String	PROP_VISIBLE

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
void	addOwner(Component.ActionOwner actionOwner) Add an owner component.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a listener to be notified about Enabled, Caption or Icon property changes.
java.lang.String	getCaption()
java.lang.String	getDescription()
java.lang.String	getIcon()
java.lang.String	getId()
Component.ActionOwner	getOwner()
java.util.Collection<Component.ActionOwner>	getOwners()
KeyCombination	getShortcutCombination()
boolean	isEnabled()
boolean	isVisible()
void	refreshState() Refresh internal state of the action to initialize enabled, visible, caption, icon, etc.
void	removeOwner(Component.ActionOwner actionOwner) Remove an owner component.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a listener.
void	setCaption(java.lang.String caption)
void	setDescription(java.lang.String description)
void	setEnabled(boolean enabled)
void	setIcon(java.lang.String icon)
void	setIconFromSet(Icons.Icon icon) Set an icon from an icon set.
void	setShortcut(java.lang.String shortcut) Set shortcut from string representation.
void	setShortcutCombination(KeyCombination shortcut)
void	setVisible(boolean visible)

Field Detail

PROP_CAPTION

static final java.lang.String PROP_CAPTION

See Also:

Constant Field Values

PROP_DESCRIPTION

static final java.lang.String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_SHORTCUT

static final java.lang.String PROP_SHORTCUT

See Also:

Constant Field Values

PROP_ICON

static final java.lang.String PROP_ICON

See Also:

Constant Field Values

PROP_ENABLED

static final java.lang.String PROP_ENABLED

See Also:

Constant Field Values

PROP_VISIBLE

static final java.lang.String PROP_VISIBLE

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns:

action's identifier

getCaption

java.lang.String getCaption()

Returns:

action's localized caption

setCaption

void setCaption(java.lang.String caption)

getDescription

java.lang.String getDescription()

Returns:

action's description

setDescription

void setDescription(java.lang.String description)

getShortcutCombination

KeyCombination getShortcutCombination()

Returns:

action's shortcut

setShortcutCombination

void setShortcutCombination(KeyCombination shortcut)

setShortcut

void setShortcut(java.lang.String shortcut)

Set shortcut from string representation.

Parameters:

shortcut - string of type "Modifiers-Key", e.g. "Alt-N". Case-insensitive.

getIcon

java.lang.String getIcon()

Returns:

action's icon

setIcon

void setIcon(java.lang.String icon)

setIconFromSet

void setIconFromSet(Icons.Icon icon)

Set an icon from an icon set.

isEnabled

boolean isEnabled()

Returns:

whether the action is currently enabled

setEnabled

void setEnabled(boolean enabled)

isVisible

boolean isVisible()

Returns:

whether the action is currently visible

setVisible

void setVisible(boolean visible)

refreshState

void refreshState()

Refresh internal state of the action to initialize enabled, visible, caption, icon, etc. properties depending on programmatically set values and user permissions set at runtime.
For example, this method is called by visual components holding actions when they are connected to datasources. At this moment the action can find out what entity it is connected to and change its state according to the user permissions.

getOwner

Component.ActionOwner getOwner()

Returns:

a single component owning the action. If there are several owners, first will be returned.

getOwners

java.util.Collection<Component.ActionOwner> getOwners()

Returns:

the collection of owners

addOwner

void addOwner(Component.ActionOwner actionOwner)

Add an owner component.

Parameters:

actionOwner - owner component

removeOwner

void removeOwner(Component.ActionOwner actionOwner)

Remove an owner component.

Parameters:

actionOwner - owner component

actionPerform

void actionPerform(Component component)

Invoked by owning component when an action occurs.

Parameters:

component - invoking component

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a listener to be notified about Enabled, Caption or Icon property changes.

Parameters:

listener - a PropertyChangeListener object

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a listener.

Parameters:

listener - a PropertyChangeListener object

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)