com.haulmont.cuba.gui.components.actions

Class AddAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.actions.AddAction

All Implemented Interfaces:

Action, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasTarget, Action.UiPermissionAware

@Component(value="cuba_AddAction")
 @Scope(value="prototype")
public class AddAction
extends BaseAction
implements Action.HasOpenType, Action.HasBeforeActionPerformedHandler

Standard list action adding an entity instance to list from a lookup screen.

Action's behaviour can be customized by providing arguments to constructor or setting properties.

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

 <bean id="cuba_AddAction" class="com.company.sample.gui.MyAddAction" 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	AddAction.AfterAddHandler

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.Status, Action.UiPermissionAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID

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
AddAction(ListComponent target) The simplest constructor.
AddAction(ListComponent target, Window.Lookup.Handler handler) The simplest constructor.
AddAction(ListComponent target, Window.Lookup.Handler handler, WindowManager.OpenType openType) Constructor that allows to specify how the lookup screen opens.
AddAction(ListComponent target, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.lang.String id) Constructor that allows to specify the action name and how the lookup screen opens.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) This method is invoked by action owner component.
static AddAction	create(ListComponent target) Creates an action with default id, opening the lookup screen in THIS tab.
static AddAction	create(ListComponent target, Window.Lookup.Handler handler) Creates an action with default id, opening the lookup screen in THIS tab.
static AddAction	create(ListComponent target, Window.Lookup.Handler handler, WindowManager.OpenType openType) Creates an action with default id, opening the lookup screen in THIS tab.
static AddAction	create(ListComponent target, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.lang.String id) Creates an action with the given id.
AddAction.AfterAddHandler	getAfterAddHandler()
Action.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
Window.Lookup.Handler	getHandler()
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()
void	setAfterAddHandler(AddAction.AfterAddHandler afterAddHandler)
void	setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)
void	setHandler(Window.Lookup.Handler handler)
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.BaseAction

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setTarget, setVisible, setVisibleByUiPermissions, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

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

Methods inherited from class java.lang.Object

equals, 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

Constructor Detail

AddAction

public AddAction(ListComponent target)

The simplest constructor. The action has default name and opens the lookup screen in THIS tab. Lookup handler can be set by subsequent call to setHandler(com.haulmont.cuba.gui.components.Window.Lookup.Handler). If it is not set, an instance of DefaultHandler will be used.

Parameters:

target - component containing this action

AddAction

public AddAction(ListComponent target,
                 @Nullable
                 Window.Lookup.Handler handler)

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

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

AddAction

public AddAction(ListComponent target,
                 @Nullable
                 Window.Lookup.Handler handler,
                 WindowManager.OpenType openType)

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

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

openType - how to open the editor screen

AddAction

public AddAction(ListComponent target,
                 @Nullable
                 Window.Lookup.Handler handler,
                 WindowManager.OpenType openType,
                 java.lang.String id)

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

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

openType - how to open the editor screen

id - action's name

Method Detail

create

public static AddAction create(ListComponent target)

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

Parameters:

target - component containing this action

create

public static AddAction create(ListComponent target,
                               @Nullable
                               Window.Lookup.Handler handler)

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

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

create

public static AddAction create(ListComponent target,
                               @Nullable
                               Window.Lookup.Handler handler,
                               WindowManager.OpenType openType)

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

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

openType - how to open the editor screen

create

public static AddAction create(ListComponent target,
                               @Nullable
                               Window.Lookup.Handler handler,
                               WindowManager.OpenType openType,
                               java.lang.String id)

Creates an action with the given id.

Parameters:

target - component containing this action

handler - lookup handler. If null, an instance of DefaultHandler will be used.

openType - how to open the editor screen

id - action's name

getAfterAddHandler

public AddAction.AfterAddHandler getAfterAddHandler()

setAfterAddHandler

public void setAfterAddHandler(AddAction.AfterAddHandler afterAddHandler)

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

getHandler

@Nullable
public Window.Lookup.Handler getHandler()

Returns:

handler to pass to lookup screen

setHandler

public void setHandler(Window.Lookup.Handler handler)

Parameters:

handler - handler to pass to lookup screen

getOpenType

public WindowManager.OpenType getOpenType()

Specified by:

getOpenType in interface Action.HasOpenType

Returns:

lookup screen open type

setOpenType

public void setOpenType(WindowManager.OpenType openType)

Specified by:

setOpenType in interface Action.HasOpenType

Parameters:

openType - lookup screen open type

getWindowId

public java.lang.String getWindowId()

Returns:

lookup screen id

setWindowId

public void setWindowId(java.lang.String windowId)

Parameters:

windowId - lookup screen id

getWindowParams

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

Returns:

lookup screen parameters

getWindowParamsSupplier

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

Returns:

supplier that provides lookup 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 lookup screen parameters

setWindowParams

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

Parameters:

windowParams - lookup screen parameters

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