Class baja.Icon
Extends
baja.Simple.
A BajaScript Icon.
A BajaScript Icon may contain multiple Image references.
For maximum efficiency, all icons in BajaScript are completely interned.
This Constructor shouldn't be invoked directly. Please use the 'make' methods to create
an instance of an Icon.
Defined in: obj.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
baja.Icon.DEFAULT
Default Icon instance.
|
- Fields borrowed from class baja.Value:
- newCopy
- Fields borrowed from class baja.Object:
- equivalent, getIcon
| Method Attributes | Method Name and Description |
|---|---|
|
decodeFromString(str)
Decode a String to an Icon.
|
|
|
Encode Icon to a String.
|
|
|
Return a copy of the image ORDs Array.
|
|
|
Return an array of URIs to the images.
|
|
| <static> |
baja.Icon.make(ords)
Make an Icon.
|
|
make(images)
Make an Icon.
|
|
|
toString()
Return a String representation of the Icon.
|
|
|
valueOf()
Return the inner value of the Icon.
|
- Methods borrowed from class baja.Simple:
- equals
Field Detail
<static>
baja.Icon.DEFAULT
Default Icon instance.
Method Detail
{baja.Icon}
decodeFromString(str)
Decode a String to an Icon.
- Parameters:
- {String} str
- Returns:
- {baja.Icon}
{String}
encodeToString()
Encode Icon to a String.
- Returns:
- {String}
{Array}
getImageOrds()
Return a copy of the image ORDs Array.
Please note, this is a copy of the Image ORDs and not the URIs to access the images.
- Returns:
- {Array} an array of ORDs to the images.
{Array}
getImageUris()
Return an array of URIs to the images.
- Returns:
- {Array} an array of URI Strings to the images.
<static>
{baja.Icon}
baja.Icon.make(ords)
Make an Icon.
- Parameters:
- {Array|String} ords Optional
- an array of Image ORDs or Strings or just a single ORD or String
- Returns:
- {baja.Icon}
{baja.Icon}
make(images)
Make an Icon.
- Parameters:
- {Array} images Optional
- an array of Image ORDs or Strings
- Returns:
- {baja.Icon}
{String}
toString()
Return a String representation of the Icon.
- Returns:
- {String}
{String}
valueOf()
Return the inner value of the Icon.
- Returns:
- {String}