ListBox

SAPUI5. ListBox

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

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

Methods

absoluteLocation(location[opt]) → {Point|Description}

The object's absolute coordinates relative to the screen (in pixels). 0,0 is always 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

attributes(attributes[opt]) → {Object|Description}

The object's DOM attributes.
Parameters:
NameTypeAttributesDescription
attributesObject <optional>
When provided, this method acts as a setter and sets the attributes value. Specify the attribute names as object keys and set their values to the desired attribute values.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attrs object; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

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

The object's CSS class (className property).
Parameters:
NameTypeAttributesDescription
namestring <optional>
When provided, this method acts as a setter and sets the className value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored className value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

defaultValue(value[opt]) → {string|Description}

The initial text value, which is set when the object is reset.
Parameters:
NameTypeAttributesDescription
valuestring <optional>
When provided, this method acts as a setter and sets the defaultValue value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored defaultValue value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

firstItem(value[opt]) → {string|Description}

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

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

The object's HTML identifier.
Parameters:
NameTypeAttributesDescription
idstring <optional>
When provided, this method acts as a setter and sets the HTML id value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML id value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

index(value[opt]) → {number|Description}

The 0-based index of this object, relative to all other objects with an otherwise identical description.
Parameters:
NameTypeAttributesDescription
valuenumber <optional>
When provided, this method acts as a setter and sets the index to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored index; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

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

The HTML code contained between the object's start and end tags.
Parameters:
NameTypeAttributesDescription
innerHTMLstring <optional>
When provided, this method acts as a setter and sets the innerHTML value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerHTML value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

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

The text contained between the object's start and end tags.
Parameters:
NameTypeAttributesDescription
innerTextstring <optional>
When provided, this method acts as a setter and sets the innerText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isEnabled(enabled) → {boolean|Description}

Indicates whether the object is enabled.
Parameters:
NameTypeDescription
enabledbooleanIndicates whether the object is enabled.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isMultiple(multiple[opt]) → {boolean|Description}

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

isVisible(visible[opt]) → {boolean|Description}

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

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

An array of all items in the list.
Note: When weblist items are loaded dynamically, it is possible that only a partial list of the items will be returned.
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(count) → {number|Description}

The number of items in the object.
Parameters:
NameTypeDescription
countnumberThe number of items in the object.
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 window (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 object's name property.
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

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

The object's HTML code and its content.
Parameters:
NameTypeAttributesDescription
outerHTMLstring <optional>
When provided, this method acts as a setter and sets the outerHTML value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerHTML value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

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

The object's text (supported in Internet Explorer only).
Parameters:
NameTypeAttributesDescription
outerTextstring <optional>
When provided, this method acts as a setter and sets the outerText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

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

An array of all selected items in the list.
Parameters:
NameTypeAttributesDescription
itemsArray.<string> <optional>
When provided, this method acts as a setter and sets the selectedItems value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored selectedItems value; otherwise it returns 'this' for use with the builder pattern.
Type
Array.<string> | Description

selectType(selectType) → {SAPUI5.SelectType|Description}

The selection type of the list. Possible values: 'singleSelection', 'comboboxSelection', 'extendedSelection'.
Parameters:
NameTypeDescription
selectTypeSAPUI5.SelectTypeThe selectType of the list box.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored value of selectType; otherwise it returns 'this' for use with the builder pattern.
Type
SAPUI5.SelectType | 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

styles(styles[opt]) → {Object|Description}

The object's computed style.
Parameters:
NameTypeAttributesDescription
stylesObject <optional>
When provided, this method acts as a setter and sets the object by its computed style value. * Specify the style names as object keys and set their values to the desired style values.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored styles object; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

tagName(tag[opt]) → {string|Description}

The object's HTML tag.
Parameters:
NameTypeAttributesDescription
tagstring <optional>
When provided, this method acts as a setter and sets the HTML tagName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML tagName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

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

The object's title.
Parameters:
NameTypeAttributesDescription
titlestring <optional>
When provided, this method acts as a setter and sets the title value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored title value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

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

The object's text value.
Parameters:
NameTypeAttributesDescription
valuestring <optional>
When provided, this method acts as a setter and sets the value value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored value value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

visibleItemsCount(count[opt]) → {number|Description}

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

vri(value[opt])

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
Parameters:
NameTypeAttributesDescription
valueArray.<Object> <optional>
Array that contains multiple VRI definitions for this test object.
Properties
NameTypeAttributesDefaultDescription
anchorObjectThe related test object.
horizontalHorizontal <optional>
The horizontal relation definition.
hInlineboolean <optional>
false The horizontal inline definition.
verticalVertical <optional>
The vertical relation definition.
vInlinestring <optional>
false The vertical inline definition.
proximityProximity <optional>
The proximity relation definition.