Link

Java. Link

The description of a Java Link test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a Java Link test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
Link

Methods

absoluteLocation(location[opt]) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

attachedText(attachedText[opt]) → {string|Description}

The object's attached text.
Parameters:
NameTypeAttributesDescription
attachedTextstring <optional>
When provided, this method acts as a setter and sets the attachedText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attachedText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

backgroundColor(backgroundColor[opt]) → {string|Description}

The object's background color.
Parameters:
NameTypeAttributesDescription
backgroundColorstring <optional>
When provided, this method acts as a setter and sets the backgroundColor value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored backgroundColor value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

foregroundColor(foregroundColor[opt]) → {string|Description}

The object's foreground color.
Parameters:
NameTypeAttributesDescription
foregroundColorstring <optional>
When provided, this method acts as a setter and sets the foreground value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored foreground value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isEnabled(isEnabled[opt]) → {boolean|Description}

Indicates whether the object is enable.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <optional>
When provided, this method acts as a setter and sets the isEnabled value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isFocused(isFocused[opt]) → {boolean|Description}

Indicates whether the object is focused.
Parameters:
NameTypeAttributesDescription
isFocusedboolean <optional>
When provided, this method acts as a setter and sets the isFocused value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isFocused value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisible[opt]) → {boolean|Description}

Indicates whether the object is visible.
Parameters:
NameTypeAttributesDescription
isVisibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

label(label[opt]) → {string|Description}

The object's label.
Parameters:
NameTypeAttributesDescription
labelstring <optional>
When provided, this method acts as a setter and sets the label value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored label value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

location(location[opt]) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

nativeClass(nativeClass[opt]) → {string|Description}

The object's class name.
Parameters:
NameTypeAttributesDescription
nativeClassstring <optional>
When provided, this method acts as a setter and sets the nativeClass value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored nativeClass value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectName(objectName[opt]) → {string|Description}

The object's object name.
Parameters:
NameTypeAttributesDescription
objectNamestring <optional>
When provided, this method acts as a setter and sets the objectName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

path(path[opt]) → {string|Description}

The object's hierarchy (object ancestors).
Parameters:
NameTypeAttributesDescription
pathstring <optional>
When provided, this method acts as a setter and sets the path value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored path value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

size(size[opt]) → {Size|Description}

The object's size in pixels.
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

tagName(tag name[opt]) → {string|Description}

The tag name associated with the object.
Parameters:
NameTypeAttributesDescription
tag namestring <optional>
When provided, this method acts as a setter and sets the tag name value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored tagName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

text(text[opt]) → {string|Description}

The text displayed in the link object.
Parameters:
NameTypeAttributesDescription
textstring <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description