Package io.jmix.flowui.action.multivaluepicker

Class MultiValueSelectAction<E>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.valuepicker.PickerAction<MultiValueSelectAction<E>,PickerComponent<Collection<E>>,Collection<E>>

io.jmix.flowui.action.multivaluepicker.MultiValueSelectAction<E>

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<PickerComponent<Collection<E>>>, ViewOpeningAction, Action, HasShortcutCombination, org.springframework.beans.factory.InitializingBean

@ActionType("multi_value_select")
public class MultiValueSelectAction<E>
extends PickerAction<MultiValueSelectAction<E>,PickerComponent<Collection<E>>,Collection<E>>
implements org.springframework.beans.factory.InitializingBean, ViewOpeningAction

Standard multi value select action for selection the field value.

Should be defined for JmixMultiValuePicker or its subclass

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.flowui.action.ViewOpeningAction

ViewOpeningAction.QueryParametersProvider, ViewOpeningAction.RouteParametersProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MULTI_VALUE_SELECT_VIEW
protected DialogWindows	dialogWindows
static final String	ID
protected Messages	messages
protected MultiValueSelectView.MultiValueSelectContext<E>	multiValueSelectContext
protected boolean	readOnly
protected UiComponentProperties	uiComponentProperties
protected ActionViewInitializer	viewInitializer

Fields inherited from class io.jmix.flowui.action.valuepicker.PickerAction

target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledByUiPermissions, enabledRules, visibleByUiPermissions

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
MultiValueSelectAction()
MultiValueSelectAction(String id)

Method Summary

Modifier and Type	Method	Description
void	addValidator(Validator<E> validator)
void	afterPropertiesSet()
void	execute()	Executes the Action
<V extends View<?>> Consumer<DialogWindow.AfterCloseEvent<V>>	getAfterCloseHandler()
String	getEntityName()
Class<? extends Enum<?>>	getEnumClass()
com.vaadin.flow.component.ItemLabelGenerator<E>	getItemLabelGenerator()
com.vaadin.flow.data.provider.DataProvider<?,?>	getItems()
Class<?>	getJavaClass()
String	getLookupViewId()
OpenMode	getOpenMode()	Returns the view open mode if it was set by ViewOpeningAction.setOpenMode(OpenMode) or in the view XML, otherwise returns null.
ViewOpeningAction.QueryParametersProvider	getQueryParametersProvider()
ViewOpeningAction.RouteParametersProvider	getRouteParametersProvider()
TimeZone	getTimeZone()
List<Validator<E>>	getValidators()
Class<? extends View>	getViewClass()	Returns the view class if it was set by ViewOpeningAction.setViewClass(Class) or in the view XML, otherwise returns null.
<V extends View<?>> Consumer<V>	getViewConfigurer()
String	getViewId()	Returns the view id if it was set by ViewOpeningAction.setViewId(String) or in the view XML, otherwise returns null.
protected void	initAction()
protected void	initMultiValuePickerComponentValueType(EntityValueSource<?,?> valueSource)
boolean	isReadOnly()
boolean	isUseComboBox()
<V extends View<?>> void	setAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)	Sets the handler to be invoked when the detail view closes.
void	setDialogWindows(DialogWindows dialogWindows)
void	setEntityName(String entityName)
void	setEnumClass(Class<? extends Enum<?>> enumClass)
void	setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<E> itemLabelGenerator)
void	setItems(com.vaadin.flow.data.provider.DataProvider<?,?> items)
void	setJavaClass(Class<?> javaClass)
void	setLookupViewId(String lookupViewId)
protected void	setMessages(Messages messages)
void	setOpenMode(OpenMode openMode)	Sets the view open mode.
void	setQueryParametersProvider(ViewOpeningAction.QueryParametersProvider provider)	Sets query parameters provider that returns query parameters that should be used in the URL.
protected void	setReadOnly(boolean readOnly)
void	setRouteParametersProvider(ViewOpeningAction.RouteParametersProvider provider)	Sets route parameters provider that returns route parameters that should be used in the route template.
void	setTimeZone(TimeZone timeZone)
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
void	setUseComboBox(boolean useComboBox)
void	setValidators(List<Validator<E>> validators)
void	setViewClass(Class<? extends View> viewClass)	Sets the view class.
<V extends View<?>> void	setViewConfigurer(Consumer<V> viewConfigurer)	Sets the view configurer.
void	setViewId(String viewId)	Sets the view id.
<V extends View<?>> MultiValueSelectAction<E>	withAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)
MultiValueSelectAction<E>	withEntityName(String entityName)
MultiValueSelectAction<E>	withEnumClass(Class<? extends Enum<?>> enumClass)
MultiValueSelectAction<E>	withItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<E> itemLabelGenerator)
MultiValueSelectAction<E>	withItems(com.vaadin.flow.data.provider.DataProvider<?,?> items)
MultiValueSelectAction<E>	withJavaClass(Class<?> javaClass)
MultiValueSelectAction<E>	withLookupViewId(String lookupViewId)
MultiValueSelectAction<E>	withReadOnly(boolean readOnly)
MultiValueSelectAction<E>	withTimeZone(TimeZone timeZone)
MultiValueSelectAction<E>	withUseComboBox(boolean useComboBox)
MultiValueSelectAction<E>	withValidators(List<Validator<E>> validators)
MultiValueSelectAction<E>	withViewClass(Class<? extends View> viewClass)
<V extends View<?>> MultiValueSelectAction<E>	withViewConfigurer(Consumer<V> viewConfigurer)
MultiValueSelectAction<E>	withViewId(String viewId)

