Class: SelectInstancePanel

components~SelectInstancePanel(formElementId, instances, objectSubstitute, arraySubstitute, booleanTranslateFunction, initialSelectedopt, selectAttributesopt, optionsopt)

A panel that contains a module:components~Select component and a module:components~InstanceView that shows the selected instance.

Constructor

new SelectInstancePanel(formElementId, instances, objectSubstitute, arraySubstitute, booleanTranslateFunction, initialSelectedopt, selectAttributesopt, optionsopt)

Parameters:
Name Type Attributes Default Description
formElementId string

The id of the form element.
instances Array

The array of JSON instances.
objectSubstitute string

A string to be shown as choice in the case of an option corresponding to a JSON Schema object type.
arraySubstitute string

A string to be shown as choice in the case of an option corresponding to a JSON Schema array type.
booleanTranslateFunction function

A function that maps boolean values into strings.
initialSelected number <optional>
 0

The index of the option to appear as selected at initialization.
selectAttributes object <optional>
 {}

The parameters to consider as attributes for the HTML <select> element.

Properties
Name Type Attributes Default Description
disabled boolean <optional>
 false

Flag indicating whether the input field should be disabled at initialization.
multiple boolean <optional>

Flag indicating whether the <select> must show multiple choice rows. The selectAttributes.size overrides its behavior if present.
size number <optional>

The value that the <select> element would take as size attribute. The parameter will be ignored in case its value is bigger than the array length of the options parameter.
options object <optional>
 {}

Parameters considered to generate the component.

Properties
Name Type Attributes Description
bootstrap string <optional>

If given, it indicates the Bootstrap version which the component should be built for.
fontAwesome string <optional>

If given, it indicates the Font Awesome version which the component should be built for.
Implements:
Source:

Members

domElement :HTMLDivElement

Reference to the DOM object that contains the HTML structure of the component.

Type:
  • HTMLDivElement
Inherited From:
Implements:
Source:

instances :Array

The array of selectable JSON instances.

Type:
  • Array
Source:

select :module:components~Select

The module:components~Select component.

Type:
Source:

Methods

disable()

Disables the component.

Inherited From:
Implements:
Source:

enable()

Enables the component.

Inherited From:
Implements:
Source:

getId() → {any}

Returns the id of the input control element.

Implements:
Source:
Returns:

The value taken by the component.

Type
any

getValue() → {any}

Returns the value assigned to the component.

Implements:
Source:
Returns:

The value taken by the component.

Type
any