org.jemmy.control

Class Wrap<CONTROL>

java.lang.Object

org.jemmy.control.Wrap<CONTROL>

Type Parameters:

CONTROL - type of the encapsulated object.

Direct Known Subclasses:

ScreenRectangle

@ControlType(value=java.lang.Object.class)
 @ControlInterfaces(value={Mouse.class,Keyboard.class,Drag.class})
public abstract class Wrap<CONTROL>
extends Object

This is a wrap which holds reference to a control without UI hierarchy. It also encapsulates all the logic to deal with the underlying control, in terms of implementations of ControlInterface.

Author:

shura, erikgreijus

See Also:

as(java.lang.Class), is(java.lang.Class)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOUNDS_PROP_NAME
static String	CLICKPOINT_PROP_NAME
static String	CONTROL_CLASS_PROP_NAME
static String	CONTROL_PROP_NAME
static String	IMAGE_CAPTURER_PROPERTY
static String	IMAGE_LOADER_PROPERTY
static String	INPUT_FACTORY_PROPERTY
static String	NAME_PROP_NAME
static String	OUTPUT
static String	POSITION_PROP_NAME
static String	TEXT_PROP_NAME
static String	TOOLTIP_PROP_NAME
static String	VALUE_PROP_NAME
static Timeout	WAIT_STATE_TIMEOUT
static String	WRAPPER_CLASS_PROP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Wrap(Environment env) Fur null source.
protected	Wrap(Environment env, CONTROL node)

Method Summary

Modifier and Type	Method and Description
<INTERFACE extends ControlInterface> INTERFACE	as(Class<INTERFACE> interfaceClass) Returns an implementation of interface associated with this object.
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE	as(Class<INTERFACE> interfaceClass, Class<TYPE> type) Returns an implementation of interface associated with the object.
Drag	drag() A shortcut to as(MouseTarget.class).drag()
Point	getClickPoint() Return default point to click, drag.
CONTROL	getControl()
Class<?>	getControlClass()
Environment	getEnvironment()
Object	getFieldProperty(String name)
Object	getMethodProperty(String name)
HashMap<String,Object>	getProperties() Returns a a map of all known controls properties including values from methods marked by @Property and values of methods/field from @MethodProperties/ FieldProperties correspondingly.
HashMap<String,Object>	getPropertiesQiuet() Returns a a map of all controls properties which is possible to obtain.
<P> P	getProperty(Class<P> valueClass, String name)
Object	getProperty(String name) Get property of the wrapped object.
<INTERFACE extends ControlInterface> Object	getProperty(String name, Class<INTERFACE> intrfc) Get property out of the control interface.
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> Object	getProperty(String name, Class<INTERFACE> intrfc, Class<TYPE> type) Get property out of the control interface.
abstract Rectangle	getScreenBounds() Returns control bounds in screen coordinates.
Image	getScreenImage() Captures the screen area held by the component.
Image	getScreenImage(Rectangle rect) Captures portion of the screen area held by the component.
static DefaultWrapper	getWrapper()
boolean	hasFieldProperty(String name)
boolean	hasMethodProperty(String name)
<INTERFACE extends ControlInterface> boolean	is(Class<INTERFACE> interfaceClass) Checks if the control could be treated as a ControlInterface.
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> boolean	is(Class<INTERFACE> interfaceClass, Class<TYPE> type) Checks if the control could be treated as a parametrized ControlInterface.
Keyboard	keyboard() A shortcut to as(KeyTarget.class).wrap()
Mouse	mouse() A shortcut to as(MouseTarget.class).mouse()
void	setEnvironment(Environment env)
Point	toAbsolute(Point local) Transforms point in local control coordinate system to screen coordinates.
Point	toLocal(Point local) Transforms point in screen coordinates to local control coordinate system.
void	waitImage(Image golden, Rectangle rect, String resID, String diffID) Waits for a portion of image to be exact the same as the parameter.
void	waitImage(Image golden, String resID, String diffID) Waits for image to be exact the same as the parameter.
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> void	waitProperty(String property, Class<INTERFACE> intrfc, Class<TYPE> type, Object value) Wait for the property property of control interface to get the specified value.
<INTERFACE extends ControlInterface> void	waitProperty(String property, Class<INTERFACE> intrfc, Object value) Wait for the property property of control interface to get the specified value.
void	waitProperty(String property, Object value) Wait for the property property to get the specified value.
<V> V	waitState(State<V> state)
<V> V	waitState(State<V> state, V value) TODO javadoc

Methods inherited from class java.lang.Object

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

Field Detail

BOUNDS_PROP_NAME

public static final String BOUNDS_PROP_NAME

See Also:

Constant Field Values

CLICKPOINT_PROP_NAME

public static final String CLICKPOINT_PROP_NAME

See Also:

Constant Field Values

CONTROL_CLASS_PROP_NAME

public static final String CONTROL_CLASS_PROP_NAME

See Also:

Constant Field Values

CONTROL_PROP_NAME

public static final String CONTROL_PROP_NAME

See Also:

Constant Field Values

INPUT_FACTORY_PROPERTY

public static final String INPUT_FACTORY_PROPERTY

See Also:

Constant Field Values

IMAGE_LOADER_PROPERTY

public static final String IMAGE_LOADER_PROPERTY

See Also:

Constant Field Values

IMAGE_CAPTURER_PROPERTY

public static final String IMAGE_CAPTURER_PROPERTY

See Also:

Constant Field Values

TEXT_PROP_NAME

public static final String TEXT_PROP_NAME

See Also:

Constant Field Values

POSITION_PROP_NAME

public static final String POSITION_PROP_NAME

See Also:

Constant Field Values

VALUE_PROP_NAME

public static final String VALUE_PROP_NAME

See Also:

Constant Field Values

WRAPPER_CLASS_PROP_NAME

public static final String WRAPPER_CLASS_PROP_NAME

See Also:

Constant Field Values

TOOLTIP_PROP_NAME

public static final String TOOLTIP_PROP_NAME

See Also:

Constant Field Values

NAME_PROP_NAME

public static final String NAME_PROP_NAME

See Also:

Constant Field Values

WAIT_STATE_TIMEOUT

public static final Timeout WAIT_STATE_TIMEOUT

OUTPUT

public static final String OUTPUT

Constructor Detail

Wrap

protected Wrap(Environment env)

Fur null source.

Parameters:

env - The environment

See Also:

Environment

Wrap

protected Wrap(Environment env,
               CONTROL node)

Parameters:

env - The environment

node - The encapsulated object

See Also:

Environment

Method Detail

getWrapper

public static DefaultWrapper getWrapper()

getEnvironment

public Environment getEnvironment()

Returns:

environment instance used by this

See Also:

Environment

setEnvironment

public void setEnvironment(Environment env)

getControl

@Property(value="control")
public CONTROL getControl()

Returns:

The encapsulated object

getClickPoint

@Property(value="clickPoint")
public Point getClickPoint()

Return default point to click, drag. This implementation returns the center must be overriden if something different is desired.

Returns:

the default click point

getScreenBounds

@Property(value="bounds")
public abstract Rectangle getScreenBounds()

Returns control bounds in screen coordinates. These bounds could include parts that are covered by other controls or clipped out by parent components. If the control is not shown JemmyException will be thrown.

Returns:

control bounds in screen coordinates.

Throws:

JemmyException - if the control is not visible

toAbsolute

public Point toAbsolute(Point local)

Transforms point in local control coordinate system to screen coordinates.

Parameters:

local - the local coordinate

Returns:

a absolute translated point

See Also:

toLocal(org.jemmy.Point)

toLocal

public Point toLocal(Point local)

Transforms point in screen coordinates to local control coordinate system.

Parameters:

local - the local coordinate

Returns:

coordinates which should be used for mouse operations.

See Also:

toAbsolute(org.jemmy.Point)

getScreenImage

public Image getScreenImage()

Captures the screen area held by the component. ImageFactory performs the actual capturing.

Returns:

TODO find a replacement

getScreenImage

public Image getScreenImage(Rectangle rect)

Captures portion of the screen area held by the component. ImageFactory performs the actual capturing.

Parameters:

rect - Part of the control to capture

Returns:

TODO find a replacement

waitImage

public void waitImage(Image golden,
                      Rectangle rect,
                      String resID,
                      String diffID)

Waits for a portion of image to be exact the same as the parameter.

Parameters:

golden - the image to match against

rect - A portion of control to compare.

resID - ID of a result image to save in case of failure. No image saved if null.

diffID - ID of a diff image to save in case of failure. No image saved if null.

See Also:

as(java.lang.Class)

waitImage

public void waitImage(Image golden,
                      String resID,
                      String diffID)

Waits for image to be exact the same as the parameter.

Parameters:

golden - the image to match against

resID - ID of a result image to save in case of failure. No image saved if null.

diffID - ID of a diff image to save in case of failure. No image saved if null.

See Also:

as(java.lang.Class)

waitState

public <V> V waitState(State<V> state,
                       V value)

TODO javadoc

Type Parameters:

V - the states type

Parameters:

state - the state

value - the state value

Returns:

last returned State value

Throws:

TimeoutExpiredException - in case the wait is unsuccessful.

waitState

public <V> V waitState(State<V> state)

Type Parameters:

V - the states type

Parameters:

state - the state

Returns:

last returned State value

Throws:

TimeoutExpiredException - in case the wait is unsuccessful.

is

public <INTERFACE extends ControlInterface> boolean is(Class<INTERFACE> interfaceClass)

Checks if the control could be treated as a ControlInterface. If it is, Wrap#as(java.lang.Class) will be called. This implementation checks whether the class implements the necessary interface. It also works for root interfaces such as MouseTarget and KeyTarget, which implementations are encapsulated. If some other functionality is desired, must be overriden together with as(java.lang.Class)

Type Parameters:

INTERFACE - the control interface

Parameters:

interfaceClass - the interface class

Returns:

true if the control is an ControlInterface, false otherwise

