javax.swing.text.html

Class HTMLDocument

Implemented Interfaces:
Document, Serializable, StyledDocument

public class HTMLDocument
extends DefaultStyledDocument

TODO: This class is not yet completetely implemented.

See Also:
Serialized Form

Nested Class Summary

class
HTMLDocument.BlockElement
static class
HTMLDocument.Iterator
An iterator over a particular type of tag.

Nested classes/interfaces inherited from class javax.swing.text.DefaultStyledDocument

DefaultStyledDocument.ElementBuffer, DefaultStyledDocument.ElementSpec, DefaultStyledDocument.SectionElement

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

static String
AdditionalComments
A key for document properies.

Fields inherited from class javax.swing.text.DefaultStyledDocument

BUFFER_SIZE_DEFAULT, buffer

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, ParagraphElementName, SectionElementName, listenerList

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Method Summary

URL
getBase()
Returns the location against which to resolve relative URLs.
HTMLDocument.Iterator
getIterator(HTML.Tag t)
Gets an iterator for the given HTML.Tag.
boolean
getPreservesUnknownTags()
Returns whether or not the parser preserves unknown HTML tags.
void
processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent event)
void
setBase(URL u)
Sets the location against which to resolve relative URLs.
void
setPreservesUnknownTags(boolean preservesTags)
Sets the behaviour of the parser when it encounters unknown HTML tags.

Methods inherited from class javax.swing.text.DefaultStyledDocument

addStyle, createDefaultRoot, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, insertUpdate, removeStyle, setCharacterAttributes, setLogicalStyle, setParagraphAttributes

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDefaultRootElement, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getParagraphElement, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, insertUpdate, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, removeUpdate, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AdditionalComments

public static final String AdditionalComments
A key for document properies. The value for the key is a Vector of Strings of comments not found in the body.

Field Value:
""

Method Details

getBase

public URL getBase()
Returns the location against which to resolve relative URLs. This is the document's URL if the document was loaded from a URL. If a base tag is found, it will be used.

Returns:
the base URL


getIterator

public HTMLDocument.Iterator getIterator(HTML.Tag t)
Gets an iterator for the given HTML.Tag.

Parameters:
t - the requested HTML.Tag

Returns:
the Iterator


getPreservesUnknownTags

public boolean getPreservesUnknownTags()
Returns whether or not the parser preserves unknown HTML tags.

Returns:
true if the parser preserves unknown tags


processHTMLFrameHyperlinkEvent

public void processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent event)


setBase

public void setBase(URL u)
Sets the location against which to resolve relative URLs.

Parameters:
u - the new base URL


setPreservesUnknownTags

public void setPreservesUnknownTags(boolean preservesTags)
Sets the behaviour of the parser when it encounters unknown HTML tags.

Parameters:
preservesTags - true if the parser should preserve unknown tags.


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.