Methods inherited from class io.jmix.flowui.action.valuepicker.PickerAction

actionPerform, checkTarget, getTarget, isApplicable, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, setEnabled, setEnabledInternal, setVisible, setVisibleInternal

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.flowui.kit.action.Action

actionPerform, addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DEFAULT_MULTI_VALUE_SELECT_VIEW

public static final String DEFAULT_MULTI_VALUE_SELECT_VIEW

See Also:

• Constant Field Values

messages

protected Messages messages

uiComponentProperties

protected UiComponentProperties uiComponentProperties

dialogWindows

protected DialogWindows dialogWindows

readOnly

protected boolean readOnly

viewInitializer

protected ActionViewInitializer viewInitializer

multiValueSelectContext

protected MultiValueSelectView.MultiValueSelectContext<E> multiValueSelectContext

Constructor Details

MultiValueSelectAction

public MultiValueSelectAction()

MultiValueSelectAction

public MultiValueSelectAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

initAction in class PickerAction<MultiValueSelectAction<E>,PickerComponent<Collection<E>>,Collection<E>>

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties uiComponentProperties)

setMessages

@Autowired
protected void setMessages(Messages messages)

setDialogWindows

@Autowired
public void setDialogWindows(DialogWindows dialogWindows)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

isReadOnly

public boolean isReadOnly()

setReadOnly

protected void setReadOnly(boolean readOnly)

getOpenMode

@Nullable
public OpenMode getOpenMode()

Description copied from interface: ViewOpeningAction

Returns the view open mode if it was set by ViewOpeningAction.setOpenMode(OpenMode) or in the view XML, otherwise returns null.

Specified by:

getOpenMode in interface ViewOpeningAction

setOpenMode

public void setOpenMode(@Nullable
 OpenMode openMode)

Description copied from interface: ViewOpeningAction

Sets the view open mode.

Specified by:

setOpenMode in interface ViewOpeningAction

Parameters:

openMode - the open mode to set

getViewId

public String getViewId()

Description copied from interface: ViewOpeningAction

Returns the view id if it was set by ViewOpeningAction.setViewId(String) or in the view XML, otherwise returns null.

Specified by:

getViewId in interface ViewOpeningAction

setViewId

public void setViewId(@Nullable
 String viewId)

Description copied from interface: ViewOpeningAction

Sets the view id.

Specified by:

setViewId in interface ViewOpeningAction

Parameters:

viewId - the view id to set

getViewClass

@Nullable
public Class<? extends View> getViewClass()

Description copied from interface: ViewOpeningAction

Returns the view class if it was set by ViewOpeningAction.setViewClass(Class) or in the view XML, otherwise returns null.

Specified by:

getViewClass in interface ViewOpeningAction

setViewClass

public void setViewClass(@Nullable
 Class<? extends View> viewClass)

Description copied from interface: ViewOpeningAction

Sets the view class.

Specified by:

setViewClass in interface ViewOpeningAction

Parameters:

viewClass - the view class to set

getRouteParametersProvider

@Nullable
public ViewOpeningAction.RouteParametersProvider getRouteParametersProvider()

Specified by:

getRouteParametersProvider in interface ViewOpeningAction

Returns:

route parameters or null if not set

setRouteParametersProvider

public void setRouteParametersProvider(@Nullable
 ViewOpeningAction.RouteParametersProvider provider)

Description copied from interface: ViewOpeningAction

Sets route parameters provider that returns route parameters that should be used in the route template.

Note that route parameters provider is set if the detail is opened in OpenMode.NAVIGATION.

Specified by:

setRouteParametersProvider in interface ViewOpeningAction

Parameters:

provider - route parameters provider to set

See Also:

• Route

getQueryParametersProvider

@Nullable
public ViewOpeningAction.QueryParametersProvider getQueryParametersProvider()

Specified by:

getQueryParametersProvider in interface ViewOpeningAction

Returns:

query parameters provider or null if not set

setQueryParametersProvider

public void setQueryParametersProvider(@Nullable
 ViewOpeningAction.QueryParametersProvider provider)

Description copied from interface: ViewOpeningAction

Sets query parameters provider that returns query parameters that should be used in the URL.

Note that query parameters provider is set if the detail is opened in OpenMode.NAVIGATION.

Specified by:

setQueryParametersProvider in interface ViewOpeningAction

Parameters:

provider - query parameters provider to set

