| 
 | JavaTM 2 Platform Std. Ed. v1.3.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--javax.swing.text.AbstractDocument | +--javax.swing.text.DefaultStyledDocument | +--javax.swing.text.html.HTMLDocument
A document that models HTML.  The purpose of this model
 is to support both browsing and editing.  As a result,
 the structure described by an HTML document is not 
 exactly replicated by default.  The element structure that 
 is modeled by default, is built by the class
 HTMLDocument.HTMLReader, which implements
 the HTMLEditorKit.ParserCallback protocol
 that the parser expects.  To change the structure one
 can subclass HTMLReader, and reimplement the method
 getReader to return the new
 reader implementation.  The documentation for 
 HTMLReader should be consulted for the details of
 the default structure created.  The intent is that 
 the document be non-lossy (although reproducing the
 HTML format may result in a different format).
 
 The document models only HTML, and makes no attempt to
 store view attributes in it.  The elements are identified
 by the StyleContext.NameAttribute attribute,
 which should always have a value of type HTML.Tag
 that identifies the kind of element.  Some of the elements
 (such as comments) are synthesized.  The HTMLFactory
 uses this attribute to determine what kind of view to build.
 
 This document supports incremental loading.  The
 TokenThreshold property controls how
 much of the parse is buffered before trying to update
 the element structure of the document.  This property
 is set by the EditorKit so that subclasses can disable
 it.
 
 The Base property determines the URL
 against which relative URLs are resolved.
 By default, this will be the 
 Document.StreamDescriptionProperty if
 the value of the property is a URL.  If a <BASE>
 tag is encountered, the base will become the URL specified
 by that tag.  Because the base URL is a property, it
 can of course be set directly.
 
The default content storage mechanism for this document is a gap buffer (GapContent). Alternatives can be supplied by using the constructor that takes a Content implementation.
| Inner Class Summary | |
|  class | HTMLDocument.BlockElementAn element that represents a structural block of HTML. | 
|  class | HTMLDocument.HTMLReaderAn HTML reader to load an HTML document with an HTML element structure. | 
| static class | HTMLDocument.IteratorAn iterator to iterate over a particular type of tag. | 
|  class | HTMLDocument.RunElementAn element that represents a chunk of text that has a set of HTML character level attributes assigned to it. | 
| Inner classes inherited from class javax.swing.text.DefaultStyledDocument | 
| DefaultStyledDocument.AttributeUndoableEdit, DefaultStyledDocument.ElementBuffer, DefaultStyledDocument.ElementSpec, DefaultStyledDocument.SectionElement | 
| Inner classes 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 | AdditionalCommentsDocument property key value. | 
| Fields inherited from class javax.swing.text.DefaultStyledDocument | 
| buffer, BUFFER_SIZE_DEFAULT | 
| Fields inherited from class javax.swing.text.AbstractDocument | 
| BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName | 
| Fields inherited from interface javax.swing.text.Document | 
| StreamDescriptionProperty, TitleProperty | 
| Constructor Summary | |
| HTMLDocument()Constructs an HTML document. | |
| HTMLDocument(AbstractDocument.Content c,
             StyleSheet styles)Constructs an HTML document with the given content storage implementation and the given style/attribute storage mechanism. | |
| HTMLDocument(StyleSheet styles)Constructs an HTML document with the default content storage implementation and the given style/attribute storage mechanism. | |
| Method Summary | |
| protected  void | create(DefaultStyledDocument.ElementSpec[] data)Replaces the contents of the document with the given element specifications. | 
| protected  Element | createBranchElement(Element parent,
                    AttributeSet a)Creates a document branch element, that can contain other elements. | 
