Package io.jmix.flowui.kit.action

Interface Action

All Known Subinterfaces:

ExecutableAction, OperationResultAction, ScreenOpeningAction, SecuredAction, SecurityConstraintAction, TargetAction<C>

All Known Implementing Classes:

AbstractAction, BaseAction, CreateAction, DialogAction, EditAction, EditorCloseAction, EditorCommitAction, EditorCommitCloseAction, EditorDiscardAction, EditorEnableEditingAction, EntityClearAction, EntityLookupAction, EntityOpenAction, EntityOpenCompositionAction, ListDataComponentAction, LogoutAction, LookupDiscardAction, LookupSelectAction, OperationResultScreenAction, PickerAction, RemoveAction, ScreenAction, ScreenCloseAction, SecuredBaseAction, SecuredListDataComponentAction, ValueClearAction

public interface Action

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_DESCRIPTION
static final String	PROP_ENABLED
static final String	PROP_ICON
static final String	PROP_SHORTCUT
static final String	PROP_TEXT
static final String	PROP_VARIANT
static final String	PROP_VISIBLE

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)
com.vaadin.flow.shared.Registration	addPropertyChangeListener(Consumer<PropertyChangeEvent> listener)
String	getDescription()
String	getIcon()
String	getId()
KeyCombination	getShortcutCombination()
String	getText()
ActionVariant	getVariant()
boolean	isEnabled()
boolean	isVisible()
void	refreshState()
void	setDescription(String description)
void	setEnabled(boolean enabled)
void	setIcon(String icon)
void	setShortcutCombination(KeyCombination shortcutCombination)
void	setText(String text)
void	setVariant(ActionVariant variant)
void	setVisible(boolean visible)

Field Details

PROP_TEXT

static final String PROP_TEXT

See Also:

• Constant Field Values

PROP_ENABLED

static final String PROP_ENABLED

See Also:

• Constant Field Values

PROP_VISIBLE

static final String PROP_VISIBLE

See Also:

• Constant Field Values

PROP_ICON

static final String PROP_ICON

See Also:

• Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION

See Also:

• Constant Field Values

PROP_VARIANT

static final String PROP_VARIANT

See Also:

• Constant Field Values

PROP_SHORTCUT

static final String PROP_SHORTCUT

See Also:

• Constant Field Values

Method Details

getId

String getId()

getText

@Nullable
String getText()

setText

void setText(@Nullable
 String text)

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

isVisible

boolean isVisible()

setVisible

void setVisible(boolean visible)

getIcon

@Nullable
String getIcon()

setIcon

void setIcon(@Nullable
 String icon)

getDescription

@Nullable
String getDescription()

setDescription

void setDescription(@Nullable
 String description)

getVariant

ActionVariant getVariant()

setVariant

void setVariant(ActionVariant variant)

getShortcutCombination

@Nullable
KeyCombination getShortcutCombination()

setShortcutCombination

void setShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

refreshState

void refreshState()

actionPerform

void actionPerform(com.vaadin.flow.component.Component component)

addPropertyChangeListener

com.vaadin.flow.shared.Registration addPropertyChangeListener(Consumer<PropertyChangeEvent> listener)