setAfterCloseHandler

public <V extends View<?>> void setAfterCloseHandler(@Nullable
 Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)

Description copied from interface: ViewOpeningAction

Sets the handler to be invoked when the detail view closes.

Note that handler is invoked if the detail is opened in OpenMode.DIALOG mode.

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

 @Install(to = "petsTable.view", subject = "afterCloseHandler")
 protected void petsTableViewAfterCloseHandler(AfterCloseEvent event) {
     if (event.closedWith(StandardOutcome.SAVE)) {
         System.out.println("Saved");
     }
 }
 

Specified by:

setAfterCloseHandler in interface ViewOpeningAction

Type Parameters:

V - view type

Parameters:

afterCloseHandler - handler to set

getAfterCloseHandler

public <V extends View<?>>
Consumer<DialogWindow.AfterCloseEvent<V>> getAfterCloseHandler()

Specified by:

getAfterCloseHandler in interface ViewOpeningAction

setViewConfigurer

public <V extends View<?>> void setViewConfigurer(@Nullable
 Consumer<V> viewConfigurer)

Description copied from interface: ViewOpeningAction

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

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

 @Install(to = "petsTable.view", subject = "viewConfigurer")
 protected void petsTableViewConfigurer(View<?> view) {
     view.setSomeParameter(someValue);
 }
 

Specified by:

setViewConfigurer in interface ViewOpeningAction

getViewConfigurer

public <V extends View<?>> Consumer<V> getViewConfigurer()

Specified by:

getViewConfigurer in interface ViewOpeningAction

getLookupViewId

@Nullable
public String getLookupViewId()

setLookupViewId

public void setLookupViewId(@Nullable
 String lookupViewId)

getEntityName

@Nullable
public String getEntityName()

setEntityName

public void setEntityName(@Nullable
 String entityName)

getJavaClass

@Nullable
public Class<?> getJavaClass()

setJavaClass

public void setJavaClass(@Nullable
 Class<?> javaClass)

getEnumClass

@Nullable
public Class<? extends Enum<?>> getEnumClass()

setEnumClass

public void setEnumClass(@Nullable
 Class<? extends Enum<?>> enumClass)

isUseComboBox

public boolean isUseComboBox()

setUseComboBox

public void setUseComboBox(boolean useComboBox)

getItems

@Nullable
public com.vaadin.flow.data.provider.DataProvider<?,?> getItems()

setItems

public void setItems(com.vaadin.flow.data.provider.DataProvider<?,?> items)

getTimeZone

@Nullable
public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(@Nullable
 TimeZone timeZone)

getItemLabelGenerator

@Nullable
public com.vaadin.flow.component.ItemLabelGenerator<E> getItemLabelGenerator()

setItemLabelGenerator

public void setItemLabelGenerator(@Nullable
 com.vaadin.flow.component.ItemLabelGenerator<E> itemLabelGenerator)

getValidators

public List<Validator<E>> getValidators()

setValidators

public void setValidators(@Nullable
 List<Validator<E>> validators)

addValidator

public void addValidator(Validator<E> validator)

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

withViewId

public MultiValueSelectAction<E> withViewId(@Nullable
 String viewId)

withViewClass

public MultiValueSelectAction<E> withViewClass(@Nullable
 Class<? extends View> viewClass)

withAfterCloseHandler

public <V extends View<?>>
MultiValueSelectAction<E> withAfterCloseHandler(@Nullable
 Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)

withViewConfigurer

public <V extends View<?>>
MultiValueSelectAction<E> withViewConfigurer(@Nullable
 Consumer<V> viewConfigurer)

See Also:

• setViewConfigurer(Consumer)

withValidators

public MultiValueSelectAction<E> withValidators(@Nullable
 List<Validator<E>> validators)

withEntityName

public MultiValueSelectAction<E> withEntityName(@Nullable
 String entityName)

withEnumClass

public MultiValueSelectAction<E> withEnumClass(@Nullable
 Class<? extends Enum<?>> enumClass)

withJavaClass

public MultiValueSelectAction<E> withJavaClass(@Nullable
 Class<?> javaClass)

withReadOnly

public MultiValueSelectAction<E> withReadOnly(boolean readOnly)

withLookupViewId

public MultiValueSelectAction<E> withLookupViewId(@Nullable
 String lookupViewId)

withUseComboBox

public MultiValueSelectAction<E> withUseComboBox(boolean useComboBox)

withItems

public MultiValueSelectAction<E> withItems(com.vaadin.flow.data.provider.DataProvider<?,?> items)

withItemLabelGenerator

public MultiValueSelectAction<E> withItemLabelGenerator(@Nullable
 com.vaadin.flow.component.ItemLabelGenerator<E> itemLabelGenerator)

withTimeZone

public MultiValueSelectAction<E> withTimeZone(@Nullable
 TimeZone timeZone)

initMultiValuePickerComponentValueType

protected void initMultiValuePickerComponentValueType(EntityValueSource<?,?> valueSource)