gugga.collections.CheckList Class Reference

Inheritance diagram for gugga.collections.CheckList:

Inheritance graph
[legend]
Collaboration diagram for gugga.collections.CheckList:

Collaboration graph
[legend]
List of all members.

Detailed Description

CheckList is a container for items that should be checked.

To register new item in the CheckList use the add() method.

To check existing items in the CheckList use the check() method.

To uncheck all checked items in the CheckList use the reset() method.

To unregister existing item in the CheckList use the remove() method.

isCompleted() method will return true only if all registered items in the CheckList are checked.

isObjectChecked(aObject:Object) method will return true only if the specified Object is a registered item in the CheckList and it is checked.

isObjectRegistered(aObject:Object) method will return true only if the specified Object is a registered item in the CheckList.

To get the ArrayList of all registered items in the CheckList use the RegisteredObjects property.

To get the ArrayList of all checked items in the CheckList use the CheckedObjects property.

To get the ArrayList of all unchecked items in the CheckList use the UncheckedObjects property.

See also:
ArrayList

Definition at line 47 of file CheckList.as.

Public Member Functions

function get RegisteredObjects ()
function get CheckedObjects ()
function get UncheckedObjects ()
function CheckList ()
function add (aObject:Object)
function remove (aObject:Object)
function check (aObject:Object)
function reset ()
function isObjectRegistered (aObject:Object)
function isObjectChecked (aObject:Object)
function isCompleted ()
function getIterator ()
function getCheckedObjectsIterator ()
function getUncheckedObjectsIterator ()

Private Attributes

var mRegisteredObjects:ArrayList
var mCheckedObjects:ArrayList


Constructor & Destructor Documentation

function gugga.collections.CheckList.CheckList (  ) 

Definition at line 78 of file CheckList.as.


Member Function Documentation

function get gugga.collections.CheckList.RegisteredObjects (  ) 

Definition at line 53 of file CheckList.as.

function get gugga.collections.CheckList.CheckedObjects (  ) 

Definition at line 58 of file CheckList.as.

function get gugga.collections.CheckList.UncheckedObjects (  ) 

Definition at line 63 of file CheckList.as.

function gugga.collections.CheckList.add ( aObject:Object   ) 

Definition at line 84 of file CheckList.as.

function gugga.collections.CheckList.remove ( aObject:Object   ) 

Definition at line 93 of file CheckList.as.

function gugga.collections.CheckList.check ( aObject:Object   ) 

Definition at line 99 of file CheckList.as.

References gugga.events.EventDispatcher.dispatchEvent().

Here is the call graph for this function:

function gugga.collections.CheckList.reset (  ) 

Definition at line 117 of file CheckList.as.

function gugga.collections.CheckList.isObjectRegistered ( aObject:Object   ) 

Definition at line 122 of file CheckList.as.

function gugga.collections.CheckList.isObjectChecked ( aObject:Object   ) 

Definition at line 128 of file CheckList.as.

function gugga.collections.CheckList.isCompleted (  ) 

Definition at line 134 of file CheckList.as.

function gugga.collections.CheckList.getIterator (  ) 

Returns an iterator for the unchecked objects.

Definition at line 149 of file CheckList.as.

function gugga.collections.CheckList.getCheckedObjectsIterator (  ) 

Returns an iterator for the checked objects.

Definition at line 157 of file CheckList.as.

function gugga.collections.CheckList.getUncheckedObjectsIterator (  ) 

Returns an iterator for the unchecked objects.

Definition at line 165 of file CheckList.as.


Member Data Documentation

var gugga.collections.CheckList.mRegisteredObjects [private]

Definition at line 50 of file CheckList.as.

var gugga.collections.CheckList.mCheckedObjects [private]

Definition at line 51 of file CheckList.as.


Generated on Fri May 11 17:13:27 2007 for GuggaFramework by  doxygen 1.5.2