Package org.linkki.core.ui.element.annotation

Annotation Type UIMultiSelect

@Retention(RUNTIME)
@Target(METHOD)
@LinkkiBoundProperty
@LinkkiAspect(MultiSelectAspectCreator.class)
public @interface UIMultiSelect

Creates a MultiSelectComboBox that allows the selection of multiple values with the specified parameters.

Setter and getter require a return type of Set<VALUE_TYPE>. Because of that there is no ordering guarantee for the selected values.

Unlike the content of a UIComboBox, the content of a UIMultiSelect is set to AvailableValuesType.DYNAMIC and therefore a method get[PropertyName]AvailableValues() is always required. The type of this method can any kind of Collection. But keep in mind that some sub-types of Collection do not provide any ordering guarantees.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
int	position	Mandatory attribute that defines the order in which UI-Elements are displayed

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
EnabledType	enabled	Defines if an UI-Component is editable, using values of EnabledType
Class<? extends ItemCaptionProvider<?>>	itemCaptionProvider	Specifies which ItemCaptionProvider should be used to convert the values into String captions.
String	label	Provides a description label next to the UI element
String	modelAttribute	The name of a property in the class of the bound ModelObject to use model binding
String	modelObject	Name of the model object that is to be bound if multiple model objects are included for model binding
RequiredType	required	Marks mandatory fields visually
VisibleType	visible	Specifies if a component is shown, using values of VisibleType
String	width	Specifies the width of the field.

Element Detail

position

int position

Mandatory attribute that defines the order in which UI-Elements are displayed

label

String label

Provides a description label next to the UI element

Default:

"derived.by.linkki"

enabled

EnabledType enabled

Defines if an UI-Component is editable, using values of EnabledType

Default:

org.linkki.core.defaults.ui.aspects.types.EnabledType.ENABLED

required

RequiredType required

Marks mandatory fields visually

Default:

org.linkki.core.defaults.ui.aspects.types.RequiredType.NOT_REQUIRED

visible

VisibleType visible

Specifies if a component is shown, using values of VisibleType

Default:

org.linkki.core.defaults.ui.aspects.types.VisibleType.VISIBLE

width

String width

Specifies the width of the field. Use CSS units like em, px or %.

For example: "25em" or "100%".

Default:

"-1px"

modelObject

String modelObject

Name of the model object that is to be bound if multiple model objects are included for model binding

Default:

"modelObject"

modelAttribute

String modelAttribute

The name of a property in the class of the bound ModelObject to use model binding

Default:

""

itemCaptionProvider

Class<? extends ItemCaptionProvider<?>> itemCaptionProvider

Specifies which ItemCaptionProvider should be used to convert the values into String captions.

Default value assumes that the value class has a method "getName" and uses this method for the String representation.

Default:

org.linkki.core.defaults.ui.element.ItemCaptionProvider.DefaultCaptionProvider.class