Package org.linkki.core.ui.bind.annotation

Annotation Type Bind

@Retention(RUNTIME)
@Target({FIELD,METHOD})
@LinkkiBoundProperty(BindAnnotationBoundPropertyCreator.class)
@LinkkiAspect(BindAnnotationAspectDefinitionCreator.class)
public @interface Bind

This annotation is used to bind manually created components with a PMO and optionally a model object. It is used to manually create UI layouts where linkki @UI... annotations do not give the necessary flexibility. To still keep the linkki binding it is possible to annotate the created field components using this annotation. Afterwards just call Binder.setupBindings(org.linkki.core.binding.BindingContext) to bring the UI and the model together.

See Also:

Binder

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
AvailableValuesType	availableValues	If and how the available values are bound to the PMO.
EnabledType	enabled	If and how the enabled state of the UI element is bound to the PMO.
String	modelAttribute	Name of the model object's attribute that is bound to this component.
String	modelObject	The name of the ModelObject this component is bound to, by default ModelObject.DEFAULT_NAME.
String	pmoProperty	The name of the PMO's property to which the UI element is bound.
RequiredType	required	If and how the required state of the UI element is bound to the PMO.
VisibleType	visible	If and how the visible state of the UI element is bound to the PMO.

Element Detail

pmoProperty

String pmoProperty

The name of the PMO's property to which the UI element is bound. If it is empty (default) the property name is derived from the annotated element, that means:

• in case of a field it is the field name
• it case of a getter method it is the method name without is/get
• otherwise it is the full name of the annotated method

Note that for each aspect, the pmoProperty() is evaluated before modelAttribute(). That means if an aspect method can be found with the defined pmoProperty() in the PMO, that method is used. If no method can be found in the PMO, the modelAttribute() is then used to find the method in the modelObject(). If no modelAttribute() is defined, pmoProperty() is used to find the method in the modelObject().

Default:

""

modelObject

String modelObject

The name of the ModelObject this component is bound to, by default ModelObject.DEFAULT_NAME.

Default:

"modelObject"

modelAttribute

String modelAttribute

Name of the model object's attribute that is bound to this component. If none is specified, pmoProperty() is used.

Default:

""

enabled

EnabledType enabled

If and how the enabled state of the UI element is bound to the PMO.

Default:

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

visible

VisibleType visible

If and how the visible state of the UI element is bound to the PMO.

Default:

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

required

RequiredType required

If and how the required state of the UI element is bound to the PMO. Ignored for UI elements that cannot be required, e.g. buttons.

Default:

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

availableValues

AvailableValuesType availableValues

If and how the available values are bound to the PMO. Relevant only for UI elements that have available values (e.g. combo boxes), ignored for all other elements.

Default:

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