com.tplan.robot.scripting

Class TemplateImageBean

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

com.tplan.robot.scripting.TemplateImageBean

All Implemented Interfaces:

com.tplan.robot.gui.components.PropertyFileDescriptor, Serializable, Cloneable, Map<Object,Object>

public class TemplateImageBean
extends Properties
implements com.tplan.robot.gui.components.PropertyFileDescriptor

Template image bean is a container for data from the template image meta data file. It gets saved by T-Plan Robot Enterprise when the template image is created or edited. To populate the bean with data of an existing template image create a new bean instance using its default constructor and then call the loadImageProperties(java.io.File) method to associate it with a particular template image (any existing meta data will be loaded by this method).

Image bean of the last compared template is also available to test scripts through the ScriptingContext.getSearchHitTemplateMetaData() method..

See Also:

Serialized Form

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_CLICK_X Click point X coordinate parameter name.
static String	PARAM_CLICK_Y Click point Y coordinate parameter name.
static String	PARAM_DESCRIPTION Description parameter name.
static String	PARAM_DESKTOP_HEIGHT Source desktop height parameter name.
static String	PARAM_DESKTOP_WIDTH Source desktop width parameter name.
static String	PARAM_HEIGHT Image height parameter name.
static String	PARAM_SOURCE_X Source X coordinate parameter name.
static String	PARAM_SOURCE_Y Source Y coordinate parameter name.
static String	PARAM_WIDTH Image width parameter name..

Constructor Summary

Constructors

Constructor and Description
TemplateImageBean()

Method Summary

Modifier and Type	Method and Description
boolean	canAddCustomProperties() Indicates whether the editor should allow inserting of custom properties.
Point	getClickPoint() Get the image click point.
String	getDescription() Get the template image description.
Dimension	getDesktopSize() Get the desktop image size.
File	getFile() Get the bean meta data file.
Integer	getHeight() Get image height.
File	getImageFile() Get the image file.
String	getPropertyDescription(String propertyName) Get description of a property.
String[]	getPropertyNames() Get acceptable or known property names.
Class	getPropertyType(String propertyName) Get the property value type.
Dimension	getSize() Get image size.
Point	getSourcePoint() Get the template image source point.
Rectangle	getSourceRectangle() Get the source rectangle (the original template image location in the desktop image).
Integer	getWidth() Get image width.
boolean	loadImageProperties(File imageFile) Load image meta data of a template image file.
boolean	save() Save the data to the meta data file.
static void	saveImage(File imgFile, Dimension screenSize, BufferedImage img, Rectangle r, Point p) Save a template image and create its property file (template image bean).
void	setClickPoint(Point p) Set the image click point.
void	setDescription(String desc) Set the template image description.
void	setDesktopSize(int width, int height) Set size of the desktop the image was created from.
void	setSize(int width, int height) Set the image size.
void	setSourcePoint(Point p) Set the template image source point.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_SOURCE_X

public static final String PARAM_SOURCE_X

Source X coordinate parameter name.

See Also:

Constant Field Values

PARAM_SOURCE_Y

public static final String PARAM_SOURCE_Y

Source Y coordinate parameter name.

See Also:

Constant Field Values

PARAM_WIDTH

public static final String PARAM_WIDTH

Image width parameter name..

See Also:

Constant Field Values

PARAM_HEIGHT

public static final String PARAM_HEIGHT

Image height parameter name.

See Also:

Constant Field Values

PARAM_CLICK_X

public static final String PARAM_CLICK_X

Click point X coordinate parameter name.

See Also:

Constant Field Values

PARAM_CLICK_Y

public static final String PARAM_CLICK_Y

Click point Y coordinate parameter name.

See Also:

Constant Field Values

PARAM_DESCRIPTION

public static final String PARAM_DESCRIPTION

Description parameter name.

See Also:

Constant Field Values

PARAM_DESKTOP_WIDTH

public static final String PARAM_DESKTOP_WIDTH

Source desktop width parameter name.

Since:

4.0

See Also:

Constant Field Values

PARAM_DESKTOP_HEIGHT

public static final String PARAM_DESKTOP_HEIGHT

Source desktop height parameter name.

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

TemplateImageBean

public TemplateImageBean()

Method Detail

loadImageProperties

public boolean loadImageProperties(File imageFile)
                            throws IOException

Load image meta data of a template image file. The meta data file name is derived from the image one specified in the argument.

Parameters:

imageFile - a template image file.

Returns:

true if this container is successfully associated with the template image (and eventually loaded from the meta data file if it exists). False is returned only when the argument file is null.

Throws:

IOException - if the meta data file exists but can not be read.

save

public boolean save()
             throws IOException

Save the data to the meta data file.

Returns:

