$k. FormSelectView

new FormSelectView()

A view built with/by view configuration

Extends

Methods

choices()

Get the choices.

Since
  • 5.4.0

configurationElement() → {$k.SemanticElement}

Get configuration element

Since
  • 5.2.0
Returns:
Type: 
$k.SemanticElement

domainModel() → {object}

Get domain model

Since
  • 5.4.0
Inherited From
Returns:

SemanticElement or TopicCollection

Type: 
object

getPanelsToActivate()

Get the panel configurations activated by the current action.

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.3.2
Deprecated
  • Use the corresponding function of the action

getVariable(variable)

get the value of the given variable

Parameters:
NameTypeDescription
variablestring
Inherited From
Returns:

(arrays of) SemanticElements and timestamps are auto-converted to native form

isRequired() → {boolean}

Get the required state of the input.

Since
  • 5.8.0
Returns:

True iff this is a required input field.

Type: 
boolean

isValid() → {boolean}

Get the valid state of the input.

Since
  • 5.8.0
Returns:

True iff the user input has passed all validation checks.

Type: 
boolean

panelView() → {$k.PanelView}

Get this view's panel view

Since
  • 5.4.0
Inherited From
Returns:
Type: 
$k.PanelView

parentView() → {$k.View}

Get this view's parent view

Since
  • 5.3.2
Inherited From
Returns:
Type: 
$k.View

renderContext() → {RenderContext}

Get render context

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.0.0
Inherited From
Returns:
Type: 
RenderContext

roles() → {Array}

Get the roles of the view, if any assigned.

Since
  • 5.4.0
Inherited From
Returns:

Array of Strings

Type: 
Array

semanticElement() → {$k.SemanticElement}

Get semantic element

Since
  • 5.2.0
Returns:
Type: 
$k.SemanticElement

session() → {$k.Session}

Get the current session

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.2.0
Inherited From
Returns:
Type: 
$k.Session

setState(state) → {object}

Set the state of the view

Parameters:
NameTypeDescription
stateobject
Version
  • Experimental feature, might be removed at any time
Since
  • 5.4.0
Inherited From
Returns:
Type: 
object

setValidationErrorMessage(validationMessage)

Set a validation error message.

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:
NameTypeDescription
validationMessagestring

A string justifying why this value is not acceptable that will be shown to the user.

Since
  • 5.8.0

setValue(value)

Set the value.

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:
NameTypeDescription
valueany

The value to set. It might be coerced to a type matching the form entry.

Since
  • 5.4.0

setVariable(variable, value)

set the value of the given variable

Parameters:
NameTypeDescription
variablestring
value

supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter

Inherited From

state() → {object}

Get the state of the view - varies according to view type and implementation

Version
  • Experimental feature, might be removed at any time
Since
  • 5.4.0
Inherited From
Returns:
Type: 
object

subViews() → {$k.View}

Get this view's sub-views or an empty array if there are none

Since
  • 5.4.0
Inherited From
Returns:
Type: 
$k.View

value()

Get the value.

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0

viewsWithRole(role) → {Array}

Get all views with the given role searching from this view down to all sub-views.

Parameters:
NameTypeDescription
rolestring
Since
  • 5.4.0
Inherited From
Returns:

Array of Views

Type: 
Array

viewType() → {string}

Get the view type

Since
  • 5.4.0
Inherited From
Returns:

the view type: edit, query, etc.

Type: 
string