@Component(value="cuba_AddAction") @Scope(value="prototype") public class AddAction extends ListAction implements Action.HasOpenType, Action.HasBeforeActionPerformedHandler
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.Modifier and Type | Class and Description |
---|---|
static interface |
AddAction.AfterAddHandler |
protected class |
AddAction.DefaultHandler
The default implementation of
Lookup.Handler , adding items to owner's datasource if they are not
there yet. |
BaseAction.EnabledRule
Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTION_ID |
protected AddAction.AfterAddHandler |
afterAddHandler |
protected Action.BeforeActionPerformedHandler |
beforeActionPerformedHandler |
protected Window.Lookup.Handler |
handler |
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 |
target
caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible
PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE
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.
|
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() |
protected boolean |
isPermitted()
Callback method which is invoked by the action to determine its enabled state.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
prepareWindowParams() |
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) |
getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut
addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setIconFromSet, setShortcut, setShortcutCombination, setVisible
public static final java.lang.String ACTION_ID
protected Window.Lookup.Handler handler
protected WindowManager.OpenType openType
protected AddAction.AfterAddHandler afterAddHandler
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
protected Security security
protected Action.BeforeActionPerformedHandler beforeActionPerformedHandler
public AddAction(ListComponent target)
setHandler(com.haulmont.cuba.gui.components.Window.Lookup.Handler)
.
If it is not set, an instance of AddAction.DefaultHandler
will be used.target
- component containing this actionpublic AddAction(ListComponent target, @Nullable Window.Lookup.Handler handler)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.public AddAction(ListComponent target, @Nullable Window.Lookup.Handler handler, WindowManager.OpenType openType)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.openType
- how to open the editor screenpublic AddAction(ListComponent target, @Nullable Window.Lookup.Handler handler, WindowManager.OpenType openType, java.lang.String id)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.openType
- how to open the editor screenid
- action's namepublic static AddAction create(ListComponent target)
target
- component containing this actionpublic static AddAction create(ListComponent target, @Nullable Window.Lookup.Handler handler)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.public static AddAction create(ListComponent target, @Nullable Window.Lookup.Handler handler, WindowManager.OpenType openType)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.openType
- how to open the editor screenpublic static AddAction create(ListComponent target, @Nullable Window.Lookup.Handler handler, WindowManager.OpenType openType, java.lang.String id)
target
- component containing this actionhandler
- lookup handler. If null, an instance of AddAction.DefaultHandler
will be used.openType
- how to open the editor screenid
- action's nameprotected boolean isPermitted()
BaseAction
isPermitted
in class BaseAction
public AddAction.AfterAddHandler getAfterAddHandler()
public void setAfterAddHandler(AddAction.AfterAddHandler afterAddHandler)
public void actionPerform(Component component)
actionPerform
in interface Action
actionPerform
in class BaseAction
component
- component invoking actionprotected java.util.Map<java.lang.String,java.lang.Object> prepareWindowParams()
@Nullable public Window.Lookup.Handler getHandler()
public void setHandler(Window.Lookup.Handler handler)
handler
- handler to pass to lookup screenpublic WindowManager.OpenType getOpenType()
getOpenType
in interface Action.HasOpenType
public void setOpenType(WindowManager.OpenType openType)
setOpenType
in interface Action.HasOpenType
openType
- lookup screen open typepublic java.lang.String getWindowId()
public void setWindowId(java.lang.String windowId)
windowId
- lookup screen idpublic java.util.Map<java.lang.String,java.lang.Object> getWindowParams()
public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> getWindowParamsSupplier()
public void setWindowParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier)
windowParamsSupplier
- supplier that provides lookup screen parameterspublic void setWindowParams(java.util.Map<java.lang.String,java.lang.Object> windowParams)
windowParams
- lookup screen parameterspublic Action.BeforeActionPerformedHandler getBeforeActionPerformedHandler()
getBeforeActionPerformedHandler
in interface Action.HasBeforeActionPerformedHandler
public void setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)
setBeforeActionPerformedHandler
in interface Action.HasBeforeActionPerformedHandler