io.jmix.ui.action

Interface Action

All Known Subinterfaces:

Action.ExecutableAction, Action.HasTarget, Action.MainTabSheetAction, Action.SecuredAction

All Known Implementing Classes:

AbstractAction, AbstractEditPresentationAction, AbstractLookupAction, AbstractPresentationAction, AddAction, BaseAction, BulkEditAction, CreateAction, DateIntervalAction, DeletePresentationAction, DialogAction, EditAction, EditPresentationAction, EntityClearAction, EntityLookupAction, EntityOpenAction, EntityOpenCompositionAction, ExcelExportAction, ExcludeAction, ExportAction, FilterAction, FilterAddConditionAction, FilterClearValuesAction, FilterCopyAction, FilterEditAction, FilterMakeDefaultAction, FilterRemoveAction, FilterSaveAction, FilterSaveAsAction, FilterSaveWithValuesAction, InputDialogAction, ItemTrackingAction, JsonExportAction, ListAction, PropertyFilterImpl.OperationChangeAction, RefreshAction, RelatedAction, RemoveAction, ResetPresentationAction, SaveAsPresentationAction, SavePresentationAction, SecuredListAction, ShowPivotAction, TagLookupAction, ValueClearAction, ValuesSelectAction, ViewAction

public interface Action

The Action interface abstracts away a function from a visual component.

The action is executed by invoking its actionPerform(Component) method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Action.ActionPerformedEvent Event sent when the action is performed.
static interface	Action.AdjustWhenScreenReadOnly Interface to be implemented by actions which may adjust their 'enabled' state according to the screen read-only mode.
static interface	Action.ExecutableAction Indicates that the action is executable.
static interface	Action.HasPrimaryState Interface to be implemented by actions that have primary state.
static interface	Action.HasSecurityConstraint Interface defining constraintOperationType and constraintCode options.
static interface	Action.HasTarget
static interface	Action.MainTabSheetAction An action that can be used as Main TabSheet context menu item.
static interface	Action.ScreenOpeningAction Interface to be implemented by actions that open a screen.
static interface	Action.SecuredAction Indicates that the action can be affected by UI permissions.
static class	Action.Status Used in dialogs to assign a special visual style for a button representing the action.

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 to execute the action.
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.
java.lang.String	getCaption()
java.lang.String	getDescription()
java.lang.String	getIcon()
java.lang.String	getId()
ActionOwner	getOwner()
java.util.Collection<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(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	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

@Nullable
java.lang.String getCaption()

Returns:

action's caption

setCaption

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

getDescription

@Nullable
java.lang.String getDescription()

Returns:

action's description

setDescription

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

getShortcutCombination

@Nullable
KeyCombination getShortcutCombination()

Returns:

action's keyboard shortcut

setShortcutCombination

void setShortcutCombination(@Nullable
                            KeyCombination shortcut)

setShortcut

void setShortcut(@Nullable
                 java.lang.String shortcut)

Set shortcut from string representation.

Parameters:

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

getIcon

@Nullable
java.lang.String getIcon()

Returns:

action's icon

setIcon

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

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 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.

getOwner

@Nullable
ActionOwner getOwner()

Returns:

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

getOwners

java.util.Collection<ActionOwner> getOwners()

Returns:

the collection of owners

addOwner

void addOwner(ActionOwner actionOwner)

Add an owner component.

Parameters:

actionOwner - owner component

removeOwner

void removeOwner(ActionOwner actionOwner)

Remove the owner component.

Parameters:

actionOwner - owner component

actionPerform

void actionPerform(Component component)

Invoked by owning component to execute the action.

Parameters:

component - invoking component

addPropertyChangeListener

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

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

Parameters:

listener - a listener object

removePropertyChangeListener

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

Removes the listener.

Parameters:

listener - a listener object

See Also:

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