Top Level

Class Boolean

Object


public class Boolean
extends Object

Player version: Flash Player 5 — (became a native object in Flash Player 6, which improved performance significantly)

The Boolean class is a wrapper object with the same functionality as the standard JavaScript Boolean object. Use the Boolean class to retrieve the primitive data type or string representation of a Boolean object.

You must use the constructor new Boolean() to create a Boolean object before calling its methods.




Property Summary

Properties inherited from class Object
__proto__, __resolve, constructor, prototype


Constructor Summary
Boolean([value:Object])
Creates a Boolean object.


Method Summary
toString() : String
Returns the string representation ("true" or "false") of the Boolean object.
valueOf() : Boolean
Returns true if the primitive value type of the specified Boolean object is true; false otherwise.

Methods inherited from class Object
addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toString, unwatch, valueOf, watch


Constructor Detail

Boolean Constructor

public Boolean([value:Object])

Player version: Flash Player 5

Creates a Boolean object. If you omit the value parameter, the Boolean object is initialized with a value of false. If you specify a value for the value parameter, the method evaluates it and returns the result as a Boolean value according to the rules in the global Boolean() function.

Parameters
value:Object [optional] — Any expression. The default value is false.

Example
The following code creates a new empty Boolean object called myBoolean:
var myBoolean:Boolean = new Boolean();



Method Detail

toString Method

public toString() : String

Player version: Flash Player 5

Returns the string representation ("true" or "false") of the Boolean object.

Returns
String — A string; "true" or "false".

Example
This example creates a variable of type Boolean and uses toString() to convert the value to a string for use in the trace statement:
var myBool:Boolean = true;
trace("The value of the Boolean myBool is: " + myBool.toString());
myBool = false;
trace("The value of the Boolean myBool is: " + myBool.toString());


valueOf Method

public valueOf() : Boolean

Player version: Flash Player 5

Returns true if the primitive value type of the specified Boolean object is true; false otherwise.

Returns
Boolean — A Boolean value.

Example
The following example shows how this method works, and also shows that the primitive value type of a new Boolean object is false:
var x:Boolean = new Boolean();
trace(x.valueOf());   // false
x = (6==3+3);
trace(x.valueOf());   // true