Namespace: Form

Namespace for all form related functions.

Author: schukai GmbH

Classes

ActionButton: A popper button
ApiButton: A button that opens a popper element with possible actions.
Button: A simple button
ButtonBar: A configurable tab control
ConfirmButton: A confirm button
ContextError: A control that can be used to display a tooltip or a popover with an error message.
ContextHelp: A control that can be used to display a tooltip or a popover.
Form: A configurable form control
FormField: A simple button
MessageStateButton: A state button with icons and a message
Popper: A popper button
PopperButton: A popper button
Reload: A reload control
Select: A highly configurable select control
ShadowReload: A shadow reload control
StateButton: A state button with icons
Tabs: A configurable tab control
Template: A template control
ToggleSwitch: A simple Switch
TreeSelect: A highly configurable select control

Namespaces

StyleSheet: Namespace for all form related functions.
Types: Namespace for all form related functions.
Util: Namespace for all form related functions.

Members

(static, constant) ATTRIBUTE_BUTTON_CLASS :string

data-monster-intend

Type:

string

Since: 1.9.0
Deprecated: since 3.32.0

(static, constant) ATTRIBUTE_BUTTON_LABEL :string

This attribute data-monster-button-label can be used to pass labels.

Type:

string

Since: 1.6.0

(static, constant) ATTRIBUTE_FORM_DATASOURCE :string

This attribute data-monster-datasource can be used to pass a datasource.

Type:

string

Since: 1.6.0

(static, constant) ATTRIBUTE_FORM_DATASOURCE_ARGUMENTS :string

This attribute data-monster-datasource-arguments can be used to pass arguments.

Type:

string

Since: 1.6.0

(static, constant) ATTRIBUTE_FORM_RELOAD :string

This attribute data-monster-reload can be used to control the reload.

valid values: onshow

Type:

string

Since: 1.11.0

(static, constant) ATTRIBUTE_FORM_URL :string

This attribute data-monster-url can be used to pass a URL to the control.

Type:

string

Since: 1.0.0

(static, constant) ATTRIBUTE_HAS_CHILDREN :string

data-monster-has-children

Type:

string

Since: 1.8.0

(static, constant) ATTRIBUTE_INTEND :string

data-monster-intend

Type:

string

Since: 1.8.0

(static, constant) ATTRIBUTE_VISIBILITY :string

data-monster-intend

Type:

string

Since: 1.9.0

(static, constant) STYLE_DISPLAY_MODE_BLOCK :string

Type:

string

Since: 1.0.0

(static, constant) STYLE_DISPLAY_MODE_BLOCK :string

Type:

string

Since: 1.0.0

Methods

(static) formatHierarchicalSelection(value) → {string}

This formatter can format a label hierarchically.

This formatter can format a label hierarchically. The option formatter.separator determines the separator.

a / b / c

This function can be passed as argument of the option formatter.selection:.

Parameters:

Name	Type	Description
`value`	*

Since: 1.9.0

Returns:

Type:: string

Type Definitions

Processor

Type:

Object

Properties

Name	Type	Description
`destination`	String
`source`	String

Since: 1.11.8

Selection

Type:

Object

Properties

Name	Type	Description
`value`	*
`label`	String

Since: 1.2.0

exampleActionCallback(e)

This action callback executes the actions when a button is clicked.

This:

{CustomControl}

Parameters:

Name	Type	Description
`e`	Event	Event

exampleActionCallback(e)

This action callback executes the actions when a button is clicked.

This:

{CustomControl}

Parameters:

Name	Type	Description
`e`	Event	Event

exampleActionCallback(e)

This action callback executes the actions when a button is clicked.

This:

{CustomControl}

Parameters:

Name	Type	Description
`e`	Event	Event

exampleFilterCallback(value, key)

With the help of this filter callback, values can be filtered out.

With the help of this filter callback, values can be filtered out. Only if the filter function returns true, the value is taken for the map.

Parameters:

Name	Type	Description
`value`	*	Value
`key`	string	Key

See: Monster.Data.buildMap

formatterSelectionCallback(value) → {string|undefined}

Parameters:

Name	Type	Description
`value`	*	Value

See: Monster.Data.buildMap

Returns:

Type:: string | undefined

Events

event:monster-api-button-click

content fetched event

Type:

object

event:monster-api-button-failed

content fetched event

Type:

object

event:monster-api-button-successful

content fetched event

Type:

object

event:monster-button-clicked

button clicked event

Type:

object

event:monster-button-set

content fetched event

Type:

object

event:monster-change

This event will be fired when something will change

Type:

object

Properties

Name	Type	Attributes	Description
`type`	string	<optional>	event type
`value`	string	<optional>	the value that was changed
`checked`	boolean	<optional>	if it is a boolean value

event:monster-changed

This event will be fired if something has changed

Type:

object

Properties

Name	Type	Attributes	Description
`type`	string	<optional>	event type
`value`	string	<optional>	the value that was changed
`checked`	boolean	<optional>	if it is a boolean value

event:monster-datatable-row-added

index

Type:

number

event:monster-datatable-row-copied

index

Type:

number

event:monster-datatable-row-removed

index

Type:

number

event:monster-options-set

This event is fired when options are set

Type:

object

Properties

Name Type Description

options

Array.<Object>

options

Properties

Name	Type	Description
`value`	string	value
`label`	string	label

event:monster-selected

This event is fired when something is selected

Type:

object

Properties

Name	Type	Description
`selection`	array \| string

event:monster-selection-cleared

This event will be fired when a selection is cleared

Type:

object

Properties

Name	Type	Attributes	Description
`type`	string	<optional>	event type

event:monster-selection-removed

This event will be fired when a selection is removed

Type:

object

Properties

Name	Type	Attributes	Description
`type`	string	<optional>	event type
`value`	string	<optional>	the value that was changed