new Window(propsopt) → {Window}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
Object |
<optional> |
Initializes a Window test object using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- Window
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
id(idopt) → {string|Description}
The element's unique identifier in text format.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string |
<optional> |
When provided, this method acts as a setter and sets the id value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored id value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
isMinimized(isMinimizedopt) → {boolean|Description}
Indicates whether the window is minimized.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isMinimized |
boolean |
<optional> |
When provided, this method acts as a setter and sets the isMinimized value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isMinimized 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
name(nameopt) → {string|Description}
The name of the element.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string |
<optional> |
When provided, this method acts as a setter and sets the name value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
program(programopt) → {string|Description}
The name of the SAP source program that is currently executing.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
program |
string |
<optional> |
When provided, this method acts as a setter and sets the program value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored program value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
screenNumber(screenNumberopt) → {number|Description}
The number of the currently displayed screen.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
screenNumber |
number |
<optional> |
When provided, this method acts as a setter and sets the screenNumber value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored screenNumber value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- number | 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
text(textopt) → {string|Description}
The text associated with the window.
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
transaction(transactionopt) → {string|Description}
The transaction the user is currently executing.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
transaction |
string |
<optional> |
When provided, this method acts as a setter and sets the transaction value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored transaction value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
type(typeopt) → {SAPGUI.ComponentType|Description}
The numeric identification of the GUI component type.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
SAPGUI.ComponentType |
<optional> |
When provided, this method acts as a setter and sets the type value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- SAPGUI.ComponentType | Description
workingPaneSize(workingPaneSizeopt) → {Size|Description}
The window's working pane size in character metric. The working pane is the area between the toolbar and the status bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
workingPaneSize |
Size |
<optional> |
When provided, this method acts as a setter and sets the workingPaneSize value. |
Returns:
If no parameter is provided, the method acts as a getter and returns
the current stored workingPaneSize value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Size | Description