io.jmix.ui.action.entitypicker

Class EntityLookupAction<E>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

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

io.jmix.ui.action.entitypicker.EntityLookupAction<E>

Type Parameters:

E - type of entity

All Implemented Interfaces:

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

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

Standard action for setting an entity to the entity picker using the entity lookup screen.

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

The action instance can be parameterized using the nested properties XML element or programmatically in the screen controller.

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
protected EntityPicker	entityPicker
static java.lang.String	ID

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.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
EntityLookupAction()
EntityLookupAction(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()
protected void	setEditable(boolean editable)
void	setEntityPicker(EntityPicker entityPicker)
protected 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.component.EntityPicker.EntityPickerAction

setPicker

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

entityPicker

protected EntityPicker entityPicker

componentProperties

protected UiComponentProperties componentProperties

editable

protected boolean editable

Constructor Detail

EntityLookupAction

public EntityLookupAction()

EntityLookupAction

public EntityLookupAction(java.lang.String id)

Method Detail

setEntityPicker

public void setEntityPicker(@Nullable
                            EntityPicker entityPicker)

Specified by:

setEntityPicker in interface EntityPicker.EntityPickerAction

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)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties componentProperties)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

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