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

Annotation Type UICustomField

@Retention(RUNTIME)
@Target(METHOD)
@LinkkiBoundProperty
@LinkkiAspect(CustomFieldAspectCreator.class)
public @interface UICustomField

UICustomField can include other, more individual controls. The property uiControl() selects the control class. If that class inherits HasListDataView the values can be included from AvailableValuesType.

UICustomField only supports controls which define an constructor without parameters.

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
Class<? extends com.vaadin.flow.component.Component>	uiControl	The class implementing the custom field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
AvailableValuesType	content	Specifies the source of the available values, the content of the custom field if it supports a content.
EnabledType	enabled	Defines if an UI-Component is editable, using values of EnabledType
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	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 using a number and a CSS unit, for example "5em" or "50%".

Element Detail

position

int position

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

uiControl

Class<? extends com.vaadin.flow.component.Component> uiControl

The class implementing the custom field. This class has to have a default constructor.

label

String label

Provides a description label next to the UI-Element

Default:

"derived.by.linkki"

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:

""

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

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 using a number and a CSS unit, for example "5em" or "50%".

This value is set to empty String by default which means it is undefined and the actual width depends on the layout.

See Also:

HasSize.setWidth(String)

Default:

""

content

AvailableValuesType content

Specifies the source of the available values, the content of the custom field if it supports a content. May be a list of selectable items.

See Also:

AvailableValuesType

Default:

org.linkki.core.defaults.ui.aspects.types.AvailableValuesType.ENUM_VALUES_INCL_NULL