new Icon()
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.
Extends
Members
Methods
-
<static> getStdObjectIcon()
-
Return the standard Object Icon.
Returns:
- Type
- baja.Icon
-
<static> make( [ords])
-
Make an
Icon
.Parameters:
Name Type Argument Description ords
Array.<(String|baja.Ord)> | String <optional>
an array of Image ORDs or
Strings or just a single ORD or StringReturns:
- Type
- baja.Icon
-
decodeAsync(str [, batch])
-
The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.The default implementation just returns
decodeFromString
directly.Parameters:
Name Type Argument Description str
string batch
baja.comm.Batch <optional>
optional batch to use
- Inherited From:
Returns:
may return the Simple instance
directly, or a Promise resolving to same - so wrap inPromise.resolve()
if unsure.- Type
- baja.Simple | Promise.<baja.Simple>
-
decodeFromString(str)
-
Decode a
String
to anIcon
.Parameters:
Name Type Description str
String - Overrides:
Returns:
- Type
- baja.Icon
-
encodeToString()
-
Encode
Icon
to aString
.- Overrides:
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
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:
an array of ORDs to the images.
- Type
- Array.<baja.Ord>
-
getImageUris()
-
Return an array of URIs to the images.
Returns:
an array of URI Strings to the images.
- Type
- Array.<String>
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
make( [ords])
-
Make an Icon.
Parameters:
Name Type Argument Description ords
Array.<(String|baja.Ord)> | String <optional>
an array of Image ORDs or
Strings or just a single ORD or String- Overrides:
Returns:
- Type
- baja.Icon
-
newCopy( [exact])
-
Every value may be cloned using the
newCopy
method.Please note that
Simple
s are immutable so they don't
allocate a new instance.Parameters:
Name Type Argument Description exact
Boolean <optional>
true if an exact copy of the value should be
made (only valid in the Component architecture).- Inherited From:
- See:
Returns:
a copy of the value (or the same instance if the value is a
Simple
). -
toString()
-
Return a
String
representation of theIcon
.- Overrides:
Returns:
- Type
- String
-
valueOf()
-
Return the inner value of the
Icon
.- Overrides:
Returns:
- Type
- String