SingleSelectField

SingleSelectField

Represents a single select field.

Constructor

new SingleSelectField(id, label, options)

Description:
  • Creates an instance of the SingleSelectField class.
Source:
Parameters:
Name Type Description
id string The unique identifier of the field.
label string The label of the field.
options Array.<SelectFieldOption> The options to of the field.

Extends

Methods

addOption(option)

Description:
  • Add an option.
Source:
Parameters:
Name Type Description
option SelectFieldOption The option to add.
Returns:
The updated instance of the SingleSelectField.

deserializeNestedProperties()

Description:
  • Deserialize nested object properties into corresponding class instances
Source:
Overrides:

getAutoSubmit() → {boolean}

Description:
  • Gets the auto submit flag of the editable field.
Source:
Overrides:
Returns:
The auto submit flag value.
Type
boolean

getChannelExtensionProperty(channelType, propertyName) → {any}

Description:
  • Get the value of a channel extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
Returns:
The property value
Type
any

getChannelExtensions() → {ChannelExtensions}

Description:
  • Gets the channel extensions
Source:
Overrides:
Returns:
The channel extensions
Type
ChannelExtensions

getClientErrorMessage() → {string}

Description:
  • Gets the client error message of the editable field.
Source:
Overrides:
Returns:
The client error message.
Type
string

getDefaultValue() → {any}

Description:
  • Gets the default value of the field.
Source:
Returns:
The default value of the field.
Type
any

getId() → {string}

Description:
  • Gets the ID of the field.
Source:
Overrides:
Returns:
The ID of the field.
Type
string

getLabel() → {string}

Description:
  • Gets the label of the field.
Source:
Overrides:
Returns:
The label of the field.
Type
string

getLabelFontSize()

Description:
  • Gets the label font size of the field.
Source:
Overrides:
Returns:
The label font size of the field.

getLabelFontWeight()

Description:
  • Gets the label font weight of the field.
Source:
Overrides:
Returns:
The label font weight of the field.

getLayoutStyle() → {SingleSelectLayoutStyle}

Description:
  • Gets the layout style of the field.
Source:
Returns:
The layout style of the field.
Type
SingleSelectLayoutStyle

getMarginTop()

Description:
  • Gets the margin top value of the field.
Source:
Overrides:
Returns:
The margin top value of the field.

getOptions() → {Array.<SelectFieldOption>}

Description:
  • Gets the options of the field.
Source:
Returns:
The options of the field.
Type
Array.<SelectFieldOption>

getPlaceholder() → {string}

Description:
  • Gets the placeholder value of the editable field.
Source:
Overrides:
Returns:
The placeholder value.
Type
string

getRequired() → {boolean}

Description:
  • Gets the required flag of the editable field.
Source:
Overrides:
Returns:
The required flag value.
Type
boolean

getServerErrorMessage() → {string}

Description:
  • Gets the server error message of the editable field.
Source:
Overrides:
Returns:
The server error message.
Type
string

setAutoSubmit(autoSubmit)

Description:
  • Sets the auto submit flag of the editable field.
Source:
Overrides:
Parameters:
Name Type Description
autoSubmit boolean The auto submit flag value to set.
Returns:
The current instance of the EditableField class.

setChannelExtensionProperty(channelType, propertyName, propertyValue)

Description:
  • Sets a channel-specific extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
propertyValue any The value of the property.
Returns:
The current instance of this class.

setClientErrorMessage(clientErrorMessage)

Description:
  • Sets the client error message of the editable field.
Source:
Overrides:
Parameters:
Name Type Description
clientErrorMessage string The client error message to set.
Returns:
The current instance of the EditableField class.

setDefaultValue(defaultValue)

Description:
  • Sets the default value of the field.
Source:
Parameters:
Name Type Description
defaultValue any The default value to set.
Returns:
The updated instance of the SingleSelectField.

setId(id)

Description:
  • Sets the ID of the field.
Source:
Overrides:
Parameters:
Name Type Description
id string The ID of the field.
Returns:
This Field instance.

setLabel(label)

Description:
  • Sets the label of the field.
Source:
Overrides:
Parameters:
Name Type Description
label string The label of the field.
Returns:
This Field instance.

setLabelFontSize(labelFontSize)

Description:
  • Sets the label font size of the field.
Source:
Overrides:
Parameters:
Name Type Description
labelFontSize The label font size of the field.
Returns:
This Field instance.

setLabelFontWeight(labelFontWeight)

Description:
  • Sets the label font weight of the field.
Source:
Overrides:
Parameters:
Name Type Description
labelFontWeight The label font weight of the field.
Returns:
This Field instance.

setLayoutStyle(layoutStyle)

Description:
  • Sets the layout style of the field.
Source:
Parameters:
Name Type Description
layoutStyle SingleSelectLayoutStyle The layout style to set.
Returns:
The updated instance of the SingleSelectField.

setMarginTop(marginTop)

Description:
  • Sets the margin top value of the field.
Source:
Overrides:
Parameters:
Name Type Description
marginTop The margin top value of the field.
Returns:
This Field instance.

setOptions(options)

Description:
  • Sets the options of the field.
Source:
Parameters:
Name Type Description
options Array.<SelectFieldOption> The options to set.
Returns:
The updated instance of the SingleSelectField.

setPlaceholder(placeholder)

Description:
  • Sets the placeholder value of the editable field.
Source:
Overrides:
Parameters:
Name Type Description
placeholder string The placeholder value to set.
Returns:
The current instance of the EditableField class.

setRequired(required)

Description:
  • Sets the required flag of the editable field.
Source:
Overrides:
Parameters:
Name Type Description
required boolean The required flag value to set.
Returns:
The current instance of the EditableField class.

setServerErrorMessage(serverErrorMessage)

Description:
  • Sets the server error message of the editable field.
Source:
Overrides:
Parameters:
Name Type Description
serverErrorMessage string The server error message to set.
Returns:
The current instance of the EditableField class.