StatusBar

SAPGUI. StatusBar

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

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

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

isMessageAsPopup(isEnabled[opt]) → {boolean|Description}

Indicates whether the message is a pop-up.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <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
boolean | Description

items(items[opt]) → {Array.<string>|Description}

The list of the items in the status bar.
Parameters:
NameTypeAttributesDescription
itemsArray.<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(itemsCount[opt]) → {number|Description}

The number of non-empty items in the status bar.
Parameters:
NameTypeAttributesDescription
itemsCountnumber <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(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

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

The ID of the message in text format.
Parameters:
NameTypeAttributesDescription
messageIdstring <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(messageNumber[opt]) → {string|Description}

The internal number of the message on the status bar.
Parameters:
NameTypeAttributesDescription
messageNumberstring <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(messageType[opt]) → {SAPGUI.StatusBarMessageType|Description}

The internal number of the message on the status bar.
Parameters:
NameTypeAttributesDescription
messageTypeSAPGUI.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(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

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

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