Package io.jmix.ui.action.entitypicker

Class EntityClearAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.valuepicker.ValueClearAction

io.jmix.ui.action.entitypicker.EntityClearAction

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.SecuredAction, EntityPicker.EntityPickerAction, ValuePicker.ValuePickerAction, org.springframework.beans.factory.InitializingBean

@StudioAction(target="io.jmix.ui.component.EntityPicker",
              description="Clears the entity picker value")
@ActionType("entity_clear")
public class EntityClearAction
extends ValueClearAction
implements EntityPicker.EntityPickerAction

Standard entity picker action for clearing the field value.

Should be defined for EntityPicker or its subclass in a screen XML descriptor.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

BaseAction.EnabledRule

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.OperationResultAction, Action.ScreenAction<S extends Screen>, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class io.jmix.ui.action.valuepicker.ValueClearAction

componentProperties, editable, icons, messages, valuePicker

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

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

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Fields inherited from interface io.jmix.ui.component.ValuePicker.ValuePickerAction

PROP_EDITABLE

Constructor Summary

Constructors

Constructor	Description
EntityClearAction()
EntityClearAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the action.
protected EntityPicker	getEntityPicker()
void	setEntityPicker(EntityPicker entityPicker)
void	setPicker(ValuePicker valuePicker)	Sets a ValuePicker instance associated with this action.

Methods inherited from class io.jmix.ui.action.valuepicker.ValueClearAction

actionPerform, afterPropertiesSet, editableChanged, isEditable, setEditable, setIcons, setMessages, setUiComponentProperties

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

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

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Methods inherited from interface io.jmix.ui.component.ValuePicker.ValuePickerAction

editableChanged, isEditable

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

EntityClearAction

public EntityClearAction()

EntityClearAction

public EntityClearAction(String id)

Method Details

setEntityPicker

public void setEntityPicker(@Nullable
 EntityPicker entityPicker)

Specified by:

setEntityPicker in interface EntityPicker.EntityPickerAction

setPicker

public void setPicker(@Nullable
 ValuePicker valuePicker)

Description copied from interface: ValuePicker.ValuePickerAction

Sets a ValuePicker instance associated with this action.

Specified by:

setPicker in interface EntityPicker.EntityPickerAction

Specified by:

setPicker in interface ValuePicker.ValuePickerAction

Overrides:

setPicker in class ValueClearAction

Parameters:

valuePicker - a ValuePicker instance to set

getEntityPicker

protected EntityPicker getEntityPicker()

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction

Overrides:

execute in class ValueClearAction