org.vectomatic.dom.svg

Class OMSVGTransformList

java.lang.Object

org.vectomatic.dom.svg.OMSVGTransformList

All Implemented Interfaces:

Iterable<OMSVGTransform>

public class OMSVGTransformList
extends Object
implements Iterable<OMSVGTransform>

This interface defines a list of SVGTransform objects.

The OMSVGTransformList and OMSVGTransform interfaces correspond to the various attributes which specify a set of transformations, such as the transform attribute which is available for many of SVG's elements.

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OMSVGTransform	appendItem(OMSVGTransform 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.
OMSVGTransform	consolidate() Consolidates the list of separate OMSVGTransform objects by multiplying the equivalent transformation matrices together to result in a list consisting of a single OMSVGTransform object of type SVG_TRANSFORM_MATRIX.
OMSVGTransform	createSVGTransformFromMatrix(OMSVGMatrix matrix) Creates an OMSVGTransform object which is initialized to transform of type SVG_TRANSFORM_MATRIX and whose values are the given matrix.
String	getDescription() Returns a textual description of the transform list for debugging purposes.
OMSVGTransform	getItem(int index) Returns the specified item from the list.
int	getNumberOfItems() The number of items in the list.
OMSVGTransform	initialize(OMSVGTransform newItem) Clears all existing current items from the list and re-initializes the list to hold the single item specified by the parameter.
OMSVGTransform	insertItemBefore(OMSVGTransform newItem, int index) Inserts a new item into the list at the specified position.
Iterator<OMSVGTransform>	iterator() Returns an iterator over the OMSVGTransform elements in this list in proper sequence.
OMSVGTransform	removeItem(int index) Removes an existing item from the list.
OMSVGTransform	replaceItem(OMSVGTransform 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

OMSVGTransformList

protected OMSVGTransformList(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 corresponds to a read only attribute or when the object itself is read only.

com.google.gwt.core.client.JavaScriptException

initialize

public final OMSVGTransform initialize(OMSVGTransform 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 corresponds to a read only attribute or when the object itself is read only.

com.google.gwt.core.client.JavaScriptException

getItem

public final OMSVGTransform 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 OMSVGTransform insertItemBefore(OMSVGTransform 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 corresponds to a read only attribute or when the object itself is read only.

com.google.gwt.core.client.JavaScriptException

replaceItem

public final OMSVGTransform replaceItem(OMSVGTransform 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 corresponds to a read only attribute or when the object itself is read only.

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 OMSVGTransform 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 corresponds to a read only attribute or when the object itself is read only.

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 OMSVGTransform appendItem(OMSVGTransform 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 corresponds to a read only attribute or when the object itself is read only.

com.google.gwt.core.client.JavaScriptException

createSVGTransformFromMatrix

public final OMSVGTransform createSVGTransformFromMatrix(OMSVGMatrix matrix)

Creates an OMSVGTransform object which is initialized to transform of type SVG_TRANSFORM_MATRIX and whose values are the given matrix. The values from the parameter matrix are copied, the matrix parameter is not adopted as SVGTransform::matrix.

Parameters:

matrix - The matrix which defines the transformation.

Returns:

The returned OMSVGTransform object.

consolidate

public final OMSVGTransform consolidate()
                                 throws com.google.gwt.core.client.JavaScriptException

Consolidates the list of separate OMSVGTransform objects by multiplying the equivalent transformation matrices together to result in a list consisting of a single OMSVGTransform object of type SVG_TRANSFORM_MATRIX. The consolidation operation creates new SVGTransform object as the first and only item in 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.

Returns:

The resulting OMSVGTransform object which becomes single item in the list. If the list was empty, then a value of null is returned.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised when the list corresponds to a read only attribute or when the object itself is read only.

com.google.gwt.core.client.JavaScriptException

iterator

public final Iterator<OMSVGTransform> iterator()

Returns an iterator over the OMSVGTransform 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<OMSVGTransform>

Returns:

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

getDescription

public final String getDescription()

Returns a textual description of the transform list for debugging purposes.

Returns:

a textual description of the transform list.