org.vectomatic.dom.svg

Class OMSVGPointList

java.lang.Object

org.vectomatic.dom.svg.OMSVGPointList

All Implemented Interfaces:

Iterable<OMSVGPoint>

public class OMSVGPointList
extends Object
implements Iterable<OMSVGPoint>

This interface defines a list of SVGPoint objects.

OMSVGPointList has the same attributes and methods as other SVGxxxList interfaces. Implementers may consider using a single base class to implement the various SVGxxxList interfaces.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OMSVGPointList(com.google.gwt.core.client.JavaScriptObject ot)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OMSVGPointList

protected OMSVGPointList(com.google.gwt.core.client.JavaScriptObject ot)

Method Detail

getNumberOfItems

public final int getNumberOfItems()

The number of items in the list.

clear

public final void clear()
                 throws com.google.gwt.core.client.JavaScriptException

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

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

com.google.gwt.core.client.JavaScriptException

initialize

public final OMSVGPoint initialize(OMSVGPoint newItem)
                            throws com.google.gwt.core.client.JavaScriptException

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.

Parameters:

newItem - The item which should become the only member of the list.

Returns:

The item being inserted into the list.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

com.google.gwt.core.client.JavaScriptException

getItem

public final OMSVGPoint getItem(int index)
                         throws com.google.gwt.core.client.JavaScriptException

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.

Parameters:

index - The index of the item from the list which is to be returned. The first item is number 0.

Returns:

The selected item.

Throws:

DOMException(INDEX_SIZE_ERR) - Raised if the index number is greater than or equal to getNumberOfItems().

com.google.gwt.core.client.JavaScriptException

insertItemBefore

public final OMSVGPoint insertItemBefore(OMSVGPoint newItem,
                                         int index)
                                  throws com.google.gwt.core.client.JavaScriptException

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.

Parameters:

newItem - The item which is to be inserted into the list.

index - The index of the item before which the new item is to be inserted. The first item is number 0. 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 getNumberOfItems(), then the new item is appended to the end of the list.

Returns:

The inserted item.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

com.google.gwt.core.client.JavaScriptException

replaceItem

public final OMSVGPoint replaceItem(OMSVGPoint newItem,
                                    int index)
                             throws com.google.gwt.core.client.JavaScriptException

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.

Parameters:

newItem - The item which is to be inserted into the list.

index - The index of the item which is to be replaced. The first item is number 0.

Returns:

The inserted item.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

DOMException(INDEX_SIZE_ERR) - Raised if the index number is greater than or equal to getNumberOfItems().

com.google.gwt.core.client.JavaScriptException

removeItem

public final OMSVGPoint removeItem(int index)
                            throws com.google.gwt.core.client.JavaScriptException

Removes an existing item from the list.

Parameters:

index - The index of the item which is to be removed. The first item is number 0.

Returns:

The removed item.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

DOMException(INDEX_SIZE_ERR) - Raised if the index number is greater than or equal to getNumberOfItems().

com.google.gwt.core.client.JavaScriptException

appendItem

public final OMSVGPoint appendItem(OMSVGPoint newItem)
                            throws com.google.gwt.core.client.JavaScriptException

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.

Parameters:

newItem - The item which is to be inserted. The first item is number 0.

Returns:

The inserted item.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list cannot be modified.

com.google.gwt.core.client.JavaScriptException

iterator

public final Iterator<OMSVGPoint> iterator()

Returns an iterator over the OMSVGPoint elements in this list in proper sequence.

This implementation returns a straightforward implementation of the iterator interface, relying on the backing list's getNumberOfItems(), and getItem(int) methods.

Note that the iterator returned by this method will throw an UnsupportedOperationException in response to its remove method.

Specified by:

iterator in interface Iterable<OMSVGPoint>

Returns:

an iterator over the OMSVGPoint elements in this list in proper sequence