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

Annotation Type UILabel

@Retention(RUNTIME)
@Target(METHOD)
@LinkkiBoundProperty
@LinkkiAspect(LabelAspectDefinitionCreator.class)
public @interface UILabel

Provides a single UI-element to display text content. Creates a Div.

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
boolean	htmlContent	When set to true, the label's content will be displayed as HTML, otherwise as plain text.
IconPosition	iconPosition	Specifies the position of the icon, whether it is displayed on the left or on the right side of the label.
Class<? extends ItemCaptionProvider<?>>	itemCaptionProvider	Specifies which ItemCaptionProvider should be used to convert the value into a String.
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
String[]	styleNames	Defines a list of CSS class names that are added to the created UI component.
VisibleType	visible	Specifies if a component is shown, using values of VisibleType

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:

""

visible

VisibleType visible

Specifies if a component is shown, using values of VisibleType

Default:

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

iconPosition

IconPosition iconPosition

Specifies the position of the icon, whether it is displayed on the left or on the right side of the label.

Default:

org.linkki.core.ui.aspects.types.IconPosition.LEFT

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:

""

styleNames

String[] styleNames

Defines a list of CSS class names that are added to the created UI component.

Default:

{}

htmlContent

boolean htmlContent

When set to true, the label's content will be displayed as HTML, otherwise as plain text. The HTML content is automatically sanitized.
Note that user-supplied strings have to be escaped when including them in the HTML content. Otherwise, they will also be interpreted as HTML.

HTML content is not compatible with some annotations that manipulate the resulting component, like BindIcon.

Default:

false

itemCaptionProvider

Class<? extends ItemCaptionProvider<?>> itemCaptionProvider

Specifies which ItemCaptionProvider should be used to convert the value into a String.

For enum values, getName method is used if the enum class provides such a method.

See Also:

ItemCaptionProvider.DefaultCaptionProvider

Default:

org.linkki.core.ui.element.annotation.UILabel.DefaultLabelCaptionProvider.class