io.jmix.ui.action

Class AbstractAction

java.lang.Object

io.jmix.ui.action.AbstractAction

All Implemented Interfaces:

Action, Action.HasPrimaryState

Direct Known Subclasses:

AbstractPresentationAction, BaseAction, InputDialogAction, PropertyFilterImpl.OperationChangeAction

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

Abstract class for GUI actions.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	caption
protected java.lang.String	description
protected boolean	enabled
protected io.jmix.core.common.event.EventHub	eventHub
protected java.lang.String	icon
protected java.lang.String	id
protected java.util.List<ActionOwner>	owners
protected boolean	primary
protected KeyCombination	shortcut
protected boolean	visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAction()
protected	AbstractAction(java.lang.String id)
protected	AbstractAction(java.lang.String id, Action.Status status)
protected	AbstractAction(java.lang.String id, java.lang.String shortcut)

Method Summary

Modifier and Type	Method and Description
void	addOwner(ActionOwner actionOwner) Add an owner component.
void	addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener) Adds a listener to be notified about Enabled, Caption or Icon property changes.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
java.lang.String	getCaption()
java.lang.String	getDescription()
protected io.jmix.core.common.event.EventHub	getEventHub()
java.lang.String	getIcon()
java.lang.String	getId()
ActionOwner	getOwner()
java.util.Collection<ActionOwner>	getOwners()
KeyCombination	getShortcutCombination()
protected boolean	hasSubscriptions(java.lang.Class<?> eventClass)
boolean	isEnabled()
boolean	isPrimary()
boolean	isVisible()
void	refreshState() Refresh internal state of the action to initialize enabled, visible, caption, icon, etc.
void	removeOwner(ActionOwner actionOwner) Remove the owner component.
void	removePropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener) Removes the listener.
void	setCaption(java.lang.String caption)
void	setDescription(java.lang.String description)
void	setEnabled(boolean enabled)
void	setIcon(java.lang.String icon)
void	setPrimary(boolean primary) Sets whether action is primary or not.
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

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

Methods inherited from interface io.jmix.ui.action.Action

actionPerform

Field Detail

id

protected java.lang.String id

caption

protected java.lang.String caption

description

protected java.lang.String description

icon

protected java.lang.String icon

enabled

protected boolean enabled

visible

protected boolean visible

owners

protected java.util.List<ActionOwner> owners

shortcut

protected KeyCombination shortcut

primary

protected boolean primary

eventHub

protected io.jmix.core.common.event.EventHub eventHub

Constructor Detail

AbstractAction

protected AbstractAction()

AbstractAction

protected AbstractAction(java.lang.String id)

AbstractAction

protected AbstractAction(java.lang.String id,
                         @Nullable
                         java.lang.String shortcut)

AbstractAction

protected AbstractAction(java.lang.String id,
                         Action.Status status)

Method Detail

getEventHub

protected io.jmix.core.common.event.EventHub getEventHub()

hasSubscriptions

protected boolean hasSubscriptions(java.lang.Class<?> eventClass)

getId

public java.lang.String getId()

Specified by:

getId in interface Action

Returns:

action's identifier

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface Action

Returns:

action's caption

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Specified by:

setCaption in interface Action

getDescription

@Nullable
public java.lang.String getDescription()

Specified by:

getDescription in interface Action

Returns:

action's description

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Specified by:

setDescription in interface Action

getShortcutCombination

@Nullable
public KeyCombination getShortcutCombination()

Specified by:

getShortcutCombination in interface Action

Returns:

action's keyboard shortcut

setShortcutCombination

public void setShortcutCombination(@Nullable
                                   KeyCombination shortcut)

Specified by:

setShortcutCombination in interface Action

setShortcut

public void setShortcut(@Nullable
                        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

@Nullable
public java.lang.String getIcon()

Specified by:

getIcon in interface Action

Returns:

action's icon

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Specified by:

setIcon 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<ActionOwner> getOwners()

Specified by:

getOwners in interface Action

Returns:

the collection of owners

getOwner

@Nullable
public 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(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(ActionOwner actionOwner)

Description copied from interface: Action

Remove the owner component.

Specified by:

removeOwner in interface Action

Parameters:

actionOwner - owner component

addPropertyChangeListener

public void addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> 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 listener object

removePropertyChangeListener

public void removePropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener)

Description copied from interface: Action

Removes the listener.

Specified by:

removePropertyChangeListener in interface Action

Parameters:

listener - a listener object

See Also:

Action.addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent>)

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

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 bound to data. 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()

Specified by:

isPrimary in interface Action.HasPrimaryState

Returns:

true if action is primary or false otherwise

setPrimary

public void setPrimary(boolean primary)

Description copied from interface: Action.HasPrimaryState

Sets whether action is primary or not.

Specified by:

setPrimary in interface Action.HasPrimaryState

Parameters:

primary - primary