Open topic with navigation

# List

## Oracle. List

The description of an Oracle poplist (combo box) or list.

Supported in LeanFT versions 14.52 and later.

## new List(propsopt) → {List}

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`props` | Object | <optional> | Initializes a List test object using the supplied property bag.

Returns:

the description object that was initialized.

Type
  List

### 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

## caption(captionopt) → {string|Description}

The caption of the object.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`caption` | string | <optional> | When provided, this method acts as a setter and sets the caption value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored caption value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## classPath(classPathopt) → {string|Description}

The Oracle class hierarchy of the object's Oracle class.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`classPath` | string | <optional> | When provided, this method acts as a setter and sets the classPath value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored classPath value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## isEnabled(isEnabledopt) → {boolean|Description}

Indicates whether the object is enable.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`isEnabled` | boolean | <optional> | When provided, this method acts as a setter and sets the isEnabled value.

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

## 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

## objectDescription(objectDescriptionopt) → {string|Description}

Indicates accessibility description of the object as specified by the server.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`objectDescription` | string | <optional> | When provided, this method acts as a setter and sets the objectDescription value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored objectDescription value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## objectName(objectNameopt) → {string|Description}

Indicates internal name of the object supplied by the application server.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`objectName` | string | <optional> | When provided, this method acts as a setter and sets the objectName value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored objectName value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## objectType(objectTypeopt) → {string|Description}

The general object type.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`objectType` | string | <optional> | When provided, this method acts as a setter and sets the objectType value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored objectType value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## selectedIndex(selectedIndexopt) → {number|Description}

The 0-based index of the selected item.
Note: If no item is selected, -1 is returned.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`selectedIndex` | number | <optional> | When provided, this method acts as a setter and sets the selectedIndex value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored selectedIndex value; otherwise it returns 'this' for use with the builder pattern.

Type
  number | Description

## selectedItem(selectedItemopt) → {string|Description}

The value of the selected item.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`selectedItem` | string | <optional> | When provided, this method acts as a setter and sets the selectedItem value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored selectedItem 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

## tooltipText(tooltipTextopt) → {string|Description}

Indicates the text displayed in the object's tooltip.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`tooltipText` | string | <optional> | When provided, this method acts as a setter and sets the tooltipText value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored tooltipText value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description