org.jemmy.dock

Class Dock

java.lang.Object

org.jemmy.dock.Dock

public class Dock
extends Object

Superclass for all "docks" - classes which simple provide API for lookup, interfaces and properties.

Author:

shura

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DIFF_IMAGE_SUFFIX Default suffix to construct diff image name.
static String	DEFAULT_RESULT_IMAGE_SUFFIX Default suffix to construct result image name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dock(Wrap<?> wrap)

Method Summary

Modifier and Type	Method and Description
Rectangle	bounds()
Object	control()
Drag	drag()
Environment	environment()
protected <P> P	getProperty(GetAction<P> action)
Keyboard	keyboard()
protected static <T> Wrap<? extends T>	lookup(Parent<? super T> parent, Class<T> controlType, int index, LookupCriteria<T>... criteria) Method which at the end actually get called from all dock lookup constructors.
Mouse	mouse()
void	waitImage(String goldenId) Constructs names for diff and result images and waits for the control to match it.
void	waitImage(String goldenId, Rectangle rect) Constructs names for diff and result images and waits for the control to match it.
void	waitImage(String goldenId, Rectangle rect, String resID, String diffID) Loads image with goldenId id waits for the control to match it.
void	waitImage(String goldenId, String resID, String diffID) Loads image with goldenId id waits for the control to match it.
Wrap<?>	wrap()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESULT_IMAGE_SUFFIX

public static final String DEFAULT_RESULT_IMAGE_SUFFIX

Default suffix to construct result image name.

See Also:

Constant Field Values

DEFAULT_DIFF_IMAGE_SUFFIX

public static final String DEFAULT_DIFF_IMAGE_SUFFIX

Default suffix to construct diff image name.

See Also:

Constant Field Values

Constructor Detail

Dock

protected Dock(Wrap<?> wrap)

Method Detail

lookup

protected static <T> Wrap<? extends T> lookup(Parent<? super T> parent,
                                              Class<T> controlType,
                                              int index,
                                              LookupCriteria<T>... criteria)

Method which at the end actually get called from all dock lookup constructors.

Type Parameters:

T - todo document

Parameters:

parent - todo document

controlType - todo document

index - todo document

criteria - todo document

Returns:

todo document

wrap

public Wrap<?> wrap()

Returns:

Wrap instance obtainer through lookup

control

public Object control()

Returns:

Wrap instance obtainer through lookup

mouse

public Mouse mouse()

Returns:

Shortcut to wrap().mouse()

keyboard

public Keyboard keyboard()

Returns:

Shortcut to wrap().keyboard()

drag

public Drag drag()

Returns:

Shortcut to wrap().drag()

bounds

public Rectangle bounds()

Returns:

Shortcut to wrap().getScreenBounds()

getProperty

protected <P> P getProperty(GetAction<P> action)

environment

public Environment environment()

Returns:

wrap().getEnvironment().

waitImage

public void waitImage(String goldenId,
                      Rectangle rect,
                      String resID,
                      String diffID)

Loads image with goldenId id waits for the control to match it.

Parameters:

goldenId - todo document

rect - todo document

resID - todo document

diffID - todo document

See Also:

Wrap.waitImage(org.jemmy.image.Image, org.jemmy.Rectangle, java.lang.String, java.lang.String)

waitImage

public void waitImage(String goldenId,
                      Rectangle rect)

Constructs names for diff and result images and waits for the control to match it. Diff and result names constructed by adding suffixes. Suffixes are obtained from environment with default values being "-diff" and "-result"

Parameters:

goldenId - todo document

rect - todo document

See Also:

waitImage(java.lang.String, org.jemmy.Rectangle, java.lang.String, java.lang.String), DEFAULT_DIFF_IMAGE_SUFFIX, DEFAULT_RESULT_IMAGE_SUFFIX

waitImage

public void waitImage(String goldenId,
                      String resID,
                      String diffID)

Loads image with goldenId id waits for the control to match it.

Parameters:

goldenId - todo document

resID - todo document

diffID - todo document

See Also:

Wrap.waitImage(org.jemmy.image.Image, java.lang.String, java.lang.String)

waitImage

public void waitImage(String goldenId)

Constructs names for diff and result images and waits for the control to match it. Diff and result names constructed by adding suffixes. Suffixes are obtained from environment with default values being "-diff" and "-result"

Parameters:

goldenId - todo document

See Also:

waitImage(java.lang.String, java.lang.String, java.lang.String), DEFAULT_DIFF_IMAGE_SUFFIX, DEFAULT_RESULT_IMAGE_SUFFIX