Package org.mozilla.zest.core.v1

Class ZestClientScreenshot

java.lang.Object

org.mozilla.zest.core.v1.ZestElement

org.mozilla.zest.core.v1.ZestStatement

org.mozilla.zest.core.v1.ZestClient

org.mozilla.zest.core.v1.ZestClientScreenshot

public class ZestClientScreenshot
extends ZestClient

A ZestClient action that takes a screenshot.

The screenshot can be saved to a file and/or to a variable (for the latter Base64 encoded).

Since:

0.14.0

Field Summary

Fields inherited from class org.mozilla.zest.core.v1.ZestElement

JSON_ELEMENT_TYPE

Constructor Summary

Constructors

Constructor	Description
ZestClientScreenshot()	Constructs a ZestClientScreenshot with no file path nor variable name.
ZestClientScreenshot(String windowHandle, String filePath, String variableName)	Constructs a ZestClientScreenshot with the given file path and variable name.

Method Summary

Modifier and Type	Method	Description
ZestClientScreenshot	deepCopy()	Deep copy.
String	getFilePath()	Gets the path to the file.
String	getVariableName()	Gets the name of the variable.
String	getWindowHandle()	Gets the window handle.
String	invoke(ZestRuntime runtime)
boolean	isPassive()	Checks if is passive.
void	setFilePath(String filePath)	Sets the path to the file.
void	setVariableName(String variableName)	Sets the name of the variable.
void	setWindowHandle(String windowHandle)	Sets the window handle.

Methods inherited from class org.mozilla.zest.core.v1.ZestClient

isSameSubclass

Methods inherited from class org.mozilla.zest.core.v1.ZestStatement

getIndex, getNext, getPrevious, init, insertAfter, insertBefore, isEnabled, remove, setEnabled, setNext, setPrev

Methods inherited from class org.mozilla.zest.core.v1.ZestElement

getElementType, setElementType

Methods inherited from class java.lang.Object

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

Constructor Detail

ZestClientScreenshot

public ZestClientScreenshot()

Constructs a ZestClientScreenshot with no file path nor variable name.

ZestClientScreenshot

public ZestClientScreenshot(String windowHandle,
                            String filePath,
                            String variableName)

Constructs a ZestClientScreenshot with the given file path and variable name.

Parameters:

windowHandle - the window handle to obtain the client.

filePath - the path to the file where to save the screenshot, might be null.

variableName - the name of the variable where to save the screenshot (Base64 encoded), might be null.

Method Detail

getWindowHandle

public String getWindowHandle()

Gets the window handle.

Returns:

the window handle, might be null.

setWindowHandle

public void setWindowHandle(String windowHandle)

Sets the window handle.

Parameters:

windowHandle - the new window handle.

getFilePath

public String getFilePath()

Gets the path to the file.

Returns:

the path to the file, might be null.

setFilePath

public void setFilePath(String filePath)

Sets the path to the file.

Variables are replaced before using the path.

Parameters:

filePath - the path to the file.

getVariableName

public String getVariableName()

Gets the name of the variable.

Returns:

the name of the variable, might be null.

setVariableName

public void setVariableName(String variableName)

Sets the name of the variable.

Parameters:

variableName - the name of the variable.

invoke

public String invoke(ZestRuntime runtime)
              throws ZestClientFailException

Specified by:

invoke in class ZestClient

Throws:

ZestClientFailException

deepCopy

public ZestClientScreenshot deepCopy()

Description copied from class: ZestElement

Deep copy.

Specified by:

deepCopy in class ZestStatement

Returns:

the zest element

isPassive

public boolean isPassive()

Description copied from class: ZestStatement

Checks if is passive.

Specified by:

isPassive in class ZestStatement

Returns:

true, if is passive