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

Class Flash

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

public class Flash
extends AbstractFoundationComponent

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_ATTRIBUTES
static String	PROP_BG_COLOR
static String	PROP_FILE
static String	PROP_FILE_MOVE_FROM
static String	PROP_FILE_TMP
static String	PROP_FILENAME
static String	PROP_HEIGHT
static String	PROP_IMAGE_FILE
static String	PROP_IMAGE_FILE_MOVE_FROM
static String	PROP_IMAGE_FILE_TMP
static String	PROP_MENU
static String	PROP_MIN_FLASH_VERSION
static String	PROP_WIDTH
static String	PROP_WMODE
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
Flash(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
void	deleteAltImage()	Sets properties to remove image upon save.
void	deleteAnimationFile()
String	getImagePath()
String	getResourceType()	The resource type for the component, e.g.
org.apache.sling.testing.clients.SlingHttpResponse	uploadAltImage(String mimeType, String imageName, String resourcePath, int... expectedStatus)	uploads the image to be used by the image component
org.apache.sling.testing.clients.SlingHttpResponse	uploadAnimation(String mimeType, String fileName, 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

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_MOVE_FROM

public static final String PROP_FILE_MOVE_FROM

See Also:

Constant Field Values

PROP_ATTRIBUTES

public static final String PROP_ATTRIBUTES

See Also:

Constant Field Values

PROP_BG_COLOR

public static final String PROP_BG_COLOR

See Also:

Constant Field Values

PROP_MIN_FLASH_VERSION

public static final String PROP_MIN_FLASH_VERSION

See Also:

Constant Field Values

PROP_MENU

public static final String PROP_MENU

See Also:

Constant Field Values

PROP_WMODE

public static final String PROP_WMODE

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_FILENAME

public static final String PROP_FILENAME

See Also:

Constant Field Values

PROP_IMAGE_FILE

public static final String PROP_IMAGE_FILE

See Also:

Constant Field Values

PROP_IMAGE_FILE_TMP

public static final String PROP_IMAGE_FILE_TMP

See Also:

Constant Field Values

PROP_IMAGE_FILE_MOVE_FROM

public static final String PROP_IMAGE_FILE_MOVE_FROM

See Also:

Constant Field Values

Constructor Detail

Flash

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

uploadAnimation

public org.apache.sling.testing.clients.SlingHttpResponse uploadAnimation(String mimeType,
                                                                          String fileName,
                                                                          String resourcePath,
                                                                          int... expectedStatus)
                                                                   throws org.apache.sling.testing.clients.ClientException,
                                                                          UnsupportedEncodingException

uploads the image to be used by the image component

Parameters:

mimeType - MIME type of image

fileName - 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

UnsupportedEncodingException - never

uploadAltImage

public org.apache.sling.testing.clients.SlingHttpResponse uploadAltImage(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

deleteAnimationFile

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

Throws:

org.apache.sling.testing.clients.ClientException

InterruptedException

deleteAltImage

public void deleteAltImage()
                    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

getImagePath

public String getImagePath()

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