Package io.jmix.ui.action.valuespicker

Class ValuesSelectAction<V>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.valuespicker.ValuesSelectAction<V>

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.SecuredAction, ValuePicker.ValuePickerAction, org.springframework.beans.factory.InitializingBean

@StudioAction(target="io.jmix.ui.component.ValuesPicker",
              description="Sets a value to the values picker using the selection screen")
@ActionType("values_select")
public class ValuesSelectAction<V>
extends BaseAction
implements ValuePicker.ValuePickerAction, org.springframework.beans.factory.InitializingBean, Action.ExecutableAction

Standard values picker action for selection the field value.

Should be defined for ValuesPicker or its subclass in a screen XML descriptor.

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	Description
protected UiComponentProperties	componentProperties
static final String	DEFAULT_SELECT_VALUE_SCREEN
protected boolean	editable
protected Icons	icons
static final String	ID
protected Messages	messages
protected ScreenBuilders	screenBuilders
protected ActionScreenInitializer	screenInitializer
protected SelectValueController.SelectValueContext<V>	selectValueContext
protected ValuesPicker<V>	valuesPicker

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

Fields inherited from interface io.jmix.ui.component.ValuePicker.ValuePickerAction

PROP_EDITABLE

Constructor Summary

Constructors

Constructor	Description
ValuesSelectAction()
ValuesSelectAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
void	addValidator(Validator<V> validator)	Adds validator which is used in SelectValueController screen to validate component values.
void	afterPropertiesSet()
void	editableChanged(boolean editable)	Called by ValuePicker to inform about its editable state.
void	execute()	Executes the action.
String	getEntityName()
Class<? extends Enum>	getEnumClass()
Class<?>	getJavaClass()
String	getLookupScreenId()
Function<V,String>	getOptionCaptionProvider()
Options<V>	getOptions()
DateField.Resolution	getResolution()
Class	getSelectValueScreenClass()	Returns the class of SelectValueController screen if it was set by setSelectValueScreenId(String) or in the screen XML.
String	getSelectValueScreenId()	Returns the id of SelectValueController screen if it was set by setSelectValueScreenId(String) or in the screen XML.
TimeZone	getTimeZone()
List<Validator<V>>	getValidators()
protected void	initSelectValueComponentValueType(EntityValueSource<?,?> valueSource)
boolean	isEditable()
boolean	isUseComboBox()
protected void	setEditable(boolean editable)
void	setEntityName(String entityName)	Sets the entity name which is used as the component value type in SelectValueController screen.
void	setEnumClass(Class<? extends Enum> enumClass)	Sets the enumeration class which is used as the component value type in SelectValueController screen.
protected void	setIcons(Icons icons)
void	setJavaClass(Class<?> javaClass)	Sets the java class which is used as the component value type in SelectValueController screen.
void	setLookupScreenId(String lookupScreenId)	Sets the lookup screen id to be passed into SelectValueController screen.
protected void	setMessages(Messages messages)
void	setOptionCaptionProvider(Function<V,String> optionCaptionProvider)	Sets function that provides caption for option items.
void	setOptions(Options<V> options)	Sets options which are used in SelectValueController screen.
void	setPicker(ValuePicker valuePicker)	Sets a ValuePicker instance associated with this action.
void	setResolution(DateField.Resolution resolution)	Sets the resolution of DateField component.
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setSelectValueScreenClass(Class selectValueScreenClass)	Sets the class of SelectValueController screen.
void	setSelectValueScreenId(String selectValueScreenId)	Sets the id of SelectValueController screen.
void	setTimeZone(TimeZone timeZone)	Sets the time zone of DateField component.
protected void	setUiComponentProperties(UiComponentProperties componentProperties)
void	setUseComboBox(boolean useComboBox)	Sets whether the ComboBox should be used in SelectValueController screen.
void	setValidators(List<Validator<V>> validators)	Sets the collection of Validator's which are used in SelectValueController screen to validate component values.

Methods inherited from class io.jmix.ui.action.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 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, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DEFAULT_SELECT_VALUE_SCREEN

public static final String DEFAULT_SELECT_VALUE_SCREEN

See Also:

• Constant Field Values

valuesPicker

protected ValuesPicker<V> valuesPicker

icons

protected Icons icons

messages

protected Messages messages

componentProperties

protected UiComponentProperties componentProperties

screenBuilders

protected ScreenBuilders screenBuilders

editable

protected boolean editable

screenInitializer

protected ActionScreenInitializer screenInitializer

selectValueContext

protected SelectValueController.SelectValueContext<V> selectValueContext

Constructor Details

ValuesSelectAction

public ValuesSelectAction()

ValuesSelectAction

public ValuesSelectAction(String id)

Method Details

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties componentProperties)

setMessages

@Autowired
protected void setMessages(Messages messages)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setIcons

@Autowired
protected void setIcons(Icons icons)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

setPicker

public void setPicker(@Nullable
 ValuePicker valuePicker)

Description copied from interface: ValuePicker.ValuePickerAction

Sets a ValuePicker instance associated with this action.

Specified by:

setPicker in interface ValuePicker.ValuePickerAction

Parameters:

valuePicker - a ValuePicker instance to set

editableChanged

public void editableChanged(boolean editable)

