Class HTMLDocument.Iterator

java.lang.Object
javax.swing.text.html.HTMLDocument.Iterator
Enclosing class:
HTMLDocument
public abstract static class HTMLDocument.Iterator extends Object
An iterator to iterate over a particular type of tag. The iterator is not thread safe. If reliable access to the document is not already ensured by the context under which the iterator is being used, its use should be performed under the protection of Document.render.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Iterator()
    Constructor for subclasses to call.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract AttributeSet
    getAttributes()
    Return the attributes for this tag.
    abstract int
    getEndOffset()
    Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.
    abstract int
    getStartOffset()
    Returns the start of the range for which the current occurrence of the tag is defined and has the same attributes.
    abstract HTML.Tag
    getTag()
    Type of tag this iterator represents.
    abstract boolean
    isValid()
    Indicates if the iterator is currently representing an occurrence of a tag.
    abstract void
    next()
    Move the iterator forward to the next occurrence of the tag it represents.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • Iterator

      protected Iterator()
      Constructor for subclasses to call.

  • Method Details

    • getAttributes

      public abstract AttributeSet getAttributes()
      Return the attributes for this tag.
      Returns:
      the AttributeSet for this tag, or null if none can be found

    • getStartOffset

      public abstract int getStartOffset()
      Returns the start of the range for which the current occurrence of the tag is defined and has the same attributes.
      Returns:
      the start of the range, or -1 if it can't be found

    • getEndOffset

      public abstract int getEndOffset()
      Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.
      Returns:
      the end of the range

    • next

      public abstract void next()
      Move the iterator forward to the next occurrence of the tag it represents.

    • isValid

      public abstract boolean isValid()
      Indicates if the iterator is currently representing an occurrence of a tag. If false there are no more tags for this iterator.
      Returns:
      true if the iterator is currently representing an occurrence of a tag, otherwise returns false

    • getTag

      public abstract HTML.Tag getTag()
      Type of tag this iterator represents.
      Returns:
      the tag