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

Direct Known Subclasses:

FilteringLookupAction

Enclosing interface:

PickerField

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

Field Summary

Fields

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

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.
void	afterSelect(java.util.Collection items) Hook to be implemented in subclasses.
static PickerField.LookupAction	create(PickerField pickerField)
java.lang.String	getLookupScreen()
DialogParams	getLookupScreenDialogParams() Deprecated.
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()
void	setAfterLookupCloseHandler(PickerField.AfterLookupCloseHandler afterLookupCloseHandler)
void	setAfterLookupSelectionHandler(PickerField.AfterLookupSelectionHandler afterLookupSelectionHandler)
void	setLookupScreen(java.lang.String lookupScreen) Set the lookup screen ID explicitly.
void	setLookupScreenDialogParams(DialogParams lookupScreenDialogParams) Deprecated. Use #setLookupScreenOpenType(OpenType)
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

setEditable

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

Field Detail

NAME

public static final java.lang.String NAME

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

getLookupScreenDialogParams

@Deprecated
 @Nullable
public DialogParams getLookupScreenDialogParams()

Deprecated.

setLookupScreenDialogParams

@Deprecated
public void setLookupScreenDialogParams(DialogParams lookupScreenDialogParams)

Deprecated. Use #setLookupScreenOpenType(OpenType)

Set lookup screen geometry when opening it in WindowManager.OpenType.DIALOG mode. Doesn't affect other modes.

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

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)