com.citytechinc.cq.component.annotations

Annotation Type Component

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

The Component annotation is used to indicate that a Class represents a CQ Component. Multiple properties which are universally applicable to all types of components are exposed for configuration via this annotation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Populates the jcr:title of the Component's .content.xml

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ActionConfig[]	actionConfigs Establishes the set of Action Configurations which will be written to the cq:actionConfigs node of the _cq_editConfig.xml.
String[]	actions The list of actions which will populate the cq:actions attribute of the _cq_editConfig.xml.
String[]	allowedChildren Establishes the components which are allowed to be children of this component.
String[]	allowedParents Establishes the components which are allowed to be parents of this component.
String	basePath Overrides the baseComponentPath
String	cellName Populates the cq:cellName property of the .content.xml.
ContentProperty[]	contentAdditionalProperties A set of properties which are written to the content XML node.
String	created Populates the jcr:created property of the Component's .content.xml.
String	description Populates the jcr:description property of the Component's .content.xml
int	dialogHeight The height of the dialog popup widget.
String	dialogMode Populates the cq:dialogMode property of the _cq_editConfig.xml.
String	dialogPath Populates the dialogPath property of the Component's .content.xml.
int	dialogWidth The width of the dialog popup widget.
boolean	disableTargeting Indicates whether the Target context menu should be disabled for the particular component.
DropTarget[]	dropTargets Establishes the list of drop targets written to the cq:dropTargets node of the _cq_editConfig.xml.
boolean	editConfig Indicates whether a _cq_editConfig file should be generated for the component defined by the annotated Java Class.
boolean	editConfigInherit Indicates whether this component should inherit edit behavior from it's super type.
String	emptyText Establishes the empty text presented for components which are drop targets.
String[]	extraClientlibs A list of extra client libs to be included on the jcr:root node
String	fileName The name, without extension, to use for the output dialog xml file.
FormParameter[]	formParameters Establishes the set of form parameters written to the cq:formParameters node of the _cq_editConfig.xml.
String	group The component group into which this component will be placed.
String	helpPath A path to be followed when a user clicks the help button in the Touch UI Authoring interface.
HtmlTag[]	htmlTag Definition of the cq:htmlTag child node of the component definition node.
boolean	inPlaceEditingActive Indicates whether in place editing should be active for this component.
String	inPlaceEditingConfigPath Establishes the path to the inplace editing configuration.
String	inPlaceEditingEditorType Establishes the type of inplace editor which will be used for the annotated component.
boolean	isContainer Indication of whether this component is a container for other components.
String	layout Populates the cq:layout property of the _cq_editConfig.xml.
Listener[]	listeners Establishes the set of edit listeners which will be associated with the Component.
String	name The name which will identify this component.
boolean	noDecoration Indication of whether the component should not be rendered within a container.
String	path The path to the component definition within the context of a CQ content tree.
String	resourceSuperType Establishes the sling:resourceSuperType of this component
boolean	suppressClassicUIDialog Indicates whether writing of the dialog.xml appropriate to the Classic UI AEM interface should be skipped for this component.
boolean	suppressFieldInheritanceForTouchUI Applicable to the Touch UI only
boolean	suppressTouchUIDialog Indicates whether writing of the cq:dialog.xml appropriate to the Touch UI AEM interface should be skipped for this component.
Tab[]	tabs Establishes the set of Tabs which will appear within a Component's authoring dialog.
String	templatePath Populates the cq:templatePath property of the Component's .content.xml.
String	touchFileName The name, without extension, to use for the output _cq_dialog xml file.

Element Detail

value

public abstract String value

Populates the jcr:title of the Component's .content.xml

Returns:

String

basePath

public abstract String basePath

Overrides the baseComponentPath

Returns:

String

Default:

""

path

public abstract String path

The path to the component definition within the context of a CQ content tree. This is meant to override any default path specified for the project as a whole.

Returns:

String

Default:

""

name

public abstract String name

The name which will identify this component. This property should be used if the name which will be automatically generated for the component based on the name of the component class is not appropriate for your purposes.

Returns:

String

Default:

""

description

public abstract String description

Populates the jcr:description property of the Component's .content.xml

