org.apache.batik.dom.svg
public abstract class AbstractSVGList extends Object
This class provides support for an SVG list representation of an
attribute. It implements basic list functionality that is common to all
of the SVG*List
interfaces.
For a specific attribute, it requires an {@link #getValueAsString() attribute value}, a {@link #doParse(String,ListHandler) parser}, and a method to {@link #createSVGItem(Object) create items}.
Whenever the attribute changes outside of the control of the list, this list must be {@link #invalidate invalidated}.
Nested Class Summary | |
---|---|
protected class | AbstractSVGList.ListBuilder
A class for receiving notification of parsed list items. |
Field Summary | |
---|---|
protected List | itemList
The list of items. |
protected boolean | valid
Whether this list is valid. |
Method Summary | |
---|---|
protected SVGItem | appendItemImpl(Object newItem)
Inserts a new item at the end of the list.
|
protected abstract void | checkItemType(Object newItem)
Asserts that the given object is an appropriate SVG object for this list. |
void | clear()
Removes all items from the list. |
protected void | clear(List list)
Clears the list and sets the parent of the former list items to null. |
protected abstract DOMException | createDOMException(short type, String key, Object[] args)
Create a DOM Exception. |
protected abstract SVGItem | createSVGItem(Object newItem)
Creates an {@link SVGItem} object that has the same values as those
in the specified SVG object.
|
protected abstract void | doParse(String value, ListHandler builder)
Parses the given attribute value and informs the specified
{@link ListHandler} of the parsed list items.
|
protected SVGItem | getItemImpl(int index)
Returns the item from the list at the specified index.
|
protected abstract String | getItemSeparator()
Returns the separator string to use when constructing a string
representation of the entire list. |
int | getNumberOfItems()
Returns the number of items in the list. |
protected abstract String | getValueAsString()
Returns the value of the DOM attribute containing the list. |
protected SVGItem | initializeImpl(Object newItem)
Removes all items from the list and adds the specified item to
the list.
|
protected SVGItem | insertItemBeforeImpl(Object newItem, int index)
Inserts a new item into the list at the specified position.
|
void | invalidate()
Invalidates this list. |
void | itemChanged()
Method to be called by a member {@link SVGItem} object when its value
changes. |
protected SVGItem | removeIfNeeded(Object newItem)
Removes the specified object from its parent list if it is an item, or
creates a new item if the specified object is not an item.
|
protected void | removeItem(SVGItem item)
Removes an item from the list.
|
protected SVGItem | removeItemImpl(int index)
Removes an existing item from the list.
|
protected SVGItem | replaceItemImpl(Object newItem, int index)
Replaces an existing item in the list with a new item.
|
protected void | resetAttribute()
Resets the value of the associated attribute. |
protected void | resetAttribute(SVGItem item)
Appends the string representation of the given {@link SVGItem} to
the DOM attribute. |
protected void | revalidate()
Initializes the list, if needed. |
protected abstract void | setAttributeValue(String value)
Sets the DOM attribute value containing the number list. |
protected void | setValueAsString(List value)
Sets the DOM attribute value to be the string representation of the
given list. |
Parameters: newItem The item which is to be inserted into the list. The first item is number 0.
Returns: The inserted item.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified. SVGException SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
Throws: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
Parameters: newItem the SVG object
Returns: the newly created {@link SVGItem} object
Parameters: value the attribute value to be parsed builder the object to be informed of the parsed list items
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 negative or greater than or equal to
numberOfItems
.
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. SVGException SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
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.
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
numberOfItems
, 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. SVGException SVG_WRONG_TYPE_ERR:
Raised if parameter newItem
is the wrong type of
object for the given list.
Parameters: newItem an instance of {@link SVGItem} to remove from its parent list, or an SVG object for which a new {@link SVGItem} should be created
Returns: item the {@link SVGItem} just removed from its parent list, or the newly created {@link SVGItem}
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 negative or greater
than or equal to numberOfItems
.
If newItem
is already in a list, it is removed from its
previous list before it is inserted into this list.
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 negative or greater
than or equal to numberOfItems
. SVGException SVG_WRONG_TYPE_ERR:
Raised if parameter newItem is the wrong type
of object for the given list.
Parameters: value the String representation of the list, or null if the list contains no items