| protected  AbstractDocument.AbstractElement | createDefaultRoot()Creates the root element to be used to represent the default document structure. | 
| protected  Element | createLeafElement(Element parent,
                  AttributeSet a,
                  int p0,
                  int p1)Creates a document leaf element that directly represents text (doesn't have any children). | 
| protected  void | fireChangedUpdate(DocumentEvent e)Notifies all listeners that have registered interest for notification on this event type. | 
| protected  void | fireUndoableEditUpdate(UndoableEditEvent e)Notifies all listeners that have registered interest for notification on this event type. | 
|  URL | getBase()Gets the location to resolve relative URLs against. | 
|  Element | getElement(Element e,
           Object attribute,
           Object value)Returns the child element of ethat contains the
 attribute,attributewith valuevalue, or
 null if one isn't found. | 
|  Element | getElement(String id)Fetches the element that has the given id attribute. | 
|  HTMLDocument.Iterator | getIterator(HTML.Tag t)Fetches an iterator for the following kind of HTML tag. | 
|  HTMLEditorKit.Parser | getParser()Returns the parser that is used when inserting HTML into the existing document. | 
|  boolean | getPreservesUnknownTags() | 
|  HTMLEditorKit.ParserCallback | getReader(int pos)Fetches the reader for the parser to use to load the document with HTML. | 
|  HTMLEditorKit.ParserCallback | getReader(int pos,
          int popDepth,
          int pushDepth,
          HTML.Tag insertTag)Fetches the reader for the parser to use to load the document with HTML. | 
|  StyleSheet | getStyleSheet()Fetches the StyleSheet with the document-specific display rules (CSS) that were specified in the HTML document itself. | 
|  int | getTokenThreshold()Gets the number of tokens to buffer before trying to update the documents element structure. | 
| protected  void | insert(int offset,
       DefaultStyledDocument.ElementSpec[] data)Inserts new elements in bulk. | 
|  void | insertAfterEnd(Element elem,
               String htmlText)Inserts the HTML specified as a string after the the end of the given element. | 
|  void | insertAfterStart(Element elem,
                 String htmlText)Inserts the HTML specified as a string at the start of the element. | 
|  void | insertBeforeEnd(Element elem,
                String htmlText)Inserts the HTML specified as a string at the end of the element. | 
|  void | insertBeforeStart(Element elem,
                  String htmlText)Inserts the HTML specified as string before the start of the given element. | 
| protected  void | insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
             AttributeSet attr)Updates document structure as a result of text insertion. | 
|  void | processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent e)Processes HyperlinkEvents that are generated by documents in an HTML frame. | 
|  void | setBase(URL u)Sets the location to resolve relative URLs against. | 
|  void | setInnerHTML(Element elem,
             String htmlText)Replaces the children of the given element with the contents specified as an HTML string. | 
|  void | setOuterHTML(Element elem,
             String htmlText)Replaces the given element in the parent with the contents specified as an HTML string. | 
|  void | setParagraphAttributes(int offset,
                       int length,
                       AttributeSet s,
                       boolean replace)Sets attributes for a paragraph. | 
|  void | setParser(HTMLEditorKit.Parser parser)Sets the parser that is used by the methods that insert html into the existing document, eg setInnerHTML,setOuterHTML... | 
|  void | setPreservesUnknownTags(boolean preservesTags)Sets how unknown tags are handled. | 
|  void | setTokenThreshold(int n)Sets the number of tokens to buffer before trying to update the documents element structure. | 
| Methods inherited from class javax.swing.text.DefaultStyledDocument | 
| addDocumentListener, addStyle, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, removeDocumentListener, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, styleChanged | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface javax.swing.text.Document | 
| addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render | 
| Field Detail | 
public static final String AdditionalComments
| Constructor Detail | 
public HTMLDocument()
public HTMLDocument(StyleSheet styles)
styles - the stylespublic HTMLDocument(AbstractDocument.Content c, StyleSheet styles)
c - the container for the contentstyles - the styles| Method Detail | 
public HTMLEditorKit.ParserCallback getReader(int pos)
public HTMLEditorKit.ParserCallback getReader(int pos, int popDepth, int pushDepth, HTML.Tag insertTag)
popDepth - the number of ElementSpec.EndTagTypes to generate before
        insertingpushDepth - the number of ElementSpec.StartTagTypes with a direction
        of ElementSpec.JoinNextDirection that should be generated
        before inserting, but after the end tags have been generatedinsertTag - the first tag to start inserting into documentpublic URL getBase()
public void setBase(URL u)
This also sets the base of the StyleSheet to be u
 as well as the receiver.
protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException
insert in class DefaultStyledDocumentoffset - the starting offsetdata - the element dataBadLocationException - if the given position does not 
   represent a valid location in the associated document.protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)
insertUpdate in class DefaultStyledDocumentchng - a description of the document changeattr - the attributesprotected void create(DefaultStyledDocument.ElementSpec[] data)
create in class DefaultStyledDocument
public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)
This method is thread safe, although most Swing methods are not. Please see Threads and Swing for more information.
setParagraphAttributes in class DefaultStyledDocumentoffset - the offset into the paragraph (must be at least 0)length - the number of characters affected (must be at least 0)s - the attributesreplace - whether to replace existing attributes, or merge thempublic StyleSheet getStyleSheet()
public HTMLDocument.Iterator getIterator(HTML.Tag t)
protected Element createLeafElement(Element parent, AttributeSet a, int p0, int p1)
HTMLDocument.RunElement.createLeafElement in class AbstractDocumentparent - the parent elementa - the attributes for the elementp0 - the beginning of the range (must be at least 0)p1 - the end of the range (must be at least p0)protected Element createBranchElement(Element parent, AttributeSet a)
HTMLDocument.BlockElement.createBranchElement in class AbstractDocumentparent - the parent elementa - the attributesprotected AbstractDocument.AbstractElement createDefaultRoot()
createDefaultRoot in class DefaultStyledDocumentpublic void setTokenThreshold(int n)
public int getTokenThreshold()
Integer.MAX_VALUE.public void setPreservesUnknownTags(boolean preservesTags)
public boolean getPreservesUnknownTags()
public void processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent e)
e - the eventpublic void setParser(HTMLEditorKit.Parser parser)
setInnerHTML, 
 setOuterHTML...
 
 HTMLEditorKit.createDefaultDocument will set the parser
 for you. If you create an HTMLDocument by hand, be sure and set the
 parser accordingly.
public HTMLEditorKit.Parser getParser()
public void setInnerHTML(Element elem, String htmlText) throws BadLocationException, IOException
This will be seen as at least two events, n inserts followed by a remove.
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalArgumentException - is elem is a leafIllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public void setOuterHTML(Element elem, String htmlText) throws BadLocationException, IOException
This will be seen as at least two events, n inserts followed by a remove.
When replacing a leaf this will attempt to make sure there is a newline present if one is needed. This may result in an additional element being inserted. Consider, if you were to replace a character element that contained a newline with <img> this would create two elements, one for the image, ane one for the newline.
If you try to replace the element at length you will most likely end up with two elements, eg setOuterHTML(getCharacterElement (getLength()), "blah") will result in two leaf elements at the end, one representing 'blah', and the other representing the end element.
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public void insertAfterStart(Element elem, String htmlText) throws BadLocationException, IOException
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public void insertBeforeEnd(Element elem, String htmlText) throws BadLocationException, IOException
 If elem's children are leafs, at the 
 character at a elem.getEndOffset() - 1 is a newline,
 this will insert before the newline so that there isn't text after
 the newline.
 
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public void insertBeforeStart(Element elem, String htmlText) throws BadLocationException, IOException
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public void insertAfterEnd(Element elem, String htmlText) throws BadLocationException, IOException
For this to work correcty, the receiver must have an
 HTMLEditorKit.Parser set. This will be the case if the receiver
 was created from an HTMLEditorKit via the
 createDefaultDocument method.
IllegalStateException - if an HTMLEditorKit.Parser has not
         been set on the receiver.public Element getElement(String id)
public Element getElement(Element e, Object attribute, Object value)
e that contains the
 attribute, attribute with value value, or
 null if one isn't found. This is not thread-safe.protected void fireChangedUpdate(DocumentEvent e)
fireChangedUpdate in class AbstractDocumente - the eventEventListenerListprotected void fireUndoableEditUpdate(UndoableEditEvent e)
fireUndoableEditUpdate in class AbstractDocumente - the eventEventListenerList| 
 | JavaTM 2 Platform Std. Ed. v1.3.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A.  All Rights Reserved.