Class Index | File Index

Classes


Built-In Class Boolean

Represents a baja:Boolean in BajaScript.

Augments Boolean to be a baja:Boolean.

Field Summary
Field Attributes Field Name and Description
<static>  
Boolean.DEFAULT
Default Boolean instance.
Method Summary
Method Attributes Method Name and Description
 
Decode a Boolean from a String.
 
Encode a Boolean to a String.
 
equals(obj)
Equality test.
 
Equivalence test.
<static>  
Boolean.getBooleanFromIBoolean(boolVal)
Return the boolean from a BIBoolean.
 
Return the data type symbol.
 
getDisplayTag(facets)
Return the display tag of this enum value.
 
Return the Object's Icon.
 
Return the enum ordinal.
 
Return the enum range.
 
Return the string identifier of this enum value.
 
Return true if this enum's value is considered to be in an active state.
<static>  
Boolean.make(b)
Make a Boolean.
 
make(b)
Make a Boolean.
 
New Copy.
 
toString(facets)
Return the String representation of a Boolean.
Field Detail
<static> Boolean.DEFAULT
Default Boolean instance.
Method Detail
{Boolean} decodeFromString(str)
Decode a Boolean from a String.
Parameters:
{String} str
Returns:
{Boolean}

{String} encodeToString()
Encode a Boolean to a String.
Returns:
{String}

{Boolean} equals(obj)
Equality test.
Parameters:
obj
Returns:
{Boolean}

{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 equals().

Parameters:
obj
Returns:
{Boolean}

<static> Boolean.getBooleanFromIBoolean(boolVal)
Return the boolean from a BIBoolean.
Parameters:
boolVal
Returns:
resolved boolean value.

{String} getDataTypeSymbol()
Return the data type symbol.
Returns:
{String} the Symbol used for encoding this data type (primarily used for facets).

{String} getDisplayTag(facets)
Return the display tag of this enum value.
Parameters:
{baja.Facets|Object} facets Optional
used to specify the true and false text. For true text the facets key is 'trueText' and false is 'falseText'. The argument can also be an Object Literal.
Returns:
{String} display tag

{baja.Icon} getIcon()
Return the Object's Icon.
Returns:
{baja.Icon}

{Number} getOrdinal()
Return the enum ordinal.
Returns:
{Number} the enum ordinal.

{baja.EnumRange} getRange()
Return the enum range.
Returns:
{baja.EnumRange} the enum range.

{String} getTag()
Return the string identifier of this enum value.
Returns:
{String} tag

{Boolean} isActive()
Return true if this enum's value is considered to be in an active state.
Returns:
{Boolean} whether the enum is active.

<static> {Boolean} Boolean.make(b)
Make a Boolean.
Parameters:
{Boolean} b
Returns:
{Boolean}

{Boolean} make(b)
Make a Boolean.
Parameters:
{Boolean} b
Returns:
{Boolean}

{Boolean} newCopy()
New Copy.
Returns:
{Boolean}

toString(facets)
Return the String representation of a Boolean.
Parameters:
{baja.Facets|Object} facets Optional
used to specify the true and false text. For true text the facets key is 'trueText' and false is 'falseText'. The argument can also be an Object Literal.
Returns:
String

Documentation generated by JsDoc Toolkit 2.3.2