Description copied from interface: ValuePicker.ValuePickerAction

Called by ValuePicker to inform about its editable state.

Specified by:

editableChanged in interface ValuePicker.ValuePickerAction

Parameters:

editable - a ValuePicker editable state

isEditable

public boolean isEditable()

Specified by:

isEditable in interface ValuePicker.ValuePickerAction

Returns:

whether this action is editable

setEditable

protected void setEditable(boolean editable)

getSelectValueScreenId

public String getSelectValueScreenId()

Returns the id of SelectValueController screen if it was set by setSelectValueScreenId(String) or in the screen XML.

Returns:

the id of SelectValueController screen

setSelectValueScreenId

@StudioPropertiesItem(type=SCREEN_ID,
                      defaultValue="selectValueDialog",
                      options="io.jmix.ui.app.valuespicker.selectvalue.SelectValueController")
public void setSelectValueScreenId(String selectValueScreenId)

Sets the id of SelectValueController screen.

Parameters:

selectValueScreenId - the id of SelectValueController screen

getSelectValueScreenClass

@Nullable
public Class getSelectValueScreenClass()

Returns the class of SelectValueController screen if it was set by setSelectValueScreenId(String) or in the screen XML. Otherwise returns null.

Returns:

the class of SelectValueController screen

setSelectValueScreenClass

@StudioPropertiesItem
public void setSelectValueScreenClass(Class selectValueScreenClass)

Sets the class of SelectValueController screen.

Parameters:

selectValueScreenClass - the class of SelectValueController screen

getLookupScreenId

@Nullable
public String getLookupScreenId()

Returns:

the lookup screen id

setLookupScreenId

@StudioPropertiesItem(type=SCREEN_ID,
                      options="io.jmix.ui.screen.LookupScreen")
public void setLookupScreenId(@Nullable
 String lookupScreenId)

Sets the lookup screen id to be passed into SelectValueController screen.

Parameters:

lookupScreenId - the lookup screen id

getEntityName

@Nullable
public String getEntityName()

Returns:

the entity name which is used as the component value type

setEntityName

@StudioPropertiesItem(type=ENTITY_NAME)
public void setEntityName(@Nullable
 String entityName)

Sets the entity name which is used as the component value type in SelectValueController screen.

Parameters:

entityName - the entity name which is used as the component value type

getJavaClass

@Nullable
public Class<?> getJavaClass()

Returns:

the java class which is used as the component value type

setJavaClass

@StudioPropertiesItem(type=JAVA_CLASS_NAME)
public void setJavaClass(@Nullable
 Class<?> javaClass)

Sets the java class which is used as the component value type in SelectValueController screen.

Parameters:

javaClass - the java class which is used as the component value type

getEnumClass

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

Returns:

the enumeration class which is used as the component value type

setEnumClass

@StudioPropertiesItem(type=JAVA_CLASS_NAME)
public void setEnumClass(@Nullable
 Class<? extends Enum> enumClass)

Sets the enumeration class which is used as the component value type in SelectValueController screen.

Parameters:

enumClass - the enumeration class which is used as the component value type

isUseComboBox

public boolean isUseComboBox()

Returns:

whether or not the ComboBox should be used in SelectValueController screen

setUseComboBox

@StudioPropertiesItem(type=BOOLEAN,
                      defaultValue="false")
public void setUseComboBox(boolean useComboBox)

Sets whether the ComboBox should be used in SelectValueController screen.

Parameters:

useComboBox - whether the ComboBox should be used in SelectValueController screen

getResolution

@Nullable
public DateField.Resolution getResolution()

Returns:

the resolution of DateField

setResolution

@StudioPropertiesItem(type=ENUMERATION)
public void setResolution(@Nullable
 DateField.Resolution resolution)

Sets the resolution of DateField component. The DateField component is used to select values which have date value type. The component is used in SelectValueController screen.

Parameters:

resolution - the resolution of DateField

getTimeZone

@Nullable
public TimeZone getTimeZone()

Returns:

the time zone of DateField

setTimeZone

public void setTimeZone(@Nullable
 TimeZone timeZone)

Sets the time zone of DateField component. The DateField component is used to select values which have date value type. The component is used in SelectValueController screen.

Parameters:

timeZone - the time zone of DateField

getOptions

@Nullable
public Options<V> getOptions()

Returns:

options

setOptions

public void setOptions(@Nullable
 Options<V> options)

Sets options which are used in SelectValueController screen.

Parameters:

options - options

getOptionCaptionProvider

@Nullable
public Function<V,String> getOptionCaptionProvider()

Returns:

caption provider for options

setOptionCaptionProvider

public void setOptionCaptionProvider(@Nullable
 Function<V,String> optionCaptionProvider)

Sets function that provides caption for option items.

Parameters:

optionCaptionProvider - caption provider for options

getValidators

public List<Validator<V>> getValidators()

Returns:

the collection of validators

setValidators

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

Sets the collection of Validator's which are used in SelectValueController screen to validate component values.

Parameters:

validators - the collection of validators

addValidator

public void addValidator(Validator<V> validator)

Adds validator which is used in SelectValueController screen to validate component values.

Parameters:

validator - validator

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction

initSelectValueComponentValueType

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