TraverseArrayEnumerator

Kind of class: public class
Package:
Inherits from:
Classpath: org.asaplibrary.data.array.TraverseArrayEnumerator
File last modified: Wednesday, 11 May 2011, 18:33:22
Enhanced array enumerator, with the option to loop and validate updates by way of a delegate. TraverseArrayEnumerator sends out traverse events of type TraverseArrayEnumeratorEvent.UPDATE. A TraverseArrayEnumerator can be used with a paging controller to navigate through a list of thumbs or search result pages.
Events broadcasted to listeners

Summary

Constructor
Instance methods
  • setTraverseOptions (inTraverseOptions:uint) : void
    • Sets the traversal options.
  • setLoop (inDoLoop:Boolean) : void
    • Set the looping property of the enumerator.
  • addDelegate (inDelegateObject:ITraverseArrayDelegate) : void
    • A delegate may prohibit the enumerator to update.
  • setCurrentObject (inObject:Object) : void
  • getNextObject () : *
    • Increments the location pointer by one and returns the object from the array at that location.
  • getPreviousObject () : *
    • Decrements the location pointer by one and returns the object from the array at that location.
  • hasNextObject () : Boolean
    • Checks if there is an object after the current object.
  • hasPreviousObject () : Boolean
    • Checks if there is an object before the current object.
Instance methods inherited from ArrayEnumerator
getAllObjects getCurrentLocation getCurrentObject reset setCurrentLocation setObjects

Constructor

TraverseArrayEnumerator

function TraverseArrayEnumerator(inObjects:Array = null, inDoLoop:Boolean = false)

Creates a new array enumerator. Optionally stores a pointer to array inArray.

Parameters
inObjects:(optional) the array to enumerate
inDoLoop :if true, the enumerator will loop past the end of the array to the start (and back when traversing backwards)

Instance methods

addDelegate

function addDelegate(inDelegateObject:ITraverseArrayDelegate) : void

A delegate may prohibit the enumerator to update. Adds a delegate object that implements ITraverseArrayDelegate to validate the current object. Each delegate method is called in update, if a delegate object has been set. The delegate's validation method ITraverseArrayDelegate.mayUpdateToObject is called to evaluate the new node if it may be updated.

Parameters
inDelegateObject:the object a class that implements ITraverseArrayDelegate

getNextObject

override function getNextObject() : *

Increments the location pointer by one and returns the object from the array at that location.

Implementation note
Overrides
Returns
  • (Deliberately untyped) The object at the new location. Returns null if the location pointer has moved past the end of the array and inTraverseOptions is not set to TraverseArrayOptions.LOOP.

getPreviousObject

function getPreviousObject() : *

Decrements the location pointer by one and returns the object from the array at that location.

Implementation note
Returns
  • (Deliberately untyped) The object at the new location. Returns null if the location pointer has moved past the end of the array and inTraverseOptions is not set to TraverseArrayOptions.LOOP.

hasNextObject

function hasNextObject() : Boolean

Checks if there is an object after the current object.

Returns
  • True: there is a next object; false: the current object is the last.

hasPreviousObject

function hasPreviousObject() : Boolean

Checks if there is an object before the current object.

Returns
  • True: there is a next object; false: the current object is the first.

setCurrentObject

override function setCurrentObject(inObject:Object) : void

Sets the location pointer to the location (in the array) of inObject. →

Parameters
inObject:
the object whose index the location pointer should point to →
Overrides
Events broadcasted to listeners

setLoop

function setLoop(inDoLoop:Boolean) : void

Set the looping property of the enumerator.

Parameters
inDoLoop:if true, the enumerator will loop past the end of the array to the start (and back when traversing backwards)
Implementation note

setTraverseOptions

function setTraverseOptions(inTraverseOptions:uint) : void

Sets the traversal options.

Parameters
inTraverseOptions:see TraverseArrayOptions