Class AbstractSVGList

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List itemList
      The list of items.
      protected boolean valid
      Whether this list is valid.
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractSVGList()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected SVGItem appendItemImpl​(java.lang.Object newItem)
      Inserts a new item at the end of the list.
      protected abstract void checkItemType​(java.lang.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​(java.util.List list)
      Clears the list and sets the parent of the former list items to null.
      protected abstract org.w3c.dom.DOMException createDOMException​(short type, java.lang.String key, java.lang.Object[] args)
      Create a DOM Exception.
      protected abstract SVGItem createSVGItem​(java.lang.Object newItem)
      Creates an SVGItem object that has the same values as those in the specified SVG object.
      protected abstract void doParse​(java.lang.String value, ListHandler builder)
      Parses the given attribute value and informs the specified ListHandler of the parsed list items.
      protected SVGItem getItemImpl​(int index)
      Returns the item from the list at the specified index.
      protected abstract java.lang.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 java.lang.String getValueAsString()
      Returns the value of the DOM attribute containing the list.
      protected SVGItem initializeImpl​(java.lang.Object newItem)
      Removes all items from the list and adds the specified item to the list.
      protected SVGItem insertItemBeforeImpl​(java.lang.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 SVGItem object when its value changes.
      protected SVGItem removeIfNeeded​(java.lang.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​(java.lang.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 SVGItem to the DOM attribute.
      protected void revalidate()
      Initializes the list, if needed.
      protected abstract void setAttributeValue​(java.lang.String value)
      Sets the DOM attribute value containing the number list.
      protected void setValueAsString​(java.util.List value)
      Sets the DOM attribute value to be the string representation of the given list.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • valid

        protected boolean valid
        Whether this list is valid.
      • itemList

        protected java.util.List itemList
        The list of items.
    • Constructor Detail

      • AbstractSVGList

        public AbstractSVGList()
    • Method Detail

      • getItemSeparator

        protected abstract java.lang.String getItemSeparator()
        Returns the separator string to use when constructing a string representation of the entire list.
      • createSVGItem

        protected abstract SVGItem createSVGItem​(java.lang.Object newItem)
        Creates an SVGItem object that has the same values as those in the specified SVG object.
        Parameters:
        newItem - the SVG object
        Returns:
        the newly created SVGItem object
      • doParse

        protected abstract void doParse​(java.lang.String value,
                                        ListHandler builder)
                                 throws ParseException
        Parses the given attribute value and informs the specified ListHandler of the parsed list items.
        Parameters:
        value - the attribute value to be parsed
        builder - the object to be informed of the parsed list items
        Throws:
        ParseException
      • checkItemType

        protected abstract void checkItemType​(java.lang.Object newItem)
                                       throws org.w3c.dom.svg.SVGException
        Asserts that the given object is an appropriate SVG object for this list.
        Throws:
        org.w3c.dom.svg.SVGException
      • getValueAsString

        protected abstract java.lang.String getValueAsString()
        Returns the value of the DOM attribute containing the list.
      • setAttributeValue

        protected abstract void setAttributeValue​(java.lang.String value)
        Sets the DOM attribute value containing the number list.
        Parameters:
        value - the String representation of the list, or null if the list contains no items
      • createDOMException

        protected abstract org.w3c.dom.DOMException createDOMException​(short type,
                                                                       java.lang.String key,
                                                                       java.lang.Object[] args)
        Create a DOM Exception.
      • getNumberOfItems

        public int getNumberOfItems()
        Returns the number of items in the list.
      • clear

        public void clear()
                   throws org.w3c.dom.DOMException
        Removes all items from the list.
        Throws:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
      • initializeImpl

        protected SVGItem initializeImpl​(java.lang.Object newItem)
                                  throws org.w3c.dom.DOMException,
                                         org.w3c.dom.svg.SVGException
        Removes all items from the list and adds the specified item to the list.
        Parameters:
        newItem - the item which should become the only member of the list.
        Returns:
        the item being inserted into the list.
        Throws:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
        org.w3c.dom.svg.SVGException - SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
      • getItemImpl

        protected SVGItem getItemImpl​(int index)
                               throws org.w3c.dom.DOMException
        Returns the item from the list at the specified index.
        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:
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
      • insertItemBeforeImpl

        protected SVGItem insertItemBeforeImpl​(java.lang.Object newItem,
                                               int index)
                                        throws org.w3c.dom.DOMException,
                                               org.w3c.dom.svg.SVGException
        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.

        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:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
        org.w3c.dom.svg.SVGException - SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
      • replaceItemImpl

        protected SVGItem replaceItemImpl​(java.lang.Object newItem,
                                          int index)
                                   throws org.w3c.dom.DOMException,
                                          org.w3c.dom.svg.SVGException
        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.

        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:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
        org.w3c.dom.svg.SVGException - SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
      • removeItemImpl

        protected SVGItem removeItemImpl​(int index)
                                  throws org.w3c.dom.DOMException
        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:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
        org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
      • appendItemImpl

        protected SVGItem appendItemImpl​(java.lang.Object newItem)
                                  throws org.w3c.dom.DOMException,
                                         org.w3c.dom.svg.SVGException
        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.
        Parameters:
        newItem - The item which is to be inserted into the list. The first item is number 0.
        Returns:
        The inserted item.
        Throws:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
        org.w3c.dom.svg.SVGException - SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
      • removeIfNeeded

        protected SVGItem removeIfNeeded​(java.lang.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.
        Parameters:
        newItem - an instance of SVGItem to remove from its parent list, or an SVG object for which a new SVGItem should be created
        Returns:
        item the SVGItem just removed from its parent list, or the newly created SVGItem
      • revalidate

        protected void revalidate()
        Initializes the list, if needed.
      • setValueAsString

        protected void setValueAsString​(java.util.List value)
                                 throws org.w3c.dom.DOMException
        Sets the DOM attribute value to be the string representation of the given list.
        Throws:
        org.w3c.dom.DOMException
      • itemChanged

        public void itemChanged()
        Method to be called by a member SVGItem object when its value changes. This causes the DOM attribute to be reset.
      • resetAttribute

        protected void resetAttribute()
        Resets the value of the associated attribute.
      • resetAttribute

        protected void resetAttribute​(SVGItem item)
        Appends the string representation of the given SVGItem to the DOM attribute. This is called in response to an append to the list.
      • invalidate

        public void invalidate()
        Invalidates this list.
      • removeItem

        protected void removeItem​(SVGItem item)
        Removes an item from the list. This operation takes place when an item was already in one list and is being added to another one.
      • clear

        protected void clear​(java.util.List list)
        Clears the list and sets the parent of the former list items to null.