Constructor
new TextField(id, label, value)
- Description:
- Creates an instance of the TextField class.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The unique identifier of the field. |
label |
string | The label of the field. |
value |
any | The value of the field |
Extends
Methods
deserializeNestedProperties()
- Description:
- Deserialize nested object properties into corresponding class instances
- Source:
- Overrides:
getAlignment() → {FieldAlignment}
- Description:
- Gets the alignment of the read-only field.
- Source:
- Overrides:
Returns:
The alignment value.
- Type
- FieldAlignment
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
getFontSize()
- Description:
- Gets the fontSize value of the field.
- Source:
Returns:
The fontSize value of the field.
getFontWeight()
- Description:
- Gets the fontWeight value of the field.
- Source:
Returns:
The fontWeight value of the field.
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.
getMarginTop()
- Description:
- Gets the margin top value of the field.
- Source:
- Overrides:
Returns:
The margin top value of the field.
getTruncateAt()
- Description:
- Gets the truncateAt value of the field.
- Source:
Returns:
The truncateAt value of the field.
getValue() → {any}
- Description:
- Gets the value of the read-only field.
- Source:
- Overrides:
Returns:
The value of the field.
- Type
- any
getWidth() → {number}
- Description:
- Gets the width of the read-only field.
- Source:
- Overrides:
Returns:
The width value.
- Type
- number
setAlignment(alignment)
- Description:
- Sets the alignment of the read-only field.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
alignment |
FieldAlignment | The alignment value to set. |
Returns:
The current instance of the ReadOnlyField 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.
setFontSize(fontSize)
- Description:
- Sets the fontSize value of the field.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
fontSize |
The fontSize value to set. |
Returns:
The updated instance of the TextField.
setFontWeight(fontWeight)
- Description:
- Sets the fontWeight value of the field.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
fontWeight |
The fontWeight value to set. |
Returns:
The updated instance of the TextField.
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.
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.
setTruncateAt(truncateAt)
- Description:
- Sets the truncateAt value of the field.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
truncateAt |
The truncateAt value to set. |
Returns:
The updated instance of the TextField.
setValue(value)
- Description:
- Sets the value of the read-only field.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | The value to set. |
Returns:
The current instance of the ReadOnlyField class.
setWidth(width)
- Description:
- Sets the width of the read-only field.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
number | The width value to set. |
Returns:
The current instance of the ReadOnlyField class.