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

Annotation Type UIButton

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

Marks a method which is carried out when the UIButton is clicked.

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 button.
CaptionType	captionType	Defines how the value of caption should be retrieved, using values of CaptionType.
EnabledType	enabled	Defines if an UI-Component is editable, using values of EnabledType
com.vaadin.flow.component.icon.VaadinIcon	icon	Defines the button's icon, using constants in VaadinIcon
String	label	Provides a description label next to the button
String[]	shortcutKeyCode	Set a short cut for the button.
com.vaadin.flow.component.KeyModifier[]	shortcutKeyModifiers	Set a modifier for the short cut.
boolean	showIcon	If true, the button will be displayed with the defined icon()
com.vaadin.flow.component.button.ButtonVariant[]	variants	Defines the look of the button.
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 button

Default:

""

caption

String caption

Static text displayed on the button. If the value should be determined dynamically, use CaptionType.DYNAMIC instead and ignore this attribute.

Default:

"derived.by.linkki"

captionType

CaptionType captionType

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

Despite in other annotations like BindCaption the default here is CaptionType.STATIC (and NOT CaptionType.AUTO because it is a common use case to have a button with only an icon but no caption.

Default:

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

enabled

EnabledType enabled

Defines if an UI-Component is editable, using values of EnabledType

Default:

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

visible

VisibleType visible

Specifies if a component is shown, using values of VisibleType

Default:

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

icon

com.vaadin.flow.component.icon.VaadinIcon icon

Defines the button's icon, using constants in VaadinIcon

Default:

com.vaadin.flow.component.icon.VaadinIcon.PLUS

showIcon

boolean showIcon

If true, the button will be displayed with the defined icon()

Default:

false

variants

com.vaadin.flow.component.button.ButtonVariant[] variants

Defines the look of the button. The most common variants are:

• ButtonVariant.LUMO_PRIMARY for primary buttons
• ButtonVariant.LUMO_TERTIARY_INLINE for inline buttons (no background)

See Also:

ButtonVariant

Default:

{}

shortcutKeyCode

String[] shortcutKeyCode

Set a short cut for the button. Commonly used values are defined in KeyCode. Consult Key to look up all possible values.

Default:

{}

shortcutKeyModifiers

com.vaadin.flow.component.KeyModifier[] shortcutKeyModifiers

Set a modifier for the short cut. Only useful in combination with a shortcutKeyCode(). Use constants from KeyModifier.

Default:

{}