com.citytechinc.cq.component.annotations.widgets

Annotation Type PathField

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

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

Represents a Widget of type granite/ui/components/foundation/form/pathbrowser in Touch UI

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_FILTER_VALUE
static boolean	ESCAPE_AMP_DEFAULT
static boolean	HIDE_TRIGGER_DEFAULT
static boolean	PAR_BROWSE_DEFAULT
static String	ROOT_PATH_DEFAULT
static String	ROOT_TITLE_DEFAULT
static boolean	SHOW_TITLE_IN_TREE_DEFAULT

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	escapeAmp Used for Classic UI only
String	filter Used for Coral 3 Touch UI only.
boolean	forceSelection Used for Coral 3 Touch UI only.
boolean	hideTrigger Used for Classic UI only
String	optionLoader Used for Coral 2 Touch UI only
String	optionTitleReader Used for Coral 2 Touch UI only
String	optionValueReader Used for Coral 2 Touch UI only
boolean	parBrowse Used for Classic UI only
String	rootPath The root path where completion and browsing starts.
String	rootTitle Used for Classic UI only
boolean	showTitleInTree Used for Classic UI only

Field Detail

ESCAPE_AMP_DEFAULT

public static final boolean ESCAPE_AMP_DEFAULT

HIDE_TRIGGER_DEFAULT

public static final boolean HIDE_TRIGGER_DEFAULT

PAR_BROWSE_DEFAULT

public static final boolean PAR_BROWSE_DEFAULT

ROOT_PATH_DEFAULT

public static final String ROOT_PATH_DEFAULT

ROOT_TITLE_DEFAULT

public static final String ROOT_TITLE_DEFAULT

SHOW_TITLE_IN_TREE_DEFAULT

public static final boolean SHOW_TITLE_IN_TREE_DEFAULT

DEFAULT_FILTER_VALUE

public static final String DEFAULT_FILTER_VALUE

Element Detail

escapeAmp

public abstract boolean escapeAmp

Used for Classic UI only

True to url-encode the ampersand character (&) to %26.

Returns:

boolean

Default:

false

hideTrigger

public abstract boolean hideTrigger

Used for Classic UI only

True to disable the option to open the browse dialog

Returns:

boolean

Default:

false

parBrowse

public abstract boolean parBrowse

Used for Classic UI only

True to allow paragraph browsing and section in a grid next to the tree panel in the browse dialog. If this is enabled, it is recommended to use a predicate like 'hierarchy' to have pages as leaf nodes in the tree.

Returns:

boolean

Default:

false

rootPath

public abstract String rootPath

The root path where completion and browsing starts. Use the empty string for the repository root

Returns:

String

Default:

"/"

rootTitle

public abstract String rootTitle

Used for Classic UI only

Custom title for the root path

Returns:

String

Default:

"Websites"

showTitleInTree

public abstract boolean showTitleInTree

Used for Classic UI only

Whether to show the (jcr:)titles as names of the tree nodes or the plain jcr node name

Returns:

boolean

Default:

true

optionLoader

public abstract String optionLoader

Used for Coral 2 Touch UI only

Javascript source code for an option loader callback function. Takes two arguments: (path, callback). See the default option loader implementation for more details on how to use this. If not given, a default option loader will be used that just returns paths from the current repository.

The default option loader can be found in /libs/granite/ui/components/foundation/form/pathbrowser/render.jsp

Returns:

String

Default:

""

optionValueReader

public abstract String optionValueReader

Used for Coral 2 Touch UI only

Javascript source code for callback function that gets an option value object as parameter and should return a stringified value for this option.

Returns:

String

Default:

""

optionTitleReader

public abstract String optionTitleReader

Used for Coral 2 Touch UI only

Javascript source code for callback function that gets an option value object as parameter and should return a stringified title for this option.

Returns:

String

Default:

""

forceSelection

public abstract boolean forceSelection

Used for Coral 3 Touch UI only.

Indicates if the user must only select from the list of given options. If it is not forced, the user can enter arbitrary value

Returns:

boolean

Default:

false

filter

public abstract String filter

Used for Coral 3 Touch UI only.

The filter applied to suggestion and picker.

The default value is hierarchyNotFile.

Valid values are:
• folder - Shows only nt:folder nodes
• hierarchy - Shows only nt:hierarchyNode nodes
• hierarchyNotFile - Shows only nt:hierarchyNode nodes that are not nt:file
• nosystem - Shows non-system nodes: !node.getName().startsWith("rep:") && !node.getName().equals("jcr:system")

Returns:

String

Default:

"hierarchyNotFile"