Button

Oracle. Button

The description of an Oracle button.

new Button(propsopt) → {Button}

Parameters:

NameTypeAttributesDescription
propsObject <optional>
Initializes an Oracle button test object using the supplied property bag.

Returns:

the description object that was initialized.
Type
Button

Methods

absoluteLocation(locationopt) → {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

classPath(classPathopt) → {string|Description}

The Oracle class hierarchy of the object's Oracle class.

Parameters:

NameTypeAttributesDescription
classPathstring <optional>
When provided, this method acts as a setter and sets the classPath value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored classPath value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isEnabled(isEnabledopt) → {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

label(labelopt) → {string|Description}

The text displayed on the object.

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(locationopt) → {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

objectDescription(objectDescriptionopt) → {string|Description}

Indicates accessibility description of the object as specified by the server.

Parameters:

NameTypeAttributesDescription
objectDescriptionstring <optional>
When provided, this method acts as a setter and sets the objectDescription value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored objectDescription value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectName(objectNameopt) → {string|Description}

Indicates internal name of the object supplied by the application server.

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

objectType(objectTypeopt) → {string|Description}

The general object type.

Parameters:

NameTypeAttributesDescription
objectTypestring <optional>
When provided, this method acts as a setter and sets the objectType value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored objectType value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

size(sizeopt) → {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

tooltipText(tooltipTextopt) → {string|Description}

Indicates the text displayed in the object's tooltip.

Parameters:

NameTypeAttributesDescription
tooltipTextstring <optional>
When provided, this method acts as a setter and sets the tooltipText value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored tooltipText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description