ToggleField

ToggleField

Represents a toggle field.

Constructor

new ToggleField(id, label, valueOff, valueOn)

Description:
  • Creates an instance of the ToggleField class.
Source:
Parameters:
Name Type Description
id string The unique identifier of the field.
label string The label of the field.
valueOff any The value when the toggle is off.
valueOn any The value when the toggle is on.

Extends

Methods

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 defaultValue of the field.
Source:
Returns:
The defaultValue 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.

getLabelOff() → {string}

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

getLabelOn() → {string}

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

getMarginTop()

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

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

getValueOff() → {any}

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

getValueOn() → {any}

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

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 defaultValue of the field.
Source:
Parameters:
Name Type Description
defaultValue any The defaultValue to set.
Returns:
The updated instance of the ToggleField.

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.

setLabelOff(labelOff)

Description:
  • Sets the labelOff of the field. This label is used to create a radio button when the channel does not support a toggle field.
Source:
Parameters:
Name Type Description
labelOff string The labelOff to set.
Returns:
The updated instance of the ToggleField.

setLabelOn(labelOn)

Description:
  • Sets the labelOn of the field. This label is used to create a radio button when the channel does not support a toggle field.
Source:
Parameters:
Name Type Description
labelOn string The labelOn to set.
Returns:
The updated instance of the ToggleField.

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.

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.

setValueOff(valueOff)

Description:
  • Sets the valueOff of the field.
Source:
Parameters:
Name Type Description
valueOff any The valueOff to set.
Returns:
The updated instance of the ToggleField.

setValueOn(valueOn)

Description:
  • Sets the valueOn of the field.
Source:
Parameters:
Name Type Description
valueOn any The valueOn to set.
Returns:
The updated instance of the ToggleField.