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

Class Sitemap

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.Sitemap

public class Sitemap
extends AbstractFoundationComponent

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_ROOT_PATH
static 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 and Description
Sitemap(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 and 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 Detail

RESOURCE_TYPE

public static final String RESOURCE_TYPE

See Also:

Constant Field Values

PROP_ROOT_PATH

public static final String PROP_ROOT_PATH

See Also:

Constant Field Values

Constructor Detail

Sitemap

public Sitemap(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 Detail

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