See Also:

is(java.lang.Class)

is

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> boolean is(Class<INTERFACE> interfaceClass,
                                                                      Class<TYPE> type)

Checks if the control could be treated as a parametrized ControlInterface. If it is, Wrap#as(java.lang.Class, java.lang.Class) will be called. This implementation checks whether the class implements the necessary interface. It also works for root interfaces such as MouseTarget and KeyTarget, which implementations are encapsulated. If some other functionality is desired, must be overriden together with as(java.lang.Class)

Type Parameters:

TYPE - the type interface

INTERFACE - the control interface

Parameters:

interfaceClass - the interface class

type - The parameter class.

Returns:

true if the control is an ControlInterface, false otherwise

See Also:

is(java.lang.Class)

as

public <INTERFACE extends ControlInterface> INTERFACE as(Class<INTERFACE> interfaceClass)

Returns an implementation of interface associated with this object. First it checks

Type Parameters:

INTERFACE - the control interface

Parameters:

interfaceClass - the interface class

Returns:

the control interface instance

See Also:

is(java.lang.Class)

as

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE as(Class<INTERFACE> interfaceClass,
                                                                        Class<TYPE> type)

Returns an implementation of interface associated with the object.

Type Parameters:

TYPE - the type interface

INTERFACE - the control interface

Parameters:

interfaceClass - the interface class

type - The parameter class.

Returns:

the type control instance

See Also:

is(java.lang.Class)

mouse

@As(value=Mouse.class)
public Mouse mouse()

A shortcut to as(MouseTarget.class).mouse()

Returns:

the mouse target

drag

@As(value=Drag.class)
public Drag drag()

A shortcut to as(MouseTarget.class).drag()

Returns:

the drag target

keyboard

@As(value=Keyboard.class)
public Keyboard keyboard()

A shortcut to as(KeyTarget.class).wrap()

Returns:

the wrap target

getControlClass

@Property(value="control.class")
public Class<?> getControlClass()

getProperty

public Object getProperty(String name)

Get property of the wrapped object. Uses first available from

1. methods annotated by org.jemmy.control.Property
2. wrapped object methods listed in org.jemmy.control.MethodProperties
3. wrapped object fields listed in org.jemmy.control.FieldProperties

Parameters:

name - property name

Returns:

property value

Throws:

JemmyException - if no property found

See Also:

Property, MethodProperties, FieldProperties

getProperty

public <INTERFACE extends ControlInterface> Object getProperty(String name,
                                                               Class<INTERFACE> intrfc)

Get property out of the control interface. Refer to the interface doc to find out what properties are provided.

Type Parameters:

INTERFACE - the control interface

Parameters:

name - the property name

intrfc - the interface class

Returns:

the control property

getProperty

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> Object getProperty(String name,
                                                                              Class<INTERFACE> intrfc,
                                                                              Class<TYPE> type)

Get property out of the control interface. Refer to the interface doc to find out what properties are provided.

Type Parameters:

TYPE - the type interface

INTERFACE - the control interface

Parameters:

name - the property name

intrfc - the interface class

type - The parameter class.

Returns:

the control property

waitProperty

public void waitProperty(String property,
                         Object value)

Wait for the property property to get the specified value. WAIT_STATE_TIMOUT timeout is used

Parameters:

property - name of the property being waited for

value - property value to wait

waitProperty

public <INTERFACE extends ControlInterface> void waitProperty(String property,
                                                              Class<INTERFACE> intrfc,
                                                              Object value)

Wait for the property property of control interface to get the specified value. WAIT_STATE_TIMOUT timeout is used

Type Parameters:

INTERFACE - the control interface

Parameters:

property - the property name

intrfc - the interface class

value - the new parameter value

waitProperty

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> void waitProperty(String property,
                                                                             Class<INTERFACE> intrfc,
                                                                             Class<TYPE> type,
                                                                             Object value)

Wait for the property property of control interface to get the specified value. WAIT_STATE_TIMOUT timeout is used

Type Parameters:

TYPE - the type interface

INTERFACE - the control interface

Parameters:

property - the property name

intrfc - the interface class

type - the parameter class.

value - the new parameter value

hasFieldProperty

public boolean hasFieldProperty(String name)

hasMethodProperty

public boolean hasMethodProperty(String name)

getFieldProperty

public Object getFieldProperty(String name)

getMethodProperty

public Object getMethodProperty(String name)

getProperty

public <P> P getProperty(Class<P> valueClass,
                         String name)

getProperties

public HashMap<String,Object> getProperties()

Returns a a map of all known controls properties including values from methods marked by @Property and values of methods/field from @MethodProperties/ FieldProperties correspondingly.

Returns:

a map of properties

Throws:

RuntimeException - should there be an exception thrown while getting a property

getPropertiesQiuet

public HashMap<String,Object> getPropertiesQiuet()

Returns a a map of all controls properties which is possible to obtain. Similar to getProperties() only exception is swallowed should there be an exception thrown while getting a property.

Returns:

a map of properties which were possible to obtain.