Package com.hp.lft.sdk.web

Class AreaDescription

java.lang.Object

com.hp.lft.sdk.internal.PropertiesDescriptionBase

com.hp.lft.sdk.PropertiesDescription

com.hp.lft.sdk.DescriptionBase

com.hp.lft.sdk.web.WebBaseDescription

com.hp.lft.sdk.web.WebElementDescription

com.hp.lft.sdk.web.AreaDescription

All Implemented Interfaces:

CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable

public class AreaDescription
extends WebElementDescription

The description of a Web Area test object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AreaDescription.Builder	This class can be used to construct an instance of the AreaDescription class using the builder pattern.
protected static class	AreaDescription.Init<T extends AreaDescription.Init<T>>	Helper class for AreaDescription.Builder.

Field Summary

Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

properties

Constructor Summary

Constructors

Modifier	Constructor	Description
	AreaDescription()	Initializes a new instance of the AreaDescription class.
protected	AreaDescription(AreaDescription.Init<?> init)	Initializes a new instance of the AreaDescription class using the Builder pattern.

Method Summary

Modifier and Type	Method	Description
StringProperty	getAlt()	Returns the alternative text that will be displayed instead of the image.
int[]	getCoords()	Returns the coordinates of an area in an image-map.
StringProperty	getHref()	Returns the link's target without the last /.
StringProperty	getMapName()	Returns the name of the map element the image uses to define the area inside the image.
StringProperty	getSrc()	Returns the image source in URL format.
StringProperty	getTarget()	Returns the name of the frame that will be navigated when user clicks on the frame.
ImageType	getType()	Returns the image type.
void	setAlt(StringProperty alt)	Sets the object's tooltip text.
void	setAlt(String alt)	Sets the alternative text that will be displayed instead of the image.
void	setCoords(int[] coords)	Sets the coordinates of an area in an image-map.
void	setHref(StringProperty href)	Sets the link's target without the last /.
void	setHref(String href)	Sets the link's target without the last /.
void	setMapName(StringProperty mapName)	Sets the name of the map element the image uses to define the area inside the image.
void	setMapName(String mapName)	Sets the name of the map element the image uses to define the area inside the image.
void	setSrc(StringProperty src)	Sets the image source in URL format.
void	setSrc(String src)	Sets the image source in URL format.
void	setTarget(StringProperty target)	Sets the name of the frame that will be navigated when user clicks on the frame.
void	setTarget(String target)	Sets the name of the frame that will be navigated when user clicks on the frame.
void	setType(ImageType type)	Sets the image type.

Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath

Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible

Methods inherited from class com.hp.lft.sdk.DescriptionBase

getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, setVRI, setVRI

Methods inherited from class com.hp.lft.sdk.PropertiesDescription

clone

Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

getValueAs, getValueAsStringProperty, insertValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.lft.sdk.CloneableObject

clone

Constructor Details

AreaDescription

public AreaDescription()

Initializes a new instance of the AreaDescription class.

AreaDescription

protected AreaDescription(AreaDescription.Init<?> init)

Initializes a new instance of the AreaDescription class using the Builder pattern.

Parameters:

init - the Builder pattern.

Method Details

setAlt

public void setAlt(StringProperty alt)

Sets the object's tooltip text.

Parameters:

alt - a StringProperty(or RegExpProperty) representing the alternative text that will be displayed instead of the image.

setAlt

public void setAlt(String alt)

Sets the alternative text that will be displayed instead of the image.

Parameters:

alt - the alternative text that will be displayed instead of the image.

getAlt

public StringProperty getAlt()

Returns the alternative text that will be displayed instead of the image.

Returns:

the alternative text that will be displayed instead of the image.

setSrc

public void setSrc(StringProperty src)

Sets the image source in URL format.

Parameters:

src - a StringProperty(or RegExpProperty) representing the image source in URL format.

setSrc

public void setSrc(String src)

Sets the image source in URL format.

Parameters:

src - the image source in URL format.

getSrc

public StringProperty getSrc()

Returns the image source in URL format.

Returns:

the image source in URL format.

setTarget

public void setTarget(StringProperty target)

Sets the name of the frame that will be navigated when user clicks on the frame.

Parameters:

target - a StringProperty(or RegExpProperty) representing the name of the frame that will be navigated when user clicks on the frame.

setTarget

public void setTarget(String target)

Sets the name of the frame that will be navigated when user clicks on the frame.

Parameters:

target - the name of the frame that will be navigated when user clicks on the frame.

getTarget

public StringProperty getTarget()

Returns the name of the frame that will be navigated when user clicks on the frame.

Returns:

the name of the frame that will be navigated when user clicks on the frame.

setHref

public void setHref(StringProperty href)

Sets the link's target without the last /.

Parameters:

href - a StringProperty(or RegExpProperty) representing the link's target without the last /.

setHref

public void setHref(String href)

Sets the link's target without the last /.

Parameters:

href - the link's target without the last /.

getHref

public StringProperty getHref()

Returns the link's target without the last /.

Returns:

the link's target without the last /.

setType

public void setType(ImageType type)

Sets the image type.

Parameters:

type - the image type.

getType

public ImageType getType()

Returns the image type.

Returns:

the image type.

setMapName

public void setMapName(StringProperty mapName)

Sets the name of the map element the image uses to define the area inside the image.

Parameters:

mapName - a StringProperty(or RegExpProperty) representing the name of the map element the image uses to define the area inside the image.

setMapName

public void setMapName(String mapName)

Sets the name of the map element the image uses to define the area inside the image.

Parameters:

mapName - the name of the map element the image uses to define the area inside the image.

getMapName

public StringProperty getMapName()

Returns the name of the map element the image uses to define the area inside the image.

Returns:

the name of the map element the image uses to define the area inside the image.

setCoords

public void setCoords(int[] coords)

Sets the coordinates of an area in an image-map. The coordinates format is determined by the shape of the area, in the following manner:
shape="rect" - x1,y1,x2,y2.
shape="circle" - x,y,radius
shape="poly" - x1,y1,x2,y2,..,xn,yn

Parameters:

coords - the coordinates of an area in an image-map.

getCoords

public int[] getCoords()

Returns the coordinates of an area in an image-map. The coordinates format is determined by the shape of the area, in the following manner:
shape="rect" - x1,y1,x2,y2.
shape="circle" - x,y,radius
shape="poly" - x1,y1,x2,y2,..,xn,yn

Returns:

the coordinates of an area in an image-map.