Constructor
new CheckBox(propsopt) → {CheckBox}
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
canFocus(canFocusopt) → {boolean|Description}
This object's name as set by the developer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
canFocus | boolean |
<optional> | When provided, this method acts as a setter and sets the canFocus value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored canFocus value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
fullNamePath(fullNamePathopt) → {string|Description}
The full hierarchy of the object's name with all parent objects.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fullNamePath | string |
<optional> | When provided, this method acts as a setter and sets the fullNamePath value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullNamePath value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
fullType(fullTypeopt) → {string|Description}
The full type name of this object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fullType | string |
<optional> | When provided, this method acts as a setter and sets the fullType value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullType value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
helpText(helptextopt) → {string|Description}
The check box's help text.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
helptext | string |
<optional> | When provided, this method acts as a setter and sets the helptext value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored helptext value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
isChecked(IsCheckedopt) → {boolean|Description}
The check box's IsChecked value.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
IsChecked | boolean |
<optional> | When provided, this method acts as a setter and sets the IsChecked value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current IsChecked value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
isEnabled(isEnabledopt) → {boolean|Description}
Indicates whether the object is enable.
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
isThreeState(IsThreeStateopt) → {boolean|Description}
The check box's IsThreeState value.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
IsThreeState | boolean |
<optional> | When provided, this method acts as a setter and sets the IsThreeState value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current IsThreeState 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
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 native class.
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}
This object's name as set by the developer.
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
objectProperties(objectPropertiesopt) → {object|Description}
The concrete test object properties including custom properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectProperties | object |
<optional> | When provided, this method acts as a setter and sets the objectProperties value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectProperties value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- object | Description
parentText(parentTextopt) → {string|Description}
The text associated with the parent of the check box.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parentText | string |
<optional> | When provided, this method acts as a setter and sets the parentText value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored parentText 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 check box's state.
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 state value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- CheckedState | Description
text(textopt) → {string|Description}
The text associated with the object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
text | string |
<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
windowTitleRegExp(windowClassRegExpopt) → {string|Description}
The constant part of the window title.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
windowClassRegExp | string |
<optional> | When provided, this method acts as a setter and sets the windowTitleRegExp value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowTitleRegExp value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
