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

Class Image

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

public class Image
extends AbstractFoundationComponent

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_ALT_TEXT
static String	PROP_DESCRIPTION
static String	PROP_FILE
static String	PROP_FILE_MOVE_FROM
static String	PROP_FILE_NAME
static String	PROP_FILE_REFERENCE
static String	PROP_FILE_TMP
static String	PROP_HEIGHT
static String	PROP_IMAGE_CROP
static String	PROP_IMAGE_MAP
static String	PROP_IMAGE_ROTATE
static String	PROP_LINK_URL
static String	PROP_TITLE
static String	PROP_UNDO_BLOBS
static String	PROP_WIDTH
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	Description
Image(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.
void	setDeleteImage()	Sets properties to remove image upon save.
void	setImageReference(String imageReference)	Set properties to reference an image in the repository.
org.apache.sling.testing.clients.SlingHttpResponse	uploadImage(String mimeType, String imageName, String resourcePath, int... expectedStatus)	uploads the image to be used by the image component

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_FILE_REFERENCE

public static final String PROP_FILE_REFERENCE

See Also:

Constant Field Values

PROP_UNDO_BLOBS

public static final String PROP_UNDO_BLOBS

See Also:

Constant Field Values

PROP_FILE

public static final String PROP_FILE

See Also:

Constant Field Values

PROP_FILE_TMP

public static final String PROP_FILE_TMP

See Also:

Constant Field Values

PROP_FILE_NAME

public static final String PROP_FILE_NAME

See Also:

Constant Field Values

PROP_WIDTH

public static final String PROP_WIDTH

See Also:

Constant Field Values

PROP_HEIGHT

public static final String PROP_HEIGHT

See Also:

Constant Field Values

PROP_IMAGE_CROP

public static final String PROP_IMAGE_CROP

See Also:

Constant Field Values

PROP_IMAGE_ROTATE

public static final String PROP_IMAGE_ROTATE

See Also:

Constant Field Values

PROP_IMAGE_MAP

public static final String PROP_IMAGE_MAP

See Also:

Constant Field Values

PROP_TITLE

public static final String PROP_TITLE

See Also:

Constant Field Values

PROP_ALT_TEXT

public static final String PROP_ALT_TEXT

See Also:

Constant Field Values

PROP_DESCRIPTION

public static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_LINK_URL

public static final String PROP_LINK_URL

See Also:

Constant Field Values

PROP_FILE_MOVE_FROM

public static final String PROP_FILE_MOVE_FROM

See Also:

Constant Field Values

Constructor Detail

Image

public Image(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,
                                                                      int... expectedStatus)
                                                               throws org.apache.sling.testing.clients.ClientException

uploads the image to be used by the image component

Parameters:

mimeType - MIME type of image

imageName - image name

resourcePath - path to the image resource

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

Returns:

a SlingHttpResponse wrapping the HTML response returned by Sling

Throws:

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

setImageReference

public void setImageReference(String imageReference)

Set properties to reference an image in the repository.

Parameters:

imageReference - reference path to image in repository.

setDeleteImage

public void setDeleteImage()

Sets properties to remove image upon save.

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