javax.swing.text.html

Class HTMLDocument.Iterator

Enclosing Class:
HTMLDocument

public static abstract class HTMLDocument.Iterator
extends Object

An iterator over a particular type of tag.

Method Summary

abstract AttributeSet
getAttributes()
Return the attribute set for this tag.
abstract int
getEndOffset()
Get the end of the range for the current occurrence of the tag being defined and having the same attributes.
abstract int
getStartOffset()
Get the start of the range for the current occurrence of the tag being defined and having the same attributes.
abstract HTML.Tag
getTag()
Type of tag this iterator represents.
abstract boolean
isValid()
Indicates whether or not the iterator currently represents an occurrence of the tag.
abstract void
next()
Move the iterator forward.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAttributes

public abstract AttributeSet getAttributes()
Return the attribute set for this tag.
Returns:
the AttributeSet (null if none found).

getEndOffset

public abstract int getEndOffset()
Get the end of the range for the current occurrence of the tag being defined and having the same attributes.
Returns:
the end of the range

getStartOffset

public abstract int getStartOffset()
Get the start of the range for the current occurrence of the tag being defined and having the same attributes.
Returns:
the start of the range (-1 if it can't be found).

getTag

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

isValid

public abstract boolean isValid()
Indicates whether or not the iterator currently represents an occurrence of the tag.
Returns:
true if the iterator currently represents an occurrence of the tag.

next

public abstract void next()
Move the iterator forward.

HTMLDocument.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.