com.haulmont.cuba.gui.actions.picker

Class OpenAction<E extends Entity>

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

com.haulmont.cuba.gui.actions.picker.OpenAction<E>

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.SecuredAction, PickerField.PickerFieldAction, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

OpenCompositionAction

@StudioAction(category="Picker Actions",
              description="Opens an entity using the entity edit screen")
 @ActionType(value="picker_open")
public class OpenAction<E extends Entity>
extends BaseAction
implements PickerField.PickerFieldAction, org.springframework.beans.factory.InitializingBean, Action.ExecutableAction

Standard picker field action for opening an entity instance in its editor screen.

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 com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.BeforeActionPerformedHandler, Action.DisabledWhenScreenReadOnly, Action.ExecutableAction, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration
protected boolean	editable
protected Icons	icons
static java.lang.String	ID
protected Messages	messages
protected PickerField<Entity>	pickerField
protected ScreenBuilders	screenBuilders
protected ActionScreenInitializer	screenInitializer

Fields inherited from class com.haulmont.cuba.gui.components.AbstractAction

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

Fields inherited from interface com.haulmont.cuba.gui.components.PickerField.PickerFieldAction

PROP_EDITABLE

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
OpenAction()
OpenAction(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()
protected boolean	checkFieldValue()
void	editableChanged(PickerField pickerField, boolean editable)
void	execute() Executes the action.
OpenMode	getOpenMode() Returns the editor screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML.
java.lang.Class	getScreenClass() Returns the editor screen class if it was set by setScreenClass(Class) or in the screen XML.
java.lang.String	getScreenId() Returns the editor screen id if it was set by setScreenId(String) or in the screen XML.
boolean	isEditable()
void	setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler) Sets the handler to be invoked when the editor screen closes.
void	setAfterCommitHandler(java.util.function.Consumer<E> afterCommitHandler) Sets the handler to be invoked when the editor screen commits the entity.
protected void	setConfiguration(Configuration configuration)
protected void	setEditable(boolean editable)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setOpenMode(OpenMode openMode) Sets the editor screen open mode.
void	setPickerField(PickerField pickerField)
void	setScreenClass(java.lang.Class screenClass) Sets the editor screen id.
void	setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer) Sets the editor screen configurer.
void	setScreenId(java.lang.String screenId) Sets the editor screen id.
void	setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier) Sets the editor screen options supplier.
void	setTransformation(java.util.function.Function<E,E> transformation) Sets the function to transform the committed in the editor screen entity before setting it to the target data container.

Methods inherited from class com.haulmont.cuba.gui.components.actions.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 com.haulmont.cuba.gui.components.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDefaultCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, 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 com.haulmont.cuba.gui.components.Action

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

pickerField

protected PickerField<Entity> pickerField

icons

protected Icons icons

messages

protected Messages messages

configuration

protected Configuration configuration

screenBuilders

@Inject
protected ScreenBuilders screenBuilders

editable

protected boolean editable

screenInitializer

protected ActionScreenInitializer screenInitializer

Constructor Detail

OpenAction

public OpenAction()

OpenAction

public OpenAction(java.lang.String id)

Method Detail

getOpenMode

@Nullable
public OpenMode getOpenMode()

Returns the editor screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML. Otherwise returns null.

setOpenMode

@StudioPropertiesItem
public void setOpenMode(OpenMode openMode)

Sets the editor screen open mode.

getScreenId

@Nullable
public java.lang.String getScreenId()

Returns the editor screen id if it was set by setScreenId(String) or in the screen XML. Otherwise returns null.

setScreenId

@StudioPropertiesItem
public void setScreenId(java.lang.String screenId)

Sets the editor screen id.

getScreenClass

@Nullable
public java.lang.Class getScreenClass()

Returns the editor screen class if it was set by setScreenClass(Class) or in the screen XML. Otherwise returns null.

setScreenClass

@StudioPropertiesItem
public void setScreenClass(java.lang.Class screenClass)

Sets the editor screen id.

setScreenOptionsSupplier

public void setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier)

Sets the editor screen options supplier. The supplier provides ScreenOptions to the opened screen.

The preferred way to set the supplier is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.open", subject = "screenOptionsSupplier")
 protected ScreenOptions petFieldOpenScreenOptionsSupplier() {
     return new MapScreenOptions(ParamsMap.of("someParameter", 10));
 }
 

setScreenConfigurer

public void setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer)

Sets the editor screen configurer. Use the configurer if you need to provide parameters to the opened screen through setters.

The preferred way to set the configurer is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.open", subject = "screenConfigurer")
 protected void petFieldOpenScreenConfigurer(Screen editorScreen) {
     ((PetEdit) editorScreen).setSomeParameter(someValue);
 }
 

setAfterCloseHandler

public void setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler)

Sets the handler to be invoked when the editor screen closes.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.open", subject = "afterCloseHandler")
 protected void petFieldOpenAfterCloseHandler(AfterCloseEvent event) {
     CloseAction closeAction = event.getCloseAction();
     System.out.println("Closed with " + closeAction);
 }
 

setAfterCommitHandler

public void setAfterCommitHandler(java.util.function.Consumer<E> afterCommitHandler)

Sets the handler to be invoked when the editor screen commits the entity.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.open", subject = "afterCommitHandler")
 protected void petFieldOpenAfterCommitHandler(Pet entity) {
     System.out.println("Committed " + entity);
 }
 

setTransformation

public void setTransformation(java.util.function.Function<E,E> transformation)

Sets the function to transform the committed in the editor screen entity before setting it to the target data container.

The preferred way to set the function is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.open", subject = "transformation")
 protected Pet petFieldOpenTransformation(Pet entity) {
     return doTransform(entity);
 }
 

setConfiguration

@Inject
protected void setConfiguration(Configuration configuration)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception

setPickerField

public void setPickerField(PickerField pickerField)

Specified by:

setPickerField in interface PickerField.PickerFieldAction

editableChanged

public void editableChanged(PickerField pickerField,
                            boolean editable)

Specified by:

editableChanged in interface PickerField.PickerFieldAction

isEditable

public boolean isEditable()

Specified by:

isEditable in interface PickerField.PickerFieldAction

setEditable

protected void setEditable(boolean editable)

setIcons

@Inject
protected void setIcons(Icons icons)

setMessages

@Inject
protected void setMessages(Messages messages)

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

checkFieldValue

protected boolean checkFieldValue()