com.citytechinc.cq.component.annotations

Annotation Type DialogField

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

The DialogField annotation is used to mark a Field or Method in a Component Class as an authorable element. Authorable elements are represented in the dialog of the Component to which they belong.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Property[]	additionalProperties A list of additional properties not already represented by properties of the annotation.
String	cssClass For Touch-UI Only
String	defaultValue Used to set the defaultValue widget property in the dialog.
boolean	disabled Indicates that the particular field should be rendered in a disabled state
String	fieldDescription Populates the fieldDescription widget property in the dialog.
String	fieldLabel The human-readable label for the input field which will be presented in a dialog.
String	fieldName While not technically part of the dialog property, the field name can be used to define a unique name for the dialog property within your dialog.
boolean	hideLabel Used to set the hideLabel widget property in the dialog.
boolean	hideOnEdit Indicates that a Touch UI widget should hide on page edit
Listener[]	listeners The set of listeners which will be attributed to the dialog widget associated with the authorable element.
String	name The path to which the value for the authorable element will be saved during content authoring.
String	orderBefore Applicable to Touch-UI only
double	ranking Used to order dialog widgets within a tab.
boolean	renderReadOnly Indicates that a Touch UI widget should also render as read only
boolean	required Indicates that population of the widget input in the dialog is required.
String	resourceType Applicable to Touch-UI only
boolean	showOnCreate Indicates that a Touch UI widget should show on page creation
boolean	suppressTouchUI Indicates that a Touch UI widget should not be produced for the annotated member
int	tab The index number, starting at 1, of the tab in which to place the dialog widget representing this authorable element.
String	title For Touch-UI Only
String	value For Touch-UI Only
String	xtype Allows for explicit definition of a dialog widget xtype associated with the element annotated.

Element Detail

xtype

public abstract String xtype

Allows for explicit definition of a dialog widget xtype associated with the element annotated.

Returns:

String

Default:

""

resourceType

public abstract String resourceType

Applicable to Touch-UI only

Allows for explicit definition of a dialog field's sling:resourceType.

Returns:

String

Default:

""

name

public abstract String name

The path to which the value for the authorable element will be saved during content authoring.

Returns:

String

Default:

""

fieldLabel

public abstract String fieldLabel

The human-readable label for the input field which will be presented in a dialog.

Returns:

String

Default:

""

fieldName

public abstract String fieldName

While not technically part of the dialog property, the field name can be used to define a unique name for the dialog property within your dialog. This field name is used as the element name of the XML element representing this authorable element in the dialog.

Returns:

String

Default:

""

fieldDescription

public abstract String fieldDescription

Populates the fieldDescription widget property in the dialog.

Returns:

String

Default:

""

required

public abstract boolean required

Indicates that population of the widget input in the dialog is required. Used to set the allowBlank widget property in the dialog.

Returns:

boolean

Default:

false

hideLabel

public abstract boolean hideLabel

Used to set the hideLabel widget property in the dialog.

Returns:

boolean

Default:

false

defaultValue

public abstract String defaultValue

Used to set the defaultValue widget property in the dialog.

Returns:

String

Default:

""

tab

public abstract int tab

The index number, starting at 1, of the tab in which to place the dialog widget representing this authorable element.

Returns:

int

Default:

1

additionalProperties

public abstract Property[] additionalProperties

A list of additional properties not already represented by properties of the annotation. Each additional property is output as a widget property in the dialog.

Returns:

FieldProperty[]

Default:

{}

listeners

public abstract Listener[] listeners

The set of listeners which will be attributed to the dialog widget associated with the authorable element. Listeners are output as properties in the listeners XML node which is a child of the XML node representing the widget in the dialog.

Returns:

Listener[]

Default:

{}

ranking

public abstract double ranking

Used to order dialog widgets within a tab. Widgets representing authorable elements with a higher ranking appear lower in the tab than elements with a lower ranking. The ordering of elements of equal ranking is not guaranteed.

Returns:

double

Default:

0.0

value

public abstract String value

For Touch-UI Only

Many of the Touch UI widgets react to an underlying value being set for the field.

Returns:

String

Default:

""

title

public abstract String title

For Touch-UI Only

Returns:

String

Default:

""

disabled

public abstract boolean disabled

Indicates that the particular field should be rendered in a disabled state

Returns:

boolean

Default:

false

cssClass

public abstract String cssClass

For Touch-UI Only

Additional css classes to attribute to the rendered field

Returns:

String

Default:

""

suppressTouchUI

public abstract boolean suppressTouchUI

Indicates that a Touch UI widget should not be produced for the annotated member

Returns:

boolean

Default:

false

renderReadOnly

public abstract boolean renderReadOnly

Indicates that a Touch UI widget should also render as read only

Returns:

boolean

Default:

true

showOnCreate

public abstract boolean showOnCreate

Indicates that a Touch UI widget should show on page creation

Returns:

boolean

Default:

true

hideOnEdit

public abstract boolean hideOnEdit

Indicates that a Touch UI widget should hide on page edit

Returns:

boolean

Default:

false

orderBefore

public abstract String orderBefore

Applicable to Touch-UI only

Sets the sling:orderBefore property. This can be used when supertyping a resource to reorder the dialog fields.

Default:

""