com.citytechinc.cq.component.annotations.config

Annotation Type Widget

@Retention(value=CLASS)
 @Target(value=TYPE)
public @interface Widget

Used to indicate that a Class represents a Dialog Widget and makes explicit the connection between the Widget, an annotation necessary to indicate that a field or method is to be populated by a Dialog Widget of this type, and the mechanism which will create the widget.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends Annotation>	annotationClass The stacked annotation which will be used to indicate that a field is to be populated by a Dialog Widget of this type.
Class<? extends AbstractWidgetMaker>	makerClass The class responsible for making instances of the annotated Widget Class.
String	xtype The xtype which will be rendered to the Dialog for a field populated by a Dialog Widget of this type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	featureFlag Feature flag which can be configured in a POMs additionalFeatures configuration indicating the inclusion of this widget in the widget registry during dialog rendering.
int	ranking Used in the rare cases where multiple annotations will be stacked under a DialogField annotation.

Element Detail

annotationClass

public abstract Class<? extends Annotation> annotationClass

The stacked annotation which will be used to indicate that a field is to be populated by a Dialog Widget of this type. This would be the annotation stacked under the DialogField annotation on a given Component field.

The annotationClass list may be left empty in which case the Widget ties together an xtype and WidgetMaker directly. The annotationClass list may not contain more than one Annotation class.

makerClass

public abstract Class<? extends AbstractWidgetMaker> makerClass

The class responsible for making instances of the annotated Widget Class.

xtype

public abstract String xtype

The xtype which will be rendered to the Dialog for a field populated by a Dialog Widget of this type.

ranking

public abstract int ranking

Used in the rare cases where multiple annotations will be stacked under a DialogField annotation. In such cases, ranking indicates which annotation will be used in looking up an appropriate Widget type and Maker for the field in question. A Widget with a higher ranking will take precedence over one with a lower ranking. In the case of equal ranking values behavior can not be guaranteed.

Default:

-1

featureFlag

public abstract String featureFlag

Feature flag which can be configured in a POMs additionalFeatures configuration indicating the inclusion of this widget in the widget registry during dialog rendering. If left empty the widget will always be included.

Default:

""