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

Class TextImage

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

public class TextImage
extends AbstractFoundationComponent

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_CSS_CLASS
static String	PROP_IMAGE_NODE_LOCATION
static String	PROP_IMAGE_NODE_NAME
static String	PROP_TEXT
static String	PROP_TEXT_IS_RICH
static String	PROP_TITLE
static String	RESOURCE_TYPE
protected Image	testImage	Default Image object used in the component

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

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

Constructor Summary

Constructors

Constructor	Description
TextImage(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
Image	getImage()
String	getResourceType()	The resource type for the component, e.g.
org.apache.sling.testing.clients.SlingHttpResponse	save(int... expectedStatus)	Submits all editable values to the server.
void	setDeleteImage()	Sets properties to remove image upon save.
org.apache.sling.testing.clients.SlingHttpResponse	uploadImage(String mimeType, String imageName, String resourcePath)

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, 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_TEXT

public static final String PROP_TEXT

See Also:

Constant Field Values

PROP_TEXT_IS_RICH

public static final String PROP_TEXT_IS_RICH

See Also:

Constant Field Values

PROP_TITLE

public static final String PROP_TITLE

See Also:

Constant Field Values

PROP_CSS_CLASS

public static final String PROP_CSS_CLASS

See Also:

Constant Field Values

PROP_IMAGE_NODE_LOCATION

public static final String PROP_IMAGE_NODE_LOCATION

See Also:

Constant Field Values

PROP_IMAGE_NODE_NAME

public static final String PROP_IMAGE_NODE_NAME

See Also:

Constant Field Values

testImage

protected Image testImage

Default Image object used in the component

Constructor Detail

TextImage

public TextImage(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

uploadImage

public org.apache.sling.testing.clients.SlingHttpResponse uploadImage(String mimeType,
                                                                      String imageName,
                                                                      String resourcePath)
                                                               throws org.apache.sling.testing.clients.ClientException

Throws:

org.apache.sling.testing.clients.ClientException

setDeleteImage

public void setDeleteImage()
                    throws org.apache.sling.testing.clients.ClientException,
                           InterruptedException

Sets properties to remove image upon save.

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

InterruptedException - to mark this method as waiting

getImage

public Image getImage()

Returns:

The default Image component

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

save

public org.apache.sling.testing.clients.SlingHttpResponse save(int... expectedStatus)
                                                        throws org.apache.sling.testing.clients.ClientException,
                                                               InterruptedException

Description copied from class: AbstractComponent

Submits all editable values to the server. Same as pressing the OK button on the edit dialog of a component.

Overrides:

save in class AbstractComponent

Parameters:

expectedStatus - list of allowed HTTP Status to be returned. if not set, status 200 is assumed

Returns:

Sling response

Throws:

org.apache.sling.testing.clients.ClientException - If something fails during request/response cycle

InterruptedException - to mark this method as waiting