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

Annotation Type UICheckBox

@Retention(RUNTIME)
@Target(METHOD)
@LinkkiBoundProperty
@LinkkiAspect(CheckBoxAspectCreator.class)
public @interface UICheckBox

In accordance to Checkbox, bound to a boolean property.

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
String	caption	Provides a caption on the right side of the check box.
EnabledType	enabled	Defines if an UI-Component is editable, using values of EnabledType.
String	label	Provides a label on the left side of the check box.
String	modelAttribute	The name of a property in the class of the bound ModelObject to use model binding.
String	modelObject	The 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

Element Detail

position

int position

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

label

String label

Provides a label on the left side of the check box.

Normally a check box does not have a label on the left side but a caption() which rests on the right side of the box.

Default:

""

caption

String caption

Provides a caption on the right side of the check box.

Use an empty String as caption if no caption is needed.

For a label on the left, use label() for the label text.

If the check box is used inside a UITableColumn, the label() will be displayed in the column header while the caption() will be displayed inside the table cell together with the check box.

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

modelObject

String modelObject

The 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:

""