Module org.w3c.dom.svg
Package org.w3c.dom.svg

Interface SVGPointList

All Known Implementing Classes:
AbstractSVGPointList, SVGOMAnimatedPoints.AnimSVGPointList, SVGOMAnimatedPoints.BaseSVGPointList
public interface SVGPointList
A list of SVGPoint objects.

  • Method Details

    • getNumberOfItems

      int getNumberOfItems()
      The number of items in the list.
      Returns:
      The number of items.

    • clear

      void clear() throws DOMException
      Clears all existing current items from the list, with the result being an empty list.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if this list is read only.

    • initialize

      SVGPoint initialize(SVGPoint newItem) throws DOMException, SVGException
      Clear this list and add the given value to it.
      Parameters:
      newItem - the value.
      Returns:
      the value.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if this list is read only.
      SVGException

    • getItem

      SVGPoint getItem(int index) throws DOMException
      Get the specified item from 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 specified item from the list.
      Throws:
      DOMException - INDEX_SIZE_ERR if the index number is greater than or equal to numberOfItems.

    • insertItemBefore

      SVGPoint insertItemBefore(SVGPoint newItem, int index) throws DOMException, 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. 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 numberOfItems, then the new item is appended to the end of the list.
      Returns:
      The inserted item.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if this list is read only.
      SVGException

    • replaceItem

      SVGPoint replaceItem(SVGPoint newItem, int index) throws DOMException, 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. 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 if this list is read only, INDEX_SIZE_ERR if the index number is greater than or equal to numberOfItems.
      SVGException

    • removeItem

      SVGPoint removeItem(int index) throws 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:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if this list is read only, INDEX_SIZE_ERR if the index number is greater than or equal to numberOfItems.

    • appendItem

      SVGPoint appendItem(SVGPoint newItem) throws DOMException, 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. The inserted item is the item itself and not a copy.

      Parameters:
      newItem - The item which is to be appended.
      Returns:
      the new item.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if this list is read only.
      SVGException