Package io.jmix.ui.action.valuepicker

Class ValueClearAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.valuepicker.ValueClearAction

All Implemented Interfaces:

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

Direct Known Subclasses:

EntityClearAction

@StudioAction(target="io.jmix.ui.component.ValuePicker",
              description="Clears the value picker value")
@ActionType("value_clear")
public class ValueClearAction
extends BaseAction
implements ValuePicker.ValuePickerAction, org.springframework.beans.factory.InitializingBean, Action.ExecutableAction

Standard value picker action for clearing the field value.

Should be defined for ValuePicker 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
protected UiComponentProperties	componentProperties
protected boolean	editable
protected Icons	icons
static final String	ID
protected Messages	messages
protected ValuePicker	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
ValueClearAction()
ValueClearAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
void	afterPropertiesSet()
void	editableChanged(boolean editable)	Called by ValuePicker to inform about its editable state.
void	execute()	Executes the action.
boolean	isEditable()
protected void	setEditable(boolean editable)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setPicker(ValuePicker valuePicker)	Sets a ValuePicker instance associated with this action.
protected void	setUiComponentProperties(UiComponentProperties componentProperties)

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

valuePicker

protected ValuePicker valuePicker

icons

protected Icons icons

messages

protected Messages messages

componentProperties

protected UiComponentProperties componentProperties

editable

protected boolean editable

Constructor Details

ValueClearAction

public ValueClearAction()

ValueClearAction

public ValueClearAction(String id)

Method Details

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties componentProperties)

setMessages

@Autowired
protected void setMessages(Messages messages)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

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

Parameters:

valuePicker - a ValuePicker instance to set

editableChanged

public void editableChanged(boolean editable)

Description copied from interface: ValuePicker.ValuePickerAction

Called by ValuePicker to inform about its editable state.

Specified by:

editableChanged in interface ValuePicker.ValuePickerAction

Parameters:

editable - a ValuePicker editable state

isEditable

public boolean isEditable()

Specified by:

isEditable in interface ValuePicker.ValuePickerAction

Returns:

whether this action is editable

setEditable

protected void setEditable(boolean editable)

setIcons

@Autowired
protected void setIcons(Icons icons)

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction