io.jmix.ui.action.tagpicker

Class TagLookupAction<E>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.AbstractLookupAction<E>

io.jmix.ui.action.tagpicker.TagLookupAction<E>

Type Parameters:

E - type of entity

All Implemented Interfaces:

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

@StudioAction(target="io.jmix.ui.component.TagPicker",
              description="Sets an entity to the tag picker using the entity lookup screen")
 @ActionType(value="tag_lookup")
public class TagLookupAction<E>
extends AbstractLookupAction<E>
implements Action.ScreenOpeningAction, TagPicker.TagPickerAction, org.springframework.beans.factory.InitializingBean, Action.ExecutableAction

Lookup action for setting entities to the tag picker using the entity lookup screen.

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.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected UiComponentProperties	componentProperties
protected boolean	editable
static java.lang.String	ID
protected boolean	multiSelect
protected TagPicker	tagPicker

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

icons, messages, screenBuilders, screenInitializer, selectValidator, transformation

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.component.TagPicker.TagPickerAction

PROP_MULTISELECT

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

PROP_EDITABLE

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

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
TagLookupAction()
TagLookupAction(java.lang.String id)

Method Summary

Modifier and Type	Method and 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()
boolean	isMultiSelect()
protected void	setEditable(boolean editable)
void	setMultiSelect(boolean multiSelect) Sets multiselect to the action.
void	setTagPicker(TagPicker tagPicker) Sets TagPicker to the action.
void	setUiComponentProperties(UiComponentProperties componentProperties)

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

getOpenMode, getScreenClass, getScreenId, setAfterCloseHandler, setIcons, setMessages, setOpenMode, setScreenBuilders, setScreenClass, setScreenConfigurer, setScreenId, setScreenOptionsSupplier, setSelectValidator, setTransformation

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

getOpenMode, getScreenClass, getScreenId, setAfterCloseHandler, setOpenMode, setScreenClass, setScreenConfigurer, setScreenId, setScreenOptionsSupplier

Methods inherited from interface io.jmix.ui.component.TagPicker.TagPickerAction

setPicker

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 Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

tagPicker

protected TagPicker tagPicker

componentProperties

protected UiComponentProperties componentProperties

multiSelect

protected boolean multiSelect

editable

protected boolean editable

Constructor Detail

TagLookupAction

public TagLookupAction()

TagLookupAction

public TagLookupAction(java.lang.String id)

Method Detail

setUiComponentProperties

@Autowired
public void setUiComponentProperties(UiComponentProperties componentProperties)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception

setTagPicker

public void setTagPicker(@Nullable
                         TagPicker tagPicker)

Description copied from interface: TagPicker.TagPickerAction

Sets TagPicker to the action.

Specified by:

setTagPicker in interface TagPicker.TagPickerAction

Parameters:

tagPicker - field 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

isMultiSelect

public boolean isMultiSelect()

Returns:

whether multiselect enabled

setMultiSelect

@StudioPropertiesItem
public void setMultiSelect(boolean multiSelect)

Sets multiselect to the action. In the Lookup Screen it enables multiselect if LookupComponent supports it. The default value is true.

Parameters:

multiSelect - whether multiselect should be enabled or not

isEditable

public boolean isEditable()

Specified by:

isEditable in interface ValuePicker.ValuePickerAction

Returns:

whether action is editable

setEditable

protected void setEditable(boolean editable)

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()

Description copied from interface: Action.ExecutableAction

Executes the Action

Specified by:

execute in interface Action.ExecutableAction