true if the data was saved, false if the container is not associated with any particular template image.

Throws:

IOException - on an I/O error.

getDescription

public String getDescription()

Get the template image description.

Returns:

template image description.

setDescription

public void setDescription(String desc)

Set the template image description.

Parameters:

desc - template image description.

setClickPoint

public void setClickPoint(Point p)

Set the image click point. It is a point relative to the image top left corner which defines where to click when the image is located on the screen. It usually defaults to the template image center.

Parameters:

p - new click point (null unsets).

getClickPoint

public Point getClickPoint()

Get the image click point. It is a point relative to the image top left corner which defines where to click when the image is located on the screen. It usually defaults to the template image center.

Returns:

the click point or null if it is not defined.

setSourcePoint

public void setSourcePoint(Point p)

Set the template image source point. It is the location in the screen the template image was originally cropped from. It may be used for testing of whether the component has moved.

Parameters:

p - a new value of source point.

getSourcePoint

public Point getSourcePoint()

Get the template image source point. It is the location in the screen the template image was originally cropped from. It may be used for testing of whether the component has moved.

Returns:

the source point or null if it is not defined.

setSize

public void setSize(int width,
                    int height)

Set the image size. It is provided in the meta data just for convenience and for cases where the size is needed but loading of the image itself would be too slow.

Parameters:

width - image width.

height - image height.

setDesktopSize

public void setDesktopSize(int width,
                           int height)

Set size of the desktop the image was created from. To remove the desktop size parameters from the bean specify the width or height lower than zero.

Parameters:

width - desktop image width.

height - desktop image height.

Since:

4.0

getSize

public Dimension getSize()

Get image size.

Returns:

image size or null if it was not initialized.

getDesktopSize

public Dimension getDesktopSize()

Get the desktop image size.

Returns:

desktop image size or null if it was not initialized.

Since:

4.0

getWidth

public Integer getWidth()

Get image width.

Returns:

image width or null if the parameter hasn't been initialized.

getHeight

public Integer getHeight()

Get image height.

Returns:

image width or null if the parameter hasn't been initialized.

getSourceRectangle

public Rectangle getSourceRectangle()

Get the source rectangle (the original template image location in the desktop image). This is just a convenience method which loads the source point and image size and uses them to construct a java.awt.Rectangle instance.

Returns:

source rectangle (location where the template image was originally cut from).

getFile

public File getFile()

Get the bean meta data file. The method returns a non-null value only if the bean has been associated with an existing template image through the loadImageProperties(java.io.File) method.

Returns:

the file

getImageFile

public File getImageFile()

Get the image file. The method returns a non-null value only if the bean has been associated with an existing template image through the loadImageProperties(java.io.File) method.

Returns:

the image file.

saveImage

public static void saveImage(File imgFile,
                             Dimension screenSize,
                             BufferedImage img,
                             Rectangle r,
                             Point p)
                      throws IOException

Save a template image and create its property file (template image bean).

Parameters:

imgFile - the image file.

screenSize - the source screen size.

img - the template image to save.

r - the template image rectangle.

p - the target click point (in absolute screen coordinates). It will be converted to relative coordinates internally.

Throws:

IOException - when either the image or the bean fails to save to file.

Since:

4.0

getPropertyDescription

public String getPropertyDescription(String propertyName)

Description copied from interface: com.tplan.robot.gui.components.PropertyFileDescriptor

Get description of a property. The editor will display it as a hint.

Specified by:

getPropertyDescription in interface com.tplan.robot.gui.components.PropertyFileDescriptor

Parameters:

propertyName - the property name.

Returns:

the property description (plain text or HTML).

getPropertyType

public Class getPropertyType(String propertyName)

Description copied from interface: com.tplan.robot.gui.components.PropertyFileDescriptor

Get the property value type. It may be used to identify the most appropriate editor for the value, for example a text field for String.class or number spinner for Integer.class.

Specified by:

getPropertyType in interface com.tplan.robot.gui.components.PropertyFileDescriptor

Parameters:

propertyName - the property name.

Returns:

the value type.

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: com.tplan.robot.gui.components.PropertyFileDescriptor

Get acceptable or known property names.

Specified by:

getPropertyNames in interface com.tplan.robot.gui.components.PropertyFileDescriptor

Returns:

the array of acceptable property names.

canAddCustomProperties

public boolean canAddCustomProperties()

Description copied from interface: com.tplan.robot.gui.components.PropertyFileDescriptor

Indicates whether the editor should allow inserting of custom properties.

Specified by:

canAddCustomProperties in interface com.tplan.robot.gui.components.PropertyFileDescriptor

Returns:

false if the editor should allow to insert only properties enumerated in PropertyFileDescriptor.getPropertyNames(). Return true to enable any property names.