Package io.jmix.ui.action.entitypicker

Class EntityOpenCompositionAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.entitypicker.EntityOpenAction

io.jmix.ui.action.entitypicker.EntityOpenCompositionAction

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="Opens a one-to-one composition entity using the entity edit screen")
@ActionType("entity_openComposition")
public class EntityOpenCompositionAction
extends EntityOpenAction

Standard picker field action for opening an entity instance if it is a one-to-one composition.

Should be defined for PickerField 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.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.entitypicker.EntityOpenAction

componentProperties, editable, entityPicker, icons, messages, metadataTools, screenBuilders, screenInitializer

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
EntityOpenCompositionAction()
EntityOpenCompositionAction(String id)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkFieldValue()

Methods inherited from class io.jmix.ui.action.entitypicker.EntityOpenAction

actionPerform, afterPropertiesSet, editableChanged, execute, getOpenMode, getScreenClass, getScreenId, isEditable, setAfterCloseHandler, setAfterCommitHandler, setEditable, setEntityPicker, setIcons, setMessages, setOpenMode, setScreenBuilders, setScreenClass, setScreenConfigurer, setScreenId, setScreenOptionsSupplier, setTransformation, 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.EntityPicker.EntityPickerAction

setPicker

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

EntityOpenCompositionAction

public EntityOpenCompositionAction()

EntityOpenCompositionAction

public EntityOpenCompositionAction(String id)

Method Details

checkFieldValue

protected boolean checkFieldValue()

Overrides:

checkFieldValue in class EntityOpenAction