new CheckBox(propsopt) → {CheckBox}
The description of a CheckBox test object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
Object |
<optional> |
Initializes a CheckBox test object using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- CheckBox
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:
| Name | Type | Attributes | Description |
|---|---|---|---|
location |
Point |
<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(attachedTextopt) → {string|Description}
The object's attached text.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
attachedText |
string |
<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(backgroundColoropt) → {string|Description}
The object's background color.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
backgroundColor |
string |
<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(foregroundColoropt) → {string|Description}
The object's foreground color.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
foregroundColor |
string |
<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(isEnabledopt) → {boolean|Description}
Indicates whether the object is enabled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isEnabled |
boolean |
<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(isFocusedopt) → {boolean|Description}
Indicates whether the object is focused.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isFocused |
boolean |
<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(isVisibleopt) → {boolean|Description}
Indicates whether the object is visible.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isVisible |
boolean |
<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
isWrapped(isWrappedopt) → {boolean|Description}
Indicates whether the object is wrapped inside another object.
E.g.: If an edit field is part of an editable combobox, then the edit field is wrapped inside the combobox.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isWrapped |
boolean |
<optional> |
When provided, this method acts as a setter and sets the isWrapped value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isWrapped value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
label(labelopt) → {string|Description}
The object's label.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
label |
string |
<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:
| Name | Type | Attributes | Description |
|---|---|---|---|
location |
Point |
<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(nativeClassopt) → {string|Description}
The object's class name.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
nativeClass |
string |
<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(objectNameopt) → {string|Description}
The object's object name.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectName |
string |
<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(pathopt) → {string|Description}
The object's hierarchy (object ancestors).
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
path |
string |
<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(sizeopt) → {Size|Description}
The object's size in pixels.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
size |
Size |
<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
state(stateopt) → {CheckedState|Description}
The state of the checkbox.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
state |
CheckedState |
<optional> |
When provided, this method acts as a setter and sets the state value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored state value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- CheckedState | Description
tagName(tag nameopt) → {string|Description}
The tag name associated with the object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
tag name |
string |
<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