com.haulmont.cuba.gui.components

Class PickerField.LookupAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.PickerField.StandardAction

com.haulmont.cuba.gui.components.PickerField.LookupAction

All Implemented Interfaces:

Action, Action.SecuredAction, PickerField.PickerFieldAction

Direct Known Subclasses:

FilteringLookupAction

Enclosing interface:

PickerField<V extends Entity>

@Component(value="cuba_LookupAction")
 @Scope(value="prototype")
public static class PickerField.LookupAction
extends PickerField.StandardAction

Action to select an entity instance through the entity lookup screen.

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

 <bean id="cuba_LookupAction" class="com.company.sample.gui.MyLookupAction" scope="prototype"/>
 

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected PickerField.AfterLookupCloseHandler	afterLookupCloseHandler
protected PickerField.AfterLookupSelectionHandler	afterLookupSelectionHandler
protected java.lang.String	lookupScreen
protected WindowManager.OpenType	lookupScreenOpenType
protected java.util.Map<java.lang.String,java.lang.Object>	lookupScreenParams
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	lookupScreenParamsSupplier
static java.lang.String	NAME
protected WindowConfig	windowConfig

Fields inherited from class com.haulmont.cuba.gui.components.PickerField.StandardAction

clientConfig, editable, pickerField

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
LookupAction(PickerField pickerField)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
void	afterCloseLookup(java.lang.String actionId) Hook to be implemented in subclasses.
protected void	afterLookupWindowOpened(Window lookupWindow)
void	afterSelect(java.util.Collection items) Hook to be implemented in subclasses.
static PickerField.LookupAction	create(PickerField pickerField)
java.lang.String	getLookupScreen()
WindowManager.OpenType	getLookupScreenOpenType()
java.util.Map<java.lang.String,java.lang.Object>	getLookupScreenParams()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getLookupScreenParamsSupplier()
protected void	handleLookupWindowSelection(java.util.Collection items)
protected java.util.Map<java.lang.String,java.lang.Object>	prepareScreenParams()
void	setAfterLookupCloseHandler(PickerField.AfterLookupCloseHandler afterLookupCloseHandler)
void	setAfterLookupSelectionHandler(PickerField.AfterLookupSelectionHandler afterLookupSelectionHandler)
void	setLookupScreen(java.lang.String lookupScreen) Set the lookup screen ID explicitly.
void	setLookupScreenOpenType(WindowManager.OpenType lookupScreenOpenType) How to open the lookup screen.
void	setLookupScreenParams(java.util.Map<java.lang.String,java.lang.Object> lookupScreenParams) Parameters to pass to the lookup screen.
void	setLookupScreenParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> supplier)
Entity	transformValueFromLookupWindow(Entity valueFromLookupWindow) Hook to be implemented in subclasses.

Methods inherited from class com.haulmont.cuba.gui.components.PickerField.StandardAction

editableChanged, getPropertyDatasource, isEditable, setEditable, setPickerField

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, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, setShortcut, setShortcutCombination

Field Detail

NAME

public static final java.lang.String NAME

lookupScreen

protected java.lang.String lookupScreen

lookupScreenOpenType

protected WindowManager.OpenType lookupScreenOpenType

lookupScreenParams

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

lookupScreenParamsSupplier

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

afterLookupCloseHandler

protected PickerField.AfterLookupCloseHandler afterLookupCloseHandler

afterLookupSelectionHandler

protected PickerField.AfterLookupSelectionHandler afterLookupSelectionHandler

windowConfig

protected WindowConfig windowConfig

Constructor Detail

LookupAction

public LookupAction(PickerField pickerField)

Method Detail

create

public static PickerField.LookupAction create(PickerField pickerField)

setAfterLookupCloseHandler

public void setAfterLookupCloseHandler(PickerField.AfterLookupCloseHandler afterLookupCloseHandler)

setAfterLookupSelectionHandler

public void setAfterLookupSelectionHandler(PickerField.AfterLookupSelectionHandler afterLookupSelectionHandler)

getLookupScreen

public java.lang.String getLookupScreen()

setLookupScreen

public void setLookupScreen(@Nullable
                            java.lang.String lookupScreen)

Set the lookup screen ID explicitly. By default a lookup screen ID is inferred from the entity metaclass name by adding suffix .lookup to it.

Parameters:

lookupScreen - lookup screen ID, e.g. sec$User.lookup

getLookupScreenOpenType

public WindowManager.OpenType getLookupScreenOpenType()

setLookupScreenOpenType

public void setLookupScreenOpenType(WindowManager.OpenType lookupScreenOpenType)

How to open the lookup screen. By default it is opened in WindowManager.OpenType.THIS_TAB mode.

Parameters:

lookupScreenOpenType - open type

getLookupScreenParams

@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getLookupScreenParams()

setLookupScreenParams

public void setLookupScreenParams(java.util.Map<java.lang.String,java.lang.Object> lookupScreenParams)

Parameters to pass to the lookup screen. By default the empty map is passed.

Parameters:

lookupScreenParams - map of parameters

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component when an action occurs.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

prepareScreenParams

@Nonnull
protected java.util.Map<java.lang.String,java.lang.Object> prepareScreenParams()

handleLookupWindowSelection

protected void handleLookupWindowSelection(java.util.Collection items)

afterLookupWindowOpened

protected void afterLookupWindowOpened(Window lookupWindow)

transformValueFromLookupWindow

public Entity transformValueFromLookupWindow(Entity valueFromLookupWindow)

Hook to be implemented in subclasses. Called by the action for new value selected from Lookup window. Can be used for reloading of entity with different view or to replace value with another value.

Parameters:

valueFromLookupWindow - value selected in Lookup window.

Returns:

value that will be set to PickerField

afterSelect

public void afterSelect(java.util.Collection items)

Hook to be implemented in subclasses. Called by the action when the user is selected some items in the lookup screen and the PickerField value is set.

Parameters:

items - collection of entity instances selected by user, never null

afterCloseLookup

public void afterCloseLookup(java.lang.String actionId)

Hook to be implemented in subclasses. Called by the action when the lookup screen is closed.

Parameters:

actionId - ID of action that closed the screen. The following values are possible:

• select - user selected some items
• cancel - user pressed Cancel button
• close - user closed the lookup screen by other means

getLookupScreenParamsSupplier

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

setLookupScreenParamsSupplier

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