elemental.svg

Interface SVGNumberList

All Known Implementing Classes:

JsSVGNumberList

public interface SVGNumberList

The SVGNumberList defines a list of SVGNumber objects.

An SVGNumberList object can be designated as read only, which means that attempts to modify the object will result in an exception being thrown.

Gecko 5.0 note

(Firefox 5.0 / Thunderbird 5.0 / SeaMonkey 2.2)

Starting in Gecko 5.0 (Firefox 5.0 / Thunderbird 5.0 / SeaMonkey 2.2) ,the SVGNumberList DOM interface is now indexable and can be accessed like arrays

Method Summary

Methods

Modifier and Type	Method and Description
SVGNumber	appendItem(SVGNumber item) Inserts a new item at the end of the list.
void	clear() Clears all existing current items from the list, with the result being an empty list.
SVGNumber	getItem(int index) Returns the specified item from the list.
int	getNumberOfItems()
SVGNumber	initialize(SVGNumber item) Clears all existing current items from the list and re-initializes the list to hold the single item specified by the parameter.
SVGNumber	insertItemBefore(SVGNumber item, int index) Inserts a new item into the list at the specified position.
SVGNumber	removeItem(int index) Removes an existing item from the list.
SVGNumber	replaceItem(SVGNumber item, int index) Replaces an existing item in the list with a new item.

Method Detail

getNumberOfItems

int getNumberOfItems()

appendItem

SVGNumber appendItem(SVGNumber item)

Inserts a new item at the end of the list. If newItem is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.

clear

void clear()

Clears all existing current items from the list, with the result being an empty list.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.

getItem

SVGNumber getItem(int index)

Returns the specified item from the list. The returned item is the item itself and not a copy. Any changes made to the item are immediately reflected in the list. The first item is number 0.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.

initialize

SVGNumber initialize(SVGNumber item)

Clears all existing current items from the list and re-initializes the list to hold the single item specified by the parameter. If the inserted item is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy. The return value is the item inserted into the list.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.

insertItemBefore

SVGNumber insertItemBefore(SVGNumber item,
                         int index)

Inserts a new item into the list at the specified position. The first item is number 0. If newItem is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy. If the item is already in this list, note that the index of the item to insert before is before the removal of the item. If the index is equal to 0, then the new item is inserted at the front of the list. If the index is greater than or equal to numberOfItems, then the new item is appended to the end of the list.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.

removeItem

SVGNumber removeItem(int index)

Removes an existing item from the list.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.
• a DOMException with code INDEX_SIZE_ERR is raised if the index number is greater than or equal to numberOfItems.

replaceItem

SVGNumber replaceItem(SVGNumber item,
                    int index)

Replaces an existing item in the list with a new item. If newItem is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy. If the item is already in this list, note that the index of the item to replace is before the removal of the item.

Exceptions:

• a DOMException with code NO_MODIFICATION_ALLOWED_ERR is raised when the list corresponds to a read only attribute or when the object itself is read only.
• a DOMException with code INDEX_SIZE_ERR is raised if the index number is greater than or equal to numberOfItems.