com.haulmont.cuba.gui.components

Class AbstractAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

All Implemented Interfaces:

Action

Direct Known Subclasses:

BaseAction, ChangeSubstUserAction, DoNotChangeSubstUserAction, FilterApplyAction, SelectAction

public abstract class AbstractAction
extends java.lang.Object
implements Action

Abstract class for GUI actions.

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
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	isPrimary()
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	setPrimary(boolean primary)
void	setShortcut(java.lang.String shortcut) Set shortcut from string representation.
void	setShortcutCombination(KeyCombination shortcut)
void	setVisible(boolean visible)

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

actionPerform

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Action

Returns:

action's identifier

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Action

Returns:

action's localized caption

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface Action

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Action

Returns:

action's description

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Action

getShortcutCombination

public KeyCombination getShortcutCombination()

Specified by:

getShortcutCombination in interface Action

Returns:

action's shortcut

setShortcutCombination

public void setShortcutCombination(KeyCombination shortcut)

Specified by:

setShortcutCombination in interface Action

setShortcut

public void setShortcut(java.lang.String shortcut)

Description copied from interface: Action

Set shortcut from string representation.

Specified by:

setShortcut in interface Action

Parameters:

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

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface Action

Returns:

action's icon

setIcon

public void setIcon(java.lang.String icon)

Specified by:

setIcon in interface Action

setIconFromSet

public void setIconFromSet(Icons.Icon icon)

Description copied from interface: Action

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Action

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Action

Returns:

whether the action is currently enabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Action

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Action

Returns:

whether the action is currently visible

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface Action

getOwners

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

Specified by:

getOwners in interface Action

Returns:

the collection of owners

getOwner

public Component.ActionOwner getOwner()

Specified by:

getOwner in interface Action

Returns:

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

addOwner

public void addOwner(Component.ActionOwner actionOwner)

Description copied from interface: Action

Add an owner component.

Specified by:

addOwner in interface Action

Parameters:

actionOwner - owner component

removeOwner

public void removeOwner(Component.ActionOwner actionOwner)

Description copied from interface: Action

Remove an owner component.

Specified by:

removeOwner in interface Action

Parameters:

actionOwner - owner component

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: Action

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

Specified by:

addPropertyChangeListener in interface Action

Parameters:

listener - a PropertyChangeListener object

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: Action

Removes a listener.

Specified by:

removePropertyChangeListener in interface Action

Parameters:

listener - a PropertyChangeListener object

See Also:

Action.addPropertyChangeListener(java.beans.PropertyChangeListener)

refreshState

public void refreshState()

Description copied from interface: Action

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.

Specified by:

refreshState in interface Action

isPrimary

public boolean isPrimary()

setPrimary

public void setPrimary(boolean primary)