new LocaleString(viewer, keyopt, jsonKeyopt, defaultStropt)
Locale string class.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
viewer |
FORGE.Viewer | FORGE.Viewer reference. | |
key |
string |
<optional> |
the i18n key of the locale. |
jsonKey |
string |
<optional> |
The JSON key to search for. |
defaultStr |
string |
<optional> |
The default text to use. |
- Source:
- To Do:
-
- Try to make strings that works with a specific key for the cache
- For example a plugin can declare an exclusive key to work with
Extends
Members
(readonly) alive :boolean
Get the alive flag value of the object.
Type:
- boolean
- Inherited From:
- Source:
(readonly) className :string
Get the class name of the object.
Type:
- string
- Inherited From:
- Source:
data :*
Get and set any custom data you want to associate to this object.
Type:
- *
- Inherited From:
- Source:
debug :boolean
Get and set the debug flag.
Type:
- boolean
- Inherited From:
- Source:
jsonKey :string
Get and set the JSON key of the locale.
Type:
- string
- Source:
(readonly) loaded :boolean
Get the loaded status of this locale string for the current locale.
Type:
- boolean
- Source:
(readonly) onDestroy :FORGE.EventDispatcher
Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
- Inherited From:
- Source:
(readonly) tags :Array
Get the tags associated to this object.
Type:
- Array
- Inherited From:
- Source:
(readonly) uid :string
Get the uid of the object.
Type:
- string
- Inherited From:
- Source:
(readonly) value :string
Get the value of the locale.
Type:
- string
- Source:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
destroy()
Destroy method.
- Overrides:
- Source:
log(value)
Basic log method, log a string in the console if debug is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* | The value you want to log in the console. |
- Inherited From:
- Source:
warn(valuenullable)
Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | Object |
<nullable> |
The value you want to warn in the console. |
- Inherited From:
- Source: