elemental.svg

Interface SVGStringList

All Known Implementing Classes:

JsSVGStringList

public interface SVGStringList

The SVGStringList defines a list of DOMString objects.

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

Method Summary

Modifier and Type	Method and Description
String	appendItem(String 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.
String	getItem(int index) Returns the specified item from the list.
int	getNumberOfItems()
String	initialize(String item) Clears all existing current items from the list and re-initializes the list to hold the single item specified by the parameter.
String	insertItemBefore(String item, int index) Inserts a new item into the list at the specified position.
String	removeItem(int index) Removes an existing item from the list.
String	replaceItem(String item, int index) Replaces an existing item in the list with a new item.

Method Detail

getNumberOfItems

int getNumberOfItems()

appendItem

String appendItem(String 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

String 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

String initialize(String 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

String insertItemBefore(String 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

String 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

String replaceItem(String 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.