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

Annotation Type UILink

@Retention(RUNTIME)
@Target(METHOD)
@LinkkiBoundProperty(org.linkki.core.binding.descriptor.property.annotation.BoundPropertyCreator.SimpleMemberNameBoundPropertyCreator.class)
@LinkkiAspect(LinkAspectDefinitionCreator.class)
public @interface UILink

Provides a single UI-element to display a link. Creates an Anchor.

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	Static text displayed on the link.
CaptionType	captionType	Defines how the value of caption should be retrieved, using values of CaptionType.
IconPosition	iconPosition	Specifies the position of the icon, whether it is displayed on the left or on the right side of the link.
String	label	Provides a label for the link.
String	target	Specifies where to open the link.
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 for the link. Normally a link does not need a label. The label stands next to the component and depends on the current layout (may not be visible in every layout). In tables the label is used for the column header.

Default:

""

visible

VisibleType visible

Specifies if a component is shown, using values of VisibleType

Default:

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

caption

String caption

Static text displayed on the link. If the value should be determined dynamically either let caption be empty or set captionType() to CaptionType.DYNAMIC explicitly. In this case a method named get<PropertyName>Caption is called.

Default:

""

captionType

CaptionType captionType

Defines how the value of caption should be retrieved, using values of CaptionType.

In case of CaptionType.DYNAMIC or CaptionType.AUTO with empty caption() a method named get<PropertyName>Caption is called.

Default:

org.linkki.core.defaults.ui.aspects.types.CaptionType.AUTO

target

String target

Specifies where to open the link. Might be one of UILink.LinkTarget or a specific frame.

To define a dynamic link use UILink.LinkTarget.DYNAMIC and implement a method called get<PropertyName>Target

Default:

"_self"

iconPosition

IconPosition iconPosition

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

Default:

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