com.haulmont.cuba.gui.components.actions

Class CreateAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.actions.ListAction

com.haulmont.cuba.gui.components.actions.CreateAction

All Implemented Interfaces:

Action, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasTarget, Action.SecuredAction

Direct Known Subclasses:

GroupBrowser.GroupPropertyCreateAction

@Component(value="cuba_CreateAction")
 @Scope(value="prototype")
public class CreateAction
extends ListAction
implements Action.HasOpenType, Action.HasBeforeActionPerformedHandler

Standard list action to create a new entity instance.

Action's behaviour can be customized by providing arguments to constructor, setting properties, or overriding methods afterCommit(com.haulmont.cuba.core.entity.Entity), afterWindowClosed(com.haulmont.cuba.gui.components.Window)

In order to provide your own implementation globally, create a subclass and register it in web-spring.xml, for example:

 <bean id="cuba_CreateAction" class="com.company.sample.gui.MyCreateAction" scope="prototype"/>
 

Also, use create() static methods instead of constructors when creating the action programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAction.AfterCommitHandler
static interface	CreateAction.AfterWindowClosedHandler

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.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID
protected boolean	addFirst
protected CreateAction.AfterCommitHandler	afterCommitHandler
protected CreateAction.AfterWindowClosedHandler	afterWindowClosedHandler
protected Action.BeforeActionPerformedHandler	beforeActionPerformedHandler
protected Window.CloseListener	editorCloseListener
protected java.util.Map<java.lang.String,java.lang.Object>	initialValues
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	initialValuesSupplier
protected Metadata	metadata
protected WindowManager.OpenType	openType
protected Security	security
protected java.lang.String	windowId
protected java.util.Map<java.lang.String,java.lang.Object>	windowParams
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	windowParamsSupplier

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

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

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
CreateAction(ListComponent target) The simplest constructor.
CreateAction(ListComponent target, WindowManager.OpenType openType) Constructor that allows to specify how the editor screen opens.
CreateAction(ListComponent target, WindowManager.OpenType openType, java.lang.String id) Constructor that allows to specify the action name and how the editor screen opens.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) This method is invoked by action owner component.
protected void	afterCommit(Entity entity) Hook invoked after the editor was committed and closed
protected void	afterWindowClosed(Window window) Hook invoked always after the editor was closed
static CreateAction	create(ListComponent target) Creates an action with default id, opening the editor screen in THIS tab.
static CreateAction	create(ListComponent target, WindowManager.OpenType openType) Creates an action with default id.
static CreateAction	create(ListComponent target, WindowManager.OpenType openType, java.lang.String id) Creates an action with the given id.
protected Entity	createEntity()
Action.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
java.util.Map<java.lang.String,java.lang.Object>	getInitialValues()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getInitialValuesSupplier()
WindowManager.OpenType	getOpenType()
java.lang.String	getWindowId()
java.util.Map<java.lang.String,java.lang.Object>	getWindowParams()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getWindowParamsSupplier()
protected void	internalOpenEditor(CollectionDatasource datasource, Entity newItem, Datasource parentDs, java.util.Map<java.lang.String,java.lang.Object> params)
boolean	isAddFirst()
protected boolean	isPermitted() Check permissions for Action
protected java.util.Map<java.lang.String,java.lang.Object>	prepareWindowParams()
void	setAddFirst(boolean addFirst) Whether this action will add a new instance to the beginning of the datasource's collection.
void	setAfterCommitHandler(CreateAction.AfterCommitHandler afterCommitHandler)
void	setAfterWindowClosedHandler(CreateAction.AfterWindowClosedHandler afterWindowClosedHandler)
void	setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)
void	setEditorCloseListener(Window.CloseListener editorCloseListener) Overwrites default close listener for editor window.
void	setInitialValues(java.util.Map<java.lang.String,java.lang.Object> initialValues)
void	setInitialValuesSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> initialValuesSupplier)
protected void	setInitialValuesToItem(Entity item)
void	setOpenType(WindowManager.OpenType openType)
void	setWindowId(java.lang.String windowId)
void	setWindowParams(java.util.Map<java.lang.String,java.lang.Object> windowParams)
void	setWindowParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier)

Methods inherited from class com.haulmont.cuba.gui.components.actions.ListAction

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

Methods inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

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

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

ACTION_ID

public static final java.lang.String ACTION_ID

openType

protected WindowManager.OpenType openType

windowId

protected java.lang.String windowId

windowParams

protected java.util.Map<java.lang.String,java.lang.Object> windowParams

windowParamsSupplier

protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier

initialValues

protected java.util.Map<java.lang.String,java.lang.Object> initialValues

initialValuesSupplier

protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> initialValuesSupplier

addFirst

protected boolean addFirst

metadata

protected Metadata metadata

security

protected Security security

afterCommitHandler

protected CreateAction.AfterCommitHandler afterCommitHandler

afterWindowClosedHandler

protected CreateAction.AfterWindowClosedHandler afterWindowClosedHandler

editorCloseListener

protected Window.CloseListener editorCloseListener

beforeActionPerformedHandler

protected Action.BeforeActionPerformedHandler beforeActionPerformedHandler

