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

Annotation Type DialogField

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

Used to define common properties of Granite UI dialog field

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description When set to a non-blank string, maps to the fieldDescription attribute of this dialog component's node.
boolean	disabled Maps to the disabled attribute of this Granite UI component's node
String	label When set to a non-blank string, maps to the fieldLabel attribute of this dialog component's node.
String	name Used to define name attribute value for this Granite UI dialog component.
int	ranking Used to order dialog components in the Granite UI interface.
boolean	renderHidden Maps to the renderHidden attribute of this dialog component's node.
boolean	required Maps to the required attribute of this Granite UI component's node
String[]	validation Maps to the validation attribute of this Granite UI component's node
String	wrapperClass When set to a non-blank string, maps to the wrapperClass attribute of this dialog component's node.

Element Detail

description

public abstract String description

When set to a non-blank string, maps to the fieldDescription attribute of this dialog component's node. Used to define helper text for this dialog component

Returns:

String value (optional)

Default:

""

disabled

public abstract boolean disabled

Maps to the disabled attribute of this Granite UI component's node

Returns:

True or false

Default:

false

label

public abstract String label

When set to a non-blank string, maps to the fieldLabel attribute of this dialog component's node. Used to define a label displayed beside this dialog component

Returns:

String value (optional)

Default:

""

name

public abstract String name

Used to define name attribute value for this Granite UI dialog component. If not set, the name of the annotated field or method will be used

Returns:

String value (optional)

Default:

""

ranking

public abstract int ranking

Used to order dialog components in the Granite UI interface. Components with smaller rankings appear before those with greater rankings

Returns:

Integer value. Both positive and negative values allowed

Default:

-2147483648

renderHidden

public abstract boolean renderHidden

Maps to the renderHidden attribute of this dialog component's node. If set to true, the hidden attribute is added to the HTML element that wraps up the current component, so that the component is hidden together with its label and description. Has no effect if a wrapper element is not rendered (e.g. when neither label nor description is specified)

Returns:

True or false

Default:

false

required

public abstract boolean required

Maps to the required attribute of this Granite UI component's node

Returns:

True or false

Default:

false

validation

public abstract String[] validation

Maps to the validation attribute of this Granite UI component's node

Returns:

String value, or an array of non-blank strings

Default:

{}

wrapperClass

public abstract String wrapperClass

When set to a non-blank string, maps to the wrapperClass attribute of this dialog component's node. Used to specify a CSS class for the wrapper element

Returns:

String value (optional)

Default:

""