To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

StatusBar

SAPGUI. StatusBar

new StatusBar(propsopt) → {StatusBar}

The description of a StatusBar test object.
Parameters:
Name Type Attributes Description
props Object <optional>
Initializes a StatusBar test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
StatusBar

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

isMessageAsPopup(isEnabledopt) → {bool|Description}

Indicates whether the message is a pop-up.
Parameters:
Name Type Attributes Description
isEnabled bool <optional>
When provided, this method acts as a setter and sets the isMessageAsPopup value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isMessageAsPopup value; otherwise it returns 'this' for use with the builder pattern.
Type
bool | Description

items(itemsopt) → {Array.<string>|Description}

The list of the items in the status bar.
Parameters:
Name Type Attributes Description
items Array.<string> <optional>
When provided, this method acts as a setter and sets the items value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored items value; otherwise it returns 'this' for use with the builder pattern.
Type
Array.<string> | Description

itemsCount(itemsCountopt) → {Number|Description}

The number of non-empty items in the status bar.
Parameters:
Name Type Attributes Description
itemsCount number <optional>
When provided, this method acts as a setter and sets the itemsCount value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored itemsCount value; otherwise it returns 'this' for use with the builder pattern.
Type
Number | 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

messageId(messageIdopt) → {string|Description}

The ID of the message in text format.
Parameters:
Name Type Attributes Description
messageId string <optional>
When provided, this method acts as a setter and sets the messageId value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored messageId value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

messageNumber(messageNumberopt) → {string|Description}

The internal number of the message on the status bar.
Parameters:
Name Type Attributes Description
messageNumber string <optional>
When provided, this method acts as a setter and sets the messageNumber value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored messageNumber value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

messageType(messageTypeopt) → {SAPGUI.StatusBarMessageType|Description}

The internal number of the message on the status bar.
Parameters:
Name Type Attributes Description
messageType SAPGUI.StatusBarMessageType <optional>
When provided, this method acts as a setter and sets the messageType value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored messageType value; otherwise it returns 'this' for use with the builder pattern.
Type
SAPGUI.StatusBarMessageType | 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

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 string associated with the status bar.
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

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