com.exadel.aem.toolkit.api.annotations.widgets.button

Annotation Type Button

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface Button

Used to set up Button component in Granite UI

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	actionConfigName When set to a non-blank string, maps to the actionConfigName attribute of this Granite UI dialog component's node.
boolean	active Maps to the active attribute of this Granite UI component's node.
String	autocomplete When set to a non-blank string, maps to the autocomplete attribute of this Granite UI component's node
boolean	block Maps to the block attribute of this Granite UI component's node.
String	command When set to a non-blank string, maps to the command attribute of this Granite UI dialog component's node.
boolean	disabled When set to true, maps to the disabled attribute of this Granite UI component's node.
String	formId When set to a non-blank string, maps to the formId attribute of this Granite UI component's node.
boolean	hideText Maps to the hideText attribute of this Granite UI component's node.
String	icon Maps to the icon attribute of this Granite UI component's node.
Size	iconSize When set to a non-blank string, maps to the iconSize attribute of this Granite UI component's node.
Size	size When set to a non-blank string, maps to the size attribute of this Granite UI component's node.
String	text When set to a non-blank string, maps to the text attribute of this Granite UI component's node.
String	textComment When set to a non-blank string, maps to the text_commentI18n attribute of this Granite UI component's node.
String	trackingElement When set to a non-blank string, maps to the trackingElement attribute of this Granite UI component's node.
String	trackingFeature When set to a non-blank string, maps to the trackingFeature attribute of this Granite UI dialog component's node.
ButtonType	type Maps to the type attribute of this Granite UI component's node.
ElementVariant	variant Maps to the variant attribute of this Granite UI dialog component's node.

Element Detail

actionConfigName

public abstract String actionConfigName

When set to a non-blank string, maps to the actionConfigName attribute of this Granite UI dialog component's node. Used to define standard definitions of command, icon, and text

Returns:

String value, non-blank

Default:

""

active

public abstract boolean active

Maps to the active attribute of this Granite UI component's node. Used to define the initial state of the button

Returns:

True or false

Default:

false

autocomplete

public abstract String autocomplete

When set to a non-blank string, maps to the autocomplete attribute of this Granite UI component's node

Returns:

String value

Default:

"off"

block

public abstract boolean block

Maps to the block attribute of this Granite UI component's node. Used to ensure the button is rendered as a block element

Returns:

True or false

Default:

false

command

public abstract String command

When set to a non-blank string, maps to the command attribute of this Granite UI dialog component's node. Used to define keyboard shortcut for the action. Overrides actionConfigName value

Returns:

String value, non-blank

Default:

""

disabled

public abstract boolean disabled

When set to true, maps to the disabled attribute of this Granite UI component's node. Defines that the current option is shown in the disabled state

Returns:

True or false

Default:

false

formId

public abstract String formId

When set to a non-blank string, maps to the formId attribute of this Granite UI component's node. Used to identify the form this button is bound to

Returns:

String value

Default:

""

hideText

public abstract boolean hideText

Maps to the hideText attribute of this Granite UI component's node. Used to define whether text is hidden

Returns:

True or false

Default:

false

icon

public abstract String icon

Maps to the icon attribute of this Granite UI component's node. Used to define the icon of the component. When set, overrides actionConfigName

Returns:

String value

Default:

""

iconSize

public abstract Size iconSize

When set to a non-blank string, maps to the iconSize attribute of this Granite UI component's node. Used to specify icon size

Returns:

One of Size values

See Also:

Size

Default:

com.exadel.aem.toolkit.api.annotations.widgets.common.Size.SMALL

size

public abstract Size size

When set to a non-blank string, maps to the size attribute of this Granite UI component's node. Used to define button size

Note: only "medium" and "large" values are officially supported

Returns:

One of Size values

See Also:

Size

Default:

com.exadel.aem.toolkit.api.annotations.widgets.common.Size.MEDIUM

text

public abstract String text

When set to a non-blank string, maps to the text attribute of this Granite UI component's node. Used to define the text of the button

Returns:

String value, non-blank

Default:

""

textComment

public abstract String textComment

When set to a non-blank string, maps to the text_commentI18n attribute of this Granite UI component's node. Used to define the I18n comment for the body text

Returns:

String value, non-blank

Default:

""

trackingElement

public abstract String trackingElement

When set to a non-blank string, maps to the trackingElement attribute of this Granite UI component's node. Used to determine the element this component represents for the purpose of tracking

Returns:

String value, non-blank

See Also:

foundation-tracking

Default:

""

trackingFeature

public abstract String trackingFeature

When set to a non-blank string, maps to the trackingFeature attribute of this Granite UI dialog component's node. Used to define the name of the feature that the interaction takes place

Returns:

String value, non-blank

See Also:

foundation-tracking

Default:

""

type

public abstract ButtonType type

Maps to the type attribute of this Granite UI component's node. Used to define button type

Returns:

One of ButtonType values

See Also:

ButtonType

Default:

com.exadel.aem.toolkit.api.annotations.widgets.button.ButtonType.BUTTON

variant

public abstract ElementVariant variant

Maps to the variant attribute of this Granite UI dialog component's node. Used to define button variant

Returns:

One of ElementVariant values

See Also:

ElementVariant

Default:

com.exadel.aem.toolkit.api.annotations.widgets.common.ElementVariant.PRIMARY