io.jmix.ui.action

Class AbstractLookupAction<E>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.AbstractLookupAction<E>

Type Parameters:

E - type of entity

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.ScreenOpeningAction, Action.SecuredAction

Direct Known Subclasses:

EntityLookupAction, TagLookupAction

public abstract class AbstractLookupAction<E>
extends BaseAction
implements Action.ScreenOpeningAction

Base class for actions that should open a screen.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected Icons	icons
protected io.jmix.core.Messages	messages
protected ScreenBuilders	screenBuilders
protected ActionScreenInitializer	screenInitializer
protected java.util.function.Predicate<LookupScreen.ValidationContext<E>>	selectValidator
protected java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>>	transformation

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
AbstractLookupAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
OpenMode	getOpenMode() Returns the lookup screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML.
java.lang.Class<? extends Screen>	getScreenClass() Returns the lookup screen class if it was set by setScreenClass(Class) or in the screen XML.
java.lang.String	getScreenId() Returns the lookup screen id if it was set by setScreenId(String) or in the screen XML.
void	setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler) Sets the handler to be invoked when the lookup screen closes.
protected void	setIcons(Icons icons)
protected void	setMessages(io.jmix.core.Messages messages)
void	setOpenMode(OpenMode openMode) Sets the lookup screen open mode.
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setScreenClass(java.lang.Class<? extends Screen> screenClass) Sets the lookup screen id.
void	setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer) Sets the lookup screen configurer.
void	setScreenId(java.lang.String screenId) Sets the lookup screen id.
void	setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier) Sets the lookup screen options supplier.
void	setSelectValidator(java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator) Sets the validator to be invoked when the user selects entities in the lookup screen.
void	setTransformation(java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation) Sets the function to transform selected in the lookup screen entities.

Methods inherited from class io.jmix.ui.action.BaseAction

actionPerform, 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 io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, 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 io.jmix.ui.action.Action

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

Field Detail

screenBuilders

protected ScreenBuilders screenBuilders

icons

protected Icons icons

messages

protected io.jmix.core.Messages messages

screenInitializer

protected ActionScreenInitializer screenInitializer

selectValidator

protected java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator

transformation

protected java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation

Constructor Detail

AbstractLookupAction

public AbstractLookupAction(java.lang.String id)

Method Detail

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setIcons

@Autowired
protected void setIcons(Icons icons)

setMessages

@Autowired
protected void setMessages(io.jmix.core.Messages messages)

getOpenMode

@Nullable
public OpenMode getOpenMode()

Returns the lookup screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML. Otherwise returns null.

Specified by:

getOpenMode in interface Action.ScreenOpeningAction

setOpenMode

@StudioPropertiesItem
public void setOpenMode(@Nullable
                                              OpenMode openMode)

Sets the lookup screen open mode.

Specified by:

setOpenMode in interface Action.ScreenOpeningAction

Parameters:

openMode - the open mode to set

getScreenId

@Nullable
public java.lang.String getScreenId()

Returns the lookup screen id if it was set by setScreenId(String) or in the screen XML. Otherwise returns null.

Specified by:

getScreenId in interface Action.ScreenOpeningAction

setScreenId

@StudioPropertiesItem
public void setScreenId(@Nullable
                                              java.lang.String screenId)

Sets the lookup screen id.

Specified by:

setScreenId in interface Action.ScreenOpeningAction

Parameters:

screenId - the screen id to set

getScreenClass

@Nullable
public java.lang.Class<? extends Screen> getScreenClass()

Returns the lookup screen class if it was set by setScreenClass(Class) or in the screen XML. Otherwise returns null.

Specified by:

getScreenClass in interface Action.ScreenOpeningAction

setScreenClass

@StudioPropertiesItem
public void setScreenClass(@Nullable
                                                 java.lang.Class<? extends Screen> screenClass)

Sets the lookup screen id.

Specified by:

setScreenClass in interface Action.ScreenOpeningAction

Parameters:

screenClass - the screen class to set

setScreenOptionsSupplier

public void setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier)

Sets the lookup screen options supplier. The supplier provides ScreenOptions to the opened screen.

The preferred way to set the supplier is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.lookup", subject = "screenOptionsSupplier")
 protected ScreenOptions petFieldLookupScreenOptionsSupplier() {
     return new MapScreenOptions(ParamsMap.of("someParameter", 10));
 }
 

Specified by:

setScreenOptionsSupplier in interface Action.ScreenOpeningAction

setScreenConfigurer

public void setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer)

Sets the lookup screen configurer. Use the configurer if you need to provide parameters to the opened screen through setters.

The preferred way to set the configurer is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.lookup", subject = "screenConfigurer")
 protected void petFieldLookupScreenConfigurer(Screen lookupScreen) {
     ((PetBrowse) lookupScreen).setSomeParameter(someValue);
 }
 

Specified by:

setScreenConfigurer in interface Action.ScreenOpeningAction

setAfterCloseHandler

public void setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler)

Sets the handler to be invoked when the lookup screen closes.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.lookup", subject = "afterCloseHandler")
 protected void petFieldLookupAfterCloseHandler(AfterCloseEvent event) {
     CloseAction closeAction = event.getCloseAction();
     System.out.println("Closed with " + closeAction);
 }
 

Specified by:

setAfterCloseHandler in interface Action.ScreenOpeningAction

setSelectValidator

public void setSelectValidator(java.util.function.Predicate<LookupScreen.ValidationContext<E>> selectValidator)

Sets the validator to be invoked when the user selects entities in the lookup screen.

The preferred way to set the validator is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.lookup", subject = "selectValidator")
 protected void petFieldLookupSelectValidator(LookupScreen.ValidationContext<Pet> context) {
     return checkSelected(context.getSelectedItems());
 }
 

setTransformation

public void setTransformation(java.util.function.Function<java.util.Collection<E>,java.util.Collection<E>> transformation)

Sets the function to transform selected in the lookup screen entities.

The preferred way to set the function is using a controller method annotated with Install, e.g.:

 @Install(to = "petField.lookup", subject = "transformation")
 protected Collection<Pet> petFieldLookupTransformation(Collection<Pet> entities) {
     return doTransform(entities);
 }