Returns:

String

Default:

""

group

public abstract String group

The component group into which this component will be placed. This overrides any default group established for your project's build.

Returns:

String

Default:

""

isContainer

public abstract boolean isContainer

Indication of whether this component is a container for other components. Populates the cq:isContainer property of the Component's .content.xml.

Returns:

boolean

Default:

false

noDecoration

public abstract boolean noDecoration

Indication of whether the component should not be rendered within a container. Populates the cq:noDecoration property of the Component's .content.xml.

Returns:

boolean

Default:

false

templatePath

public abstract String templatePath

Populates the cq:templatePath property of the Component's .content.xml.

Returns:

String

Default:

""

dialogPath

public abstract String dialogPath

Populates the dialogPath property of the Component's .content.xml.

Returns:

String

Default:

""

created

public abstract String created

Populates the jcr:created property of the Component's .content.xml.

Returns:

String

Default:

""

tabs

public abstract Tab[] tabs

Establishes the set of Tabs which will appear within a Component's authoring dialog. When a multi-tab dialog is needed, all tabs must be defined via this property. Individual dialog fields indicate which tab they are to be placed into by number, starting from '1'. For more detail concerning placing Dialog Fields into tabs, see DialogField.tab()

Returns:

Tab[]

Default:

{}

actions

public abstract String[] actions

The list of actions which will populate the cq:actions attribute of the _cq_editConfig.xml. For more information on valid actions see the Configuring Edit Behavior Documentation

Returns:

String[]

Default:

{}

dialogMode

public abstract String dialogMode

Populates the cq:dialogMode property of the _cq_editConfig.xml. For more information on valid dialog modes see the Configuring Edit Behavior Documentation

Returns:

String

Default:

"floating"

layout

public abstract String layout

Populates the cq:layout property of the _cq_editConfig.xml. For more information on valid layouts see the Configuring Edit Behavior Documentation

Returns:

String

Default:

"editbar"

listeners

public abstract Listener[] listeners

Establishes the set of edit listeners which will be associated with the Component. These populate the cq:listeners node of the _cq_editConfig.xml. For more information on the purpose of and configuration for listeners, see the Configuring Edit Behavior Documentation

Returns:

Listener[]

Default:

{}

resourceSuperType

public abstract String resourceSuperType

Establishes the sling:resourceSuperType of this component

Returns:

String

Default:

""

emptyText

public abstract String emptyText

Establishes the empty text presented for components which are drop targets.

Returns:

String

Default:

"Drag components or assets here"

editConfigInherit

public abstract boolean editConfigInherit

Indicates whether this component should inherit edit behavior from it's super type. Populates the cq:inherit property of the _cq_editConfig.xml. For more information on inheriting edit behavior configuration see the Configuring Edit Behavior Documentation

Returns:

boolean

Default:

false

fileName

public abstract String fileName

The name, without extension, to use for the output dialog xml file. This can be used when you want to output a dialog type other than the edit dialog. For example, a design dialog may be written for a component by setting the fileName to 'design_dialog'.

Returns:

String

Default:

"dialog"

touchFileName

public abstract String touchFileName

The name, without extension, to use for the output _cq_dialog xml file. This can be used when you want to output a dialog type other than the edit dialog.

Returns:

String

Default:

"_cq_dialog"

editConfig

public abstract boolean editConfig

Indicates whether a _cq_editConfig file should be generated for the component defined by the annotated Java Class. When set to false, a _cq_editConfig file will not be generated regardless of whether one already exists for the Component. When set to true, a _cq_editConfig file will only be generated if one does not already exist for the Component.

Returns:

boolean

Default:

true

dialogWidth

public abstract int dialogWidth

The width of the dialog popup widget. The default value -1 indicates that the default width should be used.

Returns:

int

Default:

-1

dialogHeight

public abstract int dialogHeight

The height of the dialog popup widget. The default value -1 indicates that the default height should be used.

Returns:

int

Default:

-1

allowedChildren

public abstract String[] allowedChildren

Establishes the components which are allowed to be children of this component. This list populates the allowedChildren property of .content.xml. For more information on the usage of allowedChildren see the Component Documentation.

