com.citytechinc.cq.component.annotations.widgets

Annotation Type Selection

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

Specifies a selection type Widget. A selection may be one of

1. select
2. radio
3. checkbox
4. combobox

Represents a Widget of type CQ.form.Selection in Classic UI

Represents a Widget of type granite/ui/components/foundation/form/select when using the select type and granite/ui/components/foundation/form/radiogroup when using the radio type in Touch UI

Checkbox and combobox are not currently supported in Touch UI rendering

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ASC_SORT_DIR
static String	CHECKBOX
static String	COMBOBOX
static String	DESC_SORT_DIR
static String	RADIO
static String	SELECT

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	dataSource Used for Touch UI only
boolean	multiple Used for Touch UI only
Option[]	options An explicitly enumerated set of options for the selection.
String	optionsProvider Used for Classic UI only
String	optionsUrl Used for Classic UI only
String	sortDir Used for Classic UI only
String	type The type of the selection.

Field Detail

SELECT

public static final String SELECT

RADIO

public static final String RADIO

CHECKBOX

public static final String CHECKBOX

COMBOBOX

public static final String COMBOBOX

ASC_SORT_DIR

public static final String ASC_SORT_DIR

DESC_SORT_DIR

public static final String DESC_SORT_DIR

Element Detail

options

public abstract Option[] options

An explicitly enumerated set of options for the selection. Note: if your options are returned dynamically via a URL, use the optionsUrl property.

Returns:

Default:

{}

optionsUrl

public abstract String optionsUrl

Used for Classic UI only

The URL from which options are to be pulled. Note: setting this to anything other than an empty string overrides any settings made in the options property.

Returns:

Default:

""

optionsProvider

public abstract String optionsProvider

Used for Classic UI only

A function or the name of a function that will be called on processRecords to receive the options. The function must return an array of options.

Returns:

String

See Also:

Options

Default:

""

sortDir

public abstract String sortDir

Used for Classic UI only

The sort direction of the the options. If "ASC" or "DESC" the options will be sorted by its (internationalized) text.

Returns:

String

Default:

""

type

public abstract String type

The type of the selection. One of "checkbox", "radio", "select" or "combobox". "checkbox" is the only type that supports mulitple values.

Returns:

String

Default:

"radio"

multiple

public abstract boolean multiple

Used for Touch UI only

Indicates whether multiple values may be picked for the selection

Returns:

boolean

Default:

false

dataSource

public abstract String dataSource

Used for Touch UI only

Indicates the sling:resourceType of the data source provider. For more information on DataSources, see http://docs.adobe.com/docs/en/cq/current/touch-ui/granite-reference.html #Datasource

Returns:

String

Default:

""