com.citytechinc.cq.component.annotations

Annotation Type Tab

public @interface Tab

Defines a Tab in a Component dialog.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	classicUIPath Applicable to Classic-UI only
boolean	hideOnEdit Applicable to Touch-UI only
Listener[]	listeners Applicable to Classic-UI only
boolean	margin Applicable to Touch-UI only
String	orderBefore Applicable to Touch-UI only
Property[]	renderConditionProperties Applicable to Touch-UI only
String	renderConditionResourceType Applicable to Touch-UI only
boolean	showOnCreate Applicable to Touch-UI only
String	title Title of the dialog Tab.
String	touchUINodeName Applicable to Touch-UI only
String	touchUIPath Applicable to Touch-UI only

Element Detail

title

public abstract String title

Title of the dialog Tab.

Returns:

String

Default:

""

classicUIPath

public abstract String classicUIPath

Applicable to Classic-UI only

Defines the path to the Tab definition in the content repository. This property may be used when the Tab is to be populated in the rendered dialog using an existing definition in the repository.

Returns:

String

Default:

""

touchUIPath

public abstract String touchUIPath

Applicable to Touch-UI only

Defines the path to the Tab definition in the content repository. This property may be used when the Tab is to be populated in the rendered dialog using an existing definition in the repository.

Default:

""

listeners

public abstract Listener[] listeners

Applicable to Classic-UI only

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

Returns:

Listener[]

Default:

{}

renderConditionResourceType

public abstract String renderConditionResourceType

Applicable to Touch-UI only

Defines the sling:resourceType for the renderCondition node for this tab

Default:

""

renderConditionProperties

public abstract Property[] renderConditionProperties

Applicable to Touch-UI only

Defines additional properties to be added to the renderCondition node

These will only be added if renderConditionResourceType is not empty

Default:

{}

showOnCreate

public abstract boolean showOnCreate

Applicable to Touch-UI only

Controls whether or not the tab is shown in the create page dialog

Default:

true

hideOnEdit

public abstract boolean hideOnEdit

Applicable to Touch-UI only

Controls whether or not the tab is hidden in the edit page dialog

Default:

false

margin

public abstract boolean margin

Applicable to Touch-UI only

Controls whether or not the tab container has a margin

Default:

true

touchUINodeName

public abstract String touchUINodeName

Applicable to Touch-UI only

Allows direct control over the name of the node generated for the Tab. This is useful in situations where you are supertyping a resource or you plan for your resource to be supertyped as it allows for the dialog structure to be shared by the inheriting components which is necessary for the resource merger mechanisms to act as expected.

If unset the tab names will continue to default to a sanitized version of the title.

Default:

""

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 tabs

Default:

""