Class MQTKObjectCollection

Object
   |
   +--MQTKObjectCollection

Direct Known Subclasses:

MQOverlayCollection, MQPoiCollection

class MQTKObjectCollection

Base class used for any collection holding MQObjects.
Defined in utils.js

Constructor Detail

MQTKObjectCollection

MQTKObjectCollection(max)

MQTKObjectCollection constructor.

add

int add(<Object> obj)

Adds an object to the collection.

Parameters:
obj - the object to be added

Returns:
new length of the collection.

contains

boolean contains(<Object> item)

Function to test if object is in collection.

Parameters:
item - object to test.

Returns:
true if object is in collection.

getAt

Object getAt(<int> iIndex)

Returns an object at the specified index.

Parameters:
iIndex - index of the item to retrieve.

Returns:
object at the specified index.

getById

Object getById(<string> strId)

Returns an object with the specified ID.

Parameters:
strId - ID of the item to retrieve.

Returns:
object with the specified ID. Returns null if not found.

getSize

int getSize()

Returns the size of the collection.

Returns:
the size of the collection.

remove

Object remove(<int> iIndex)

Removes an object at specified index.

Parameters:
iIndex - index of item to be removed.

Returns:
object at specified index.

removeAll

void removeAll()

Remove all elements from collection.

removeItem

void removeItem(<Object> item)

Remove an item by it's pointer.

Parameters:
item - pointer to the item to remove.