Package com.adobe.cq.testing.client.components.foundation

Class List

java.lang.Object

com.adobe.cq.testing.client.components.AbstractComponent

com.adobe.cq.testing.client.components.foundation.AbstractFoundationComponent

com.adobe.cq.testing.client.components.foundation.List

public class List
extends AbstractFoundationComponent

Wraps the List foundation component, providing methods for editing it. See /libs/foundation/components/list in the repository for implementation details.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPT_LIST_FIXED_LIST
static final String	OPT_LIST_FROM_CHILDREN
static final String	OPT_LIST_QUERY_BUILDER
static final String	OPT_LIST_SEARCH
static final String	PROP_ANCESTOR_PAGE
static final String	PROP_DISPLAY_AS
static final String	PROP_FEED_ENABLED
static final String	PROP_LIMIT
static final String	PROP_LIST_FROM
static final String	PROP_ORDER_BY
static final String	PROP_PAGE_MAX
static final String	PROP_PAGES
static final String	PROP_PAGES_DEL
static final String	PROP_PARENT_PAGE
static final String	PROP_QUERY
static final String	PROP_SAVED_QUERY
static final String	PROP_SEARCH_IN
static final String	PROP_TAG_SEARCHROOT
static final String	RESOURCE_TYPE

Fields inherited from class com.adobe.cq.testing.client.components.AbstractComponent

changeProperties, client, componentPath, DEFAULT_LOCATION, jsonNode, location, pagePath

Constructor Summary

Constructors

Constructor	Description
List(ComponentClient client, String pagePath, String location, String nameHint)	The constructor stores all the component path information like parentPage, name etc.

Method Summary

Modifier and Type	Method	Description
String	getResourceType()	The resource type for the component, e.g.

Methods inherited from class com.adobe.cq.testing.client.components.AbstractComponent

create, getClient, getComponentNode, getComponentPath, getCreateFormEntity, getFirstChild, getLocation, getName, getNext, getNextNodePath, getPagePath, getParentPath, getPrevious, getPreviousNodePath, getProperty, getPropertyAsString, getPropertyAsStringArray, reorder, save, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESOURCE_TYPE

public static final String RESOURCE_TYPE

See Also:

• Constant Field Values

OPT_LIST_FROM_CHILDREN

public static final String OPT_LIST_FROM_CHILDREN

See Also:

• Constant Field Values

OPT_LIST_FIXED_LIST

public static final String OPT_LIST_FIXED_LIST

See Also:

• Constant Field Values

OPT_LIST_SEARCH

public static final String OPT_LIST_SEARCH

See Also:

• Constant Field Values

OPT_LIST_QUERY_BUILDER

public static final String OPT_LIST_QUERY_BUILDER

See Also:

• Constant Field Values

PROP_LIST_FROM

public static final String PROP_LIST_FROM

See Also:

• Constant Field Values

PROP_PARENT_PAGE

public static final String PROP_PARENT_PAGE

See Also:

• Constant Field Values

PROP_ANCESTOR_PAGE

public static final String PROP_ANCESTOR_PAGE

See Also:

• Constant Field Values

PROP_DISPLAY_AS

public static final String PROP_DISPLAY_AS

See Also:

• Constant Field Values

PROP_ORDER_BY

public static final String PROP_ORDER_BY

See Also:

• Constant Field Values

PROP_LIMIT

public static final String PROP_LIMIT

See Also:

• Constant Field Values

PROP_FEED_ENABLED

public static final String PROP_FEED_ENABLED

See Also:

• Constant Field Values

PROP_PAGE_MAX

public static final String PROP_PAGE_MAX

See Also:

• Constant Field Values

PROP_SEARCH_IN

public static final String PROP_SEARCH_IN

See Also:

• Constant Field Values

PROP_PAGES

public static final String PROP_PAGES

See Also:

• Constant Field Values

PROP_PAGES_DEL

public static final String PROP_PAGES_DEL

See Also:

• Constant Field Values

PROP_QUERY

public static final String PROP_QUERY

See Also:

• Constant Field Values

PROP_SAVED_QUERY

public static final String PROP_SAVED_QUERY

See Also:

• Constant Field Values

PROP_TAG_SEARCHROOT

public static final String PROP_TAG_SEARCHROOT

See Also:

• Constant Field Values

Constructor Details

List

public List(ComponentClient client,
 String pagePath,
 String location,
 String nameHint)

The constructor stores all the component path information like parentPage, name etc.

Parameters:

client - The FoundationClient that's creating this instance.

pagePath - path to the page that will contain the component.

location - relative location to the parent node inside the page that will contain the component node.

nameHint - name to be used for the component node. Might get altered by the server if a naming conflict occurs. The AbstractComponent.getName() method will return the correct name after (String,int...) has been called.

Method Details

getResourceType

public String getResourceType()

Description copied from class: AbstractComponent

The resource type for the component, e.g. foundation/components/text. this will be set in the sling:resourceType property of the node.

Specified by:

getResourceType in class AbstractComponent

Returns:

the resource type