Window

SAPGUI. Window

new Window(props[opt]) → {Window}

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

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

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

The element's unique identifier in text format.
Parameters:
NameTypeAttributesDescription
idstring <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(isMinimized[opt]) → {boolean|Description}

Indicates whether the window is minimized.
Parameters:
NameTypeAttributesDescription
isMinimizedboolean <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(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

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

The name of the element.
Parameters:
NameTypeAttributesDescription
namestring <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(program[opt]) → {string|Description}

The name of the SAP source program that is currently executing.
Parameters:
NameTypeAttributesDescription
programstring <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(screenNumber[opt]) → {number|Description}

The number of the currently displayed screen.
Parameters:
NameTypeAttributesDescription
screenNumbernumber <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(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

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

The text associated with the window.
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

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

The transaction the user is currently executing.
Parameters:
NameTypeAttributesDescription
transactionstring <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(type[opt]) → {SAPGUI.ComponentType|Description}

The numeric identification of the GUI component type.
Parameters:
NameTypeAttributesDescription
typeSAPGUI.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(workingPaneSize[opt]) → {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:
NameTypeAttributesDescription
workingPaneSizeSize <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