Returns:

String[]

Default:

{}

allowedParents

public abstract String[] allowedParents

Establishes the components which are allowed to be parents of this component. This list populates the allowedParents property of .content.xml. For more information on the usage of allowedParents see the Component Documentation.

Returns:

String[]

Default:

{}

cellName

public abstract String cellName

Populates the cq:cellName property of the .content.xml. For more information on the intended usage of the cq:cellName property, see the Component Documentation.

Returns:

String

Default:

""

actionConfigs

public abstract ActionConfig[] actionConfigs

Establishes the set of Action Configurations which will be written to the cq:actionConfigs node of the _cq_editConfig.xml. For more information on Action Configurations see the Configuring Edit Behavior Documentation.

Returns:

ActionConfig[]

Default:

{}

inPlaceEditingActive

public abstract boolean inPlaceEditingActive

Indicates whether in place editing should be active for this component. This property populates the active property of the cq:inplaceEditing node in the _cq_editConfig.xml. For more information on inplace editing, see the Configuring Edit Behavior Documentation.

Returns:

boolean

Default:

true

inPlaceEditingConfigPath

public abstract String inPlaceEditingConfigPath

Establishes the path to the inplace editing configuration. This property populates the configPath property of the cq:inplaceEditing node in the _cq_editConfig.xml. For more information on inplace editing, see the Configuring Edit Behavior Documentation.

Returns:

String

Default:

""

inPlaceEditingEditorType

public abstract String inPlaceEditingEditorType

Establishes the type of inplace editor which will be used for the annotated component. This property populates the editorType property of the cq:inplaceEditing node in the _cq_editConfig.xml. For more information on inplace editing, see the Configuring Edit Behavior Documentation.

Returns:

String

Default:

""

formParameters

public abstract FormParameter[] formParameters

Establishes the set of form parameters written to the cq:formParameters node of the _cq_editConfig.xml. For more information on form parameters see the Configuring Edit Behavior Documentation.

Returns:

String

Default:

{}

dropTargets

public abstract DropTarget[] dropTargets

Establishes the list of drop targets written to the cq:dropTargets node of the _cq_editConfig.xml. For more information on drop targets and their usage, see the Configuring Edit Behavior Documentation.

Returns:

DropTarget[]

Default:

{}

contentAdditionalProperties

public abstract ContentProperty[] contentAdditionalProperties

A set of properties which are written to the content XML node.

Returns:

ContentProperty[]

Default:

{}

extraClientlibs

public abstract String[] extraClientlibs

A list of extra client libs to be included on the jcr:root node

Returns:

ComponentProperty[]

Default:

{}

disableTargeting

public abstract boolean disableTargeting

Indicates whether the Target context menu should be disabled for the particular component. Populates the cq:disableTargeting property of the _cq_editConfig.xml. For information on this properties usage, see this forum article.

Returns:

boolean

Default:

false

htmlTag

public abstract HtmlTag[] htmlTag

Definition of the cq:htmlTag child node of the component definition node. See this document for more information.

Returns:

HtmlTag[]

Default:

{}

suppressTouchUIDialog

public abstract boolean suppressTouchUIDialog

Indicates whether writing of the cq:dialog.xml appropriate to the Touch UI AEM interface should be skipped for this component.

Returns:

boolean

Default:

false

suppressClassicUIDialog

public abstract boolean suppressClassicUIDialog

Indicates whether writing of the dialog.xml appropriate to the Classic UI AEM interface should be skipped for this component.

Returns:

boolean

Default:

false

helpPath

public abstract String helpPath

A path to be followed when a user clicks the help button in the Touch UI Authoring interface.

Returns:

String

Default:

""

suppressFieldInheritanceForTouchUI

public abstract boolean suppressFieldInheritanceForTouchUI

Applicable to the Touch UI only

If set to true, extended classes and implemented interfaces will not be interrogated when arriving at a list of Dialog Fields for a Touch UI dialog. This intends to support situations where you are both extending a class and a sling:resourceType and thus will be using the dialog resource merger for the inclusion of the supertype's dialog fields as opposed to inclusion via class inheritance.

Returns:

boolean

Default:

false