com.citytechinc.cq.component.annotations

Annotation Type DialogFieldOverride

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

The DialogFieldOverride annotation is used to override settings from a DialogField annotation on an interface or overriden method.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
boolean	hideLabel Used to set the hideLabel widget property in the dialog.
boolean	required Indicates that population of the widget input in the dialog is required.

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 For Touch-UI Only
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.
Listener[]	listeners The set of listeners which will be attributed to the dialog widget associated with the authorable element.
boolean	mergeAdditionalProperties If this is set to true, the instead of overriding the additional properties, the additional properties from the parent will be merged with the ones from this annotation.
boolean	mergeLiseners If this is set to true, the instead of overriding the listeners, the listeners from the parent will be merged with the ones from this annotation.
String	name The path to which the value for the authorable element will be saved during content authoring.
double	ranking Used to order dialog widgets within a tab.
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

Element Detail

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. Unlike DialogField this is required because we can't default to the value set on DialogField

Returns:

boolean

hideLabel

public abstract boolean hideLabel

Used to set the hideLabel widget property in the dialog. Unlike DialogField this is required because we can't default to the value set on DialogField

Returns:

boolean

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:

""

fieldDescription

public abstract String fieldDescription

Populates the fieldDescription widget property in the dialog.

Returns:

String

Default:

""

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:

{}

mergeAdditionalProperties

public abstract boolean mergeAdditionalProperties

If this is set to true, the instead of overriding the additional properties, the additional properties from the parent will be merged with the ones from this annotation.

Default:

false

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:

{}

mergeLiseners

public abstract boolean mergeLiseners

If this is set to true, the instead of overriding the listeners, the listeners from the parent will be merged with the ones from this annotation.

Default:

false

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

For Touch-UI Only

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