io.jmix.ui.action.list

Class CreateAction<E>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.ui.action.list.CreateAction<E>

Type Parameters:

E - type of entity

All Implemented Interfaces:

Action, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasTarget, Action.ScreenOpeningAction, Action.SecuredAction

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Creates an entity instance using its editor screen",
              availableInScreenWizard=true)
 @ActionType(value="create")
public class CreateAction<E>
extends ListAction
implements Action.AdjustWhenScreenReadOnly, Action.ScreenOpeningAction, Action.ExecutableAction

Standard action for creating an entity instance using its editor screen.

Should be defined for a list component (Table, DataGrid, etc.) 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 io.jmix.core.AccessManager	accessManager
protected java.util.function.Consumer<E>	afterCommitHandler
static java.lang.String	ID
protected java.util.function.Consumer<E>	initializer
protected java.util.function.Supplier<E>	newEntitySupplier
protected ScreenBuilders	screenBuilders
protected ActionScreenInitializer	screenInitializer
protected java.util.function.Function<E,E>	transformation

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

target

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

Constructor Summary

Constructors

Constructor and Description
CreateAction()
CreateAction(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	execute() Executes the action.
OpenMode	getOpenMode() Returns the screen open mode if it was set by Action.ScreenOpeningAction.setOpenMode(OpenMode) or in the screen XML, otherwise returns null.
java.lang.Class<? extends Screen>	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.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
void	setAccessManager(io.jmix.core.AccessManager accessManager)
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 new entity.
protected void	setIcons(Icons icons)
void	setInitializer(java.util.function.Consumer<E> initializer) Sets the new entity initializer.
protected void	setMessages(io.jmix.core.Messages messages)
void	setNewEntitySupplier(java.util.function.Supplier<E> newEntitySupplier) Sets the new entity supplier.
void	setOpenMode(OpenMode openMode) Sets the screen open mode.
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setScreenClass(java.lang.Class<? extends Screen> screenClass) Sets the editor screen class.
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.
protected void	setUiComponentProperties(UiComponentProperties componentProperties)

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

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

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

isDisabledWhenScreenReadOnly

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

screenBuilders

protected ScreenBuilders screenBuilders

accessManager

protected io.jmix.core.AccessManager accessManager

screenInitializer

protected ActionScreenInitializer screenInitializer

newEntitySupplier

protected java.util.function.Supplier<E> newEntitySupplier

initializer

protected java.util.function.Consumer<E> initializer

afterCommitHandler

protected java.util.function.Consumer<E> afterCommitHandler

transformation

protected java.util.function.Function<E,E> transformation

Constructor Detail

CreateAction

public CreateAction()

CreateAction

public CreateAction(java.lang.String id)

Method Detail

getOpenMode

@Nullable
public OpenMode getOpenMode()

Description copied from interface: Action.ScreenOpeningAction

Returns the screen open mode if it was set by Action.ScreenOpeningAction.setOpenMode(OpenMode) or in the screen XML, otherwise returns null.

Specified by:

getOpenMode in interface Action.ScreenOpeningAction

setOpenMode

@StudioPropertiesItem
public void setOpenMode(@Nullable
                                              OpenMode openMode)

Description copied from interface: Action.ScreenOpeningAction

Sets the screen open mode.

Specified by:

setOpenMode in interface Action.ScreenOpeningAction

Parameters:

openMode - the open mode to set

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.

Specified by:

getScreenId in interface Action.ScreenOpeningAction

setScreenId

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

Sets the editor screen id.

Specified by:

setScreenId in interface Action.ScreenOpeningAction

Parameters:

screenId - the screen id to set

getScreenClass

@Nullable
public java.lang.Class<? extends Screen> getScreenClass()

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

Specified by:

getScreenClass in interface Action.ScreenOpeningAction

setScreenClass

@StudioPropertiesItem
public void setScreenClass(@Nullable
                                                 java.lang.Class<? extends Screen> screenClass)

Sets the editor screen class.

Specified by:

setScreenClass in interface Action.ScreenOpeningAction

Parameters:

screenClass - the screen class to set

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 = "petsTable.create", subject = "screenOptionsSupplier")
 protected ScreenOptions petsTableCreateScreenOptionsSupplier() {
     return new MapScreenOptions(ParamsMap.of("someParameter", 10));
 }
 

Specified by:

setScreenOptionsSupplier in interface Action.ScreenOpeningAction

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 = "petsTable.create", subject = "screenConfigurer")
 protected void petsTableCreateScreenConfigurer(Screen editorScreen) {
     ((PetEdit) editorScreen).setSomeParameter(someValue);
 }
 

Specified by:

setScreenConfigurer in interface Action.ScreenOpeningAction

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 = "petsTable.create", subject = "afterCloseHandler")
 protected void petsTableCreateAfterCloseHandler(AfterCloseEvent event) {
     if (event.closedWith(StandardOutcome.COMMIT)) {
         System.out.println("Committed");
     }
 }
 

Specified by:

setAfterCloseHandler in interface Action.ScreenOpeningAction

setNewEntitySupplier

public void setNewEntitySupplier(java.util.function.Supplier<E> newEntitySupplier)

Sets the new entity supplier. The supplier should return a new entity instance.

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

 @Install(to = "petsTable.create", subject = "newEntitySupplier")
 protected Pet petsTableCreateNewEntitySupplier() {
     Pet pet = metadata.create(Pet.class);
     pet.setName("a cat");
     return pet;
 }
 

setInitializer

public void setInitializer(java.util.function.Consumer<E> initializer)

Sets the new entity initializer. The initializer accepts the new entity instance and can perform its initialization.

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

 @Install(to = "petsTable.create", subject = "initializer")
 protected void petsTableCreateInitializer(Pet entity) {
     entity.setName("a cat");
 }
 

setAfterCommitHandler

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

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

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

 @Install(to = "petsTable.create", subject = "afterCommitHandler")
 protected void petsTableCreateAfterCommitHandler(Pet entity) {
     System.out.println("Created " + 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 = "petsTable.create", subject = "transformation")
 protected Pet petsTableCreateTransformation(Pet entity) {
     return doTransform(entity);
 }
 

setMessages

@Autowired
protected void setMessages(io.jmix.core.Messages messages)

setIcons

@Autowired
protected void setIcons(Icons icons)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties componentProperties)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setAccessManager

@Autowired
public void setAccessManager(io.jmix.core.AccessManager accessManager)

isPermitted

protected boolean isPermitted()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isPermitted in class BaseAction

Returns:

true if the action is enabled for the current user

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