Maps API for JavaScript Developer's Guide

H.util.OList

Class Summary

Extends: H.util.EventTarget

This class represents an list of ordered entries which dispatches events when the list is modified.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

add (entry, opt_idx)

This method inserts an entry in the list. Optionally it can place the new entry at the index provided by the caller.

removeAt (idx) : {?}

This method removes an entry at the index provided by the caller.

remove (entry) : {boolean}

This method removes the first entry which is identical with the entry provided by the caller.

set (idx, entry) : {?}

This method replaces an entry at the index provided by the caller.

indexOf (entry) : {number}

This method retrieves the index of the first object in this list that is identical to the object supplied by the caller.

get (idx) : {?}

This method retrieves the entry at the specified index.

getLength () : {number}

This method retrieves the length of the list.

asArray () : {Array<*>}

This method retrieves all the entries held in the list as an array.

flush ()

This method removes all entries from the list.

addEventListener (type, handler, opt_capture, opt_scope)

This method adds a listener for a specific event.

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the EventTarget instance.

dispatchEvent (evt)

This method dispatches an event on the EventTarget object.

dispose ()

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

addOnDisposeCallback (callback, opt_scope)

This method adds a callback which is triggered when the EventTarget object is being disposed.

Events Summary

Table 2. Events
Events

add : {H.util.OList.Event}

Event fired when an entry has been added to the list.

remove : {H.util.OList.Event}

Event fired when an entry has been removed from the list.

set : {H.util.OList.Event}

Event fired when an entry has been set in the list.

move : {H.util.OList.Event}

Fired when an entry was moved within the list.

Class Description

This class represents an list of ordered entries which dispatches events when the list is modified.

Constructor Details

H.util.OList()

Method Details

add (entry, opt_idx)

This method inserts an entry in the list. Optionally it can place the new entry at the index provided by the caller.

Parameters:
 
entry:
{?}
 
The entry to insert
opt_idx:
{number=} [optional]
 
The index where the new entry should be inserted; if omitted or greater then the current size of the list, the entry is added at the end of the list; a negative index is treated as being relative from the end of the list

removeAt (idx) : {?}

This method removes an entry at the index provided by the caller.

Parameters:
 
idx:
{number}
 
The index of the entry which should be removed; a negative index is treated as being relative from the end of the list
Returns:
 
{?}
An object representing the removed entry
Throws:
 
{H.lang.InvalidArgumentError}
 
If the index provided by the caller is out of bounds

remove (entry) : {boolean}

This method removes the first entry which is identical with the entry provided by the caller.

Parameters:
 
entry:
{?}
 
An object representing the entry to remove
Returns:
 
{boolean}
true to signal that the entry was found in the list and has been removed, otherwise false

set (idx, entry) : {?}

This method replaces an entry at the index provided by the caller.

Parameters:
 
idx:
{number}
 
The index of the entry which should be replaced; a negative index is treated as being relative from the end of the list
entry:
{?}
 
The entry with which to replace an existing entry
Returns:
 
{?}
An object representing the replaced entry
Throws:
 
{H.lang.OutOfRangeError}
 
If the given index is out of bounds

indexOf (entry) : {number}

This method retrieves the index of the first object in this list that is identical to the object supplied by the caller.

Parameters:
 
entry:
{?}
 
The entry for which to return the index
Returns:
 
{number}
The index of the first matching entry in this list or -1 if the entry provided by the caller is not found in the list

get (idx) : {?}

This method retrieves the entry at the specified index.

Parameters:
 
idx:
{number}
 
The index of the entry to get, a negative index is treated as relative from the end of the list
Returns:
 
{?}
The element at the index provided by the caller
Throws:
 
{H.lang.OutOfRangeError}
 
If the given index is out of bounds

getLength () : {number}

This method retrieves the length of the list.

Returns:
 
{number}
A value indicating the length of the list as a number of items.

asArray () : {Array<*>}

This method retrieves all the entries held in the list as an array.

Returns:
 
{Array<*>}
An array holding all the entries in the list

flush ()

This method removes all entries from the list.

addEventListener (type, handler, opt_capture, opt_scope)

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

Parameters:
 
type:
{string}
 
The name of the event
handler:
{!Function}
 
An event handler function
opt_capture:
{boolean=} [optional]
 
true indicates that the method should listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
An object defining the scope for the handler function

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the EventTarget instance.

Parameters:
 
type:
{string}
 
The name of the event
handler:
{!Function}
 
A previously added event handler
opt_capture:
{boolean=} [optional]
 
true indicates that the method should listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
An oject defining the scope for the handler function

dispatchEvent (evt)

This method dispatches an event on the EventTarget object.

Parameters:
 
evt:
{(H.util.Event | string)}
 
An object representing the event or a string with the event name

dispose ()

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

addOnDisposeCallback (callback, opt_scope)

This method adds a callback which is triggered when the EventTarget object is being disposed.

Parameters:
 
callback:
{!Function}
 
The callback function.
opt_scope:
{Object=} [optional]
 
An optional scope for the callback function

Event Details

add: {H.util.OList.Event}

Event fired when an entry has been added to the list.

remove: {H.util.OList.Event}

Event fired when an entry has been removed from the list.

set: {H.util.OList.Event}

Event fired when an entry has been set in the list.

move: {H.util.OList.Event}

Fired when an entry was moved within the list.