Label

SAPGUI. Label

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

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

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

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

The name of the icon used in the label.
Parameters:
NameTypeAttributesDescription
iconNamestring <optional>
When provided, this method acts as a setter and sets the iconName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored iconName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | 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

isHighlighted(isHighlighted[opt]) → {boolean|Description}

Indicates whether the label is highlighted.
Parameters:
NameTypeAttributesDescription
isHighlightedboolean <optional>
When provided, this method acts as a setter and sets the isHighlighted value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isHighlighted value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isNumerical(isNumerical[opt]) → {boolean|Description}

Indicates whether the label is a numeric field.
Parameters:
NameTypeAttributesDescription
isNumericalboolean <optional>
When provided, this method acts as a setter and sets the isNumerical value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isNumerical 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

maxLength(maxLength[opt]) → {number|Description}

The maximum number of characters that can be displayed in the label.
Parameters:
NameTypeAttributesDescription
maxLengthnumber <optional>
When provided, this method acts as a setter and sets the maxLength value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxLength value; otherwise it returns 'this' for use with the builder pattern.
Type
number | 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

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

The labels's unique identifier relative to the parent window ID in text format.
Parameters:
NameTypeAttributesDescription
relativeIdstring <optional>
When provided, this method acts as a setter and sets the relativeId value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored relativeId 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}

Either the text string or the icon name of the label.
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