Constructor Detail

CreateAction

public CreateAction(ListComponent target)

The simplest constructor. The action has default name and opens the editor screen in THIS tab.

Parameters:

target - component containing this action

CreateAction

public CreateAction(ListComponent target,
                    WindowManager.OpenType openType)

Constructor that allows to specify how the editor screen opens. The action has default name.

Parameters:

target - component containing this action

openType - how to open the editor screen

CreateAction

public CreateAction(ListComponent target,
                    WindowManager.OpenType openType,
                    java.lang.String id)

Constructor that allows to specify the action name and how the editor screen opens.

Parameters:

target - component containing this action

openType - how to open the editor screen

id - action name

Method Detail

create

public static CreateAction create(ListComponent target)

Creates an action with default id, opening the editor screen in THIS tab.

Parameters:

target - component containing this action

create

public static CreateAction create(ListComponent target,
                                  WindowManager.OpenType openType)

Creates an action with default id.

Parameters:

target - component containing this action

openType - how to open the editor screen

create

public static CreateAction create(ListComponent target,
                                  WindowManager.OpenType openType,
                                  java.lang.String id)

Creates an action with the given id.

Parameters:

target - component containing this action

openType - how to open the editor screen

id - action name

isPermitted

protected boolean isPermitted()

Check permissions for Action

Overrides:

isPermitted in class BaseAction

Returns:

true if the action is enabled for the current user

actionPerform

public void actionPerform(Component component)

This method is invoked by action owner component. Don't override it, there are special methods to customize behaviour below.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - component invoking action

createEntity

protected Entity createEntity()

prepareWindowParams

protected java.util.Map<java.lang.String,java.lang.Object> prepareWindowParams()

setInitialValuesToItem

protected void setInitialValuesToItem(Entity item)

internalOpenEditor

protected void internalOpenEditor(CollectionDatasource datasource,
                                  Entity newItem,
                                  Datasource parentDs,
                                  java.util.Map<java.lang.String,java.lang.Object> params)

getOpenType

public WindowManager.OpenType getOpenType()

Specified by:

getOpenType in interface Action.HasOpenType

Returns:

editor screen open type

setOpenType

public void setOpenType(WindowManager.OpenType openType)

Specified by:

setOpenType in interface Action.HasOpenType

Parameters:

openType - editor screen open type

getWindowId

public java.lang.String getWindowId()

Returns:

editor screen identifier

setWindowId

public void setWindowId(java.lang.String windowId)

Parameters:

windowId - editor screen identifier

getWindowParams

public java.util.Map<java.lang.String,java.lang.Object> getWindowParams()

Returns:

editor screen parameters

setWindowParams

public void setWindowParams(java.util.Map<java.lang.String,java.lang.Object> windowParams)

Parameters:

windowParams - editor screen parameters

getWindowParamsSupplier

public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> getWindowParamsSupplier()

Returns:

supplier that provides editor screen parameters

setWindowParamsSupplier

public void setWindowParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier)

Parameters:

windowParamsSupplier - supplier that provides editor screen parameters

getInitialValues

public java.util.Map<java.lang.String,java.lang.Object> getInitialValues()

Returns:

map of initial values for attributes of created entity

setInitialValues

public void setInitialValues(java.util.Map<java.lang.String,java.lang.Object> initialValues)

Parameters:

initialValues - map of initial values for attributes of created entity

getInitialValuesSupplier

public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> getInitialValuesSupplier()

Returns:

supplier that provides map of initial values for attributes of created entity

setInitialValuesSupplier

public void setInitialValuesSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> initialValuesSupplier)

Parameters:

initialValuesSupplier - supplier that provides map of initial values for attributes of created entity

isAddFirst

public boolean isAddFirst()

Returns:

whether this action will add a new instance to the beginning of the datasource's collection. Affects only standalone datasources, for nested datasources new items are always added to the end.

setAddFirst

public void setAddFirst(boolean addFirst)

Whether this action will add a new instance to the beginning of the datasource's collection. Affects only standalone datasources, for nested datasources new items are always added to the end.

See Also:

ClientConfig.getCreateActionAddsFirst()

afterCommit

protected void afterCommit(Entity entity)

Hook invoked after the editor was committed and closed

Parameters:

entity - new committed entity instance

afterWindowClosed

protected void afterWindowClosed(Window window)

Hook invoked always after the editor was closed

Parameters:

window - the editor window

setAfterCommitHandler

public void setAfterCommitHandler(CreateAction.AfterCommitHandler afterCommitHandler)

Parameters:

afterCommitHandler - handler that is invoked after the editor was committed and closed

setAfterWindowClosedHandler

public void setAfterWindowClosedHandler(CreateAction.AfterWindowClosedHandler afterWindowClosedHandler)

Parameters:

afterWindowClosedHandler - handler that is always invoked after the editor closed

setEditorCloseListener

public void setEditorCloseListener(Window.CloseListener editorCloseListener)

Overwrites default close listener for editor window.

Parameters:

editorCloseListener - new close listener

getBeforeActionPerformedHandler

public Action.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)

Specified by:

setBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler