Main Page | Packages | Class Tree | Index | Help

xp.util

class ListCollection

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.util.ListCollection


class ListCollection
extends DispatcherObject

The List Collection lets you programmatically manage a group of related items, called collection items. Each collection item in this set has properties that are described in the metadata of the collection item class definition. Components can expose properties as collections, which you can manipulate while authoring by using the Values dialog box from the Component inspector. Using this dialog box, you can add items, remove items, change properties of items, and change the position of items within the collection


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
list: Array


Fields inherited from class xp.system.DispatcherObject

parent

Constructor

public
ListCollection ( list: Array)


Method Summary

public
addItem ( item: Object ): Boolean
Adds a new item to the end of the collection.

public
clear ( ): Void
Removes all elements from the collection

public
contains ( item: Object ): Boolean
Indicates whether the collection contains the specified item.

public
getItemAt ( index: Number ): Object
Returns an item within the collection by using its index

public
getIterator ( )
Returns an iterator over the elements in the collection

public
getLength ( ): Number
Returns the number of items in the collection

public
isEmpty ( ): Boolean
Indicates whether the collection is empty.

public
removeItem ( item: Object ): Boolean
Removes the specified item from the collection

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent



Field Documentation

list

public var list: Array

Constructor Documentation

ListCollection

public function ListCollection(list: Array)

Method Documentation

addItem

public function addItem(item: Object): Boolean
Adds a new item to the end of the collection.

clear

public function clear(): Void
Removes all elements from the collection

contains

public function contains(item: Object): Boolean
Indicates whether the collection contains the specified item.

getItemAt

public function getItemAt(index: Number): Object
Returns an item within the collection by using its index

getIterator

public function getIterator()
Returns an iterator over the elements in the collection

getLength

public function getLength(): Number
Returns the number of items in the collection

isEmpty

public function isEmpty(): Boolean
Indicates whether the collection is empty.

removeItem

public function removeItem(item: Object): Boolean
Removes the specified item from the collection


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc