HTMLDocument JDK 1.6)

Methods

Hide/Show inherited methods

public void addDocumentListener (DocumentListener listener) [Inherited From DefaultStyledDocument]

Adds a document listener for notification of any changes.

pack-private void addMap (Map map)

Adds the specified map, this will remove a Map that has been previously registered with the same name.

Adds the specified map, this will remove a Map that has been
previously registered with the same name.
Parameters:
- map - the Map to be registered

public Style addStyle (String nm, Style parent) [Inherited From DefaultStyledDocument]

Adds a new style into the logical style hierarchy.

public void addUndoableEditListener (UndoableEditListener listener) [Inherited From AbstractDocument]

Adds an undo listener for notification of any changes.

Adds an undo listener for notification of any changes.
Undo/Redo operations performed on the UndoableEdit
will cause the appropriate DocumentEvent to be fired to keep
the view(s) in sync with the model.
Parameters:
- listener - the UndoableEditListener to add
See Also: Document.addUndoableEditListener(javax.swing.event.UndoableEditListener),

protected void create (ElementSpec data) [Overrides DefaultStyledDocument]

Replaces the contents of the document with the given element specifications.

protected Element createBranchElement (Element parent, AttributeSet a) [Overrides AbstractDocument]

Creates a document branch element, that can contain other elements.

Creates a document branch element, that can contain other elements.
This is implemented to return an element of type
HTMLDocument.BlockElement.
Returns: the element
Parameters:
- parent - the parent element
- a - the attributes

protected AbstractElement createDefaultRoot () [Overrides DefaultStyledDocument]

Creates the root element to be used to represent the default document structure.

protected Element createLeafElement (Element parent, AttributeSet a, int p0, int p1) [Overrides AbstractDocument]

Creates a document leaf element that directly represents text (doesn't have any children).

Creates a document leaf element that directly represents
text (doesn't have any children). This is implemented
to return an element of type
HTMLDocument.RunElement.
Returns: the new element
Parameters:
- parent - the parent element
- a - the attributes for the element
- p0 - the beginning of the range (must be at least 0)
- p1 - the end of the range (must be at least p0)

publicsynchronized Position createPosition (int offs) throws BadLocationException [Inherited From AbstractDocument]

Returns a position that will track change as the document is altered.

public void dump (PrintStream out) [Inherited From AbstractDocument]

Gives a diagnostic dump.

protected void fireChangedUpdate (DocumentEvent e) [Overrides AbstractDocument]

Notifies all listeners that have registered interest for notification on this event type.

protected void fireInsertUpdate (DocumentEvent e) [Inherited From AbstractDocument]

Notifies all listeners that have registered interest for notification on this event type.

protected void fireRemoveUpdate (DocumentEvent e) [Inherited From AbstractDocument]

Notifies all listeners that have registered interest for notification on this event type.

protected void fireUndoableEditUpdate (UndoableEditEvent e) [Overrides AbstractDocument]

Notifies all listeners that have registered interest for notification on this event type.

public int getAsynchronousLoadPriority () [Inherited From AbstractDocument]

Gets the asynchronous loading priority.

Gets the asynchronous loading priority. If less than zero,
the document should not be loaded asynchronously.
Returns: the asynchronous loading priority, or -1 if the document should not be loaded asynchronously

protectedfinal AttributeContext getAttributeContext () [Inherited From AbstractDocument]

Fetches the context for managing attributes.

public Color getBackground (AttributeSet attr) [Inherited From DefaultStyledDocument]

Gets the background color from an attribute set.

public URL getBase ()

Returns the location to resolve relative URLs against.

pack-private String getBaseTarget ()

public Element getBidiRootElement () [Inherited From AbstractDocument]

Returns the root element of the bidirectional structure for this document.

public Element getCharacterElement (int pos) [Inherited From DefaultStyledDocument]

Gets a character element based on a position.

protectedfinal Content getContent () [Inherited From AbstractDocument]

Gets the content for the document.

protectedfinalsynchronized Thread getCurrentWriter () [Inherited From AbstractDocument]

Fetches the current writing thread if there is one.

Fetches the current writing thread if there is one.
This can be used to distinguish whether a method is
being called as part of an existing modification or
if a lock needs to be acquired and a new transaction
started.
Returns: the thread actively modifying the document or null if there are no modifications in progress

public Element getDefaultRootElement () [Inherited From DefaultStyledDocument] [Specified in AbstractDocument]

Gets the default root element.

pack-private String getDefaultStyleSheetType ()

Returns the content type language used for style sheets.

public DocumentFilter getDocumentFilter () [Inherited From AbstractDocument]

Returns the DocumentFilter that is responsible for filtering of insertion/removal.

Returns the DocumentFilter that is responsible for
filtering of insertion/removal. A null return value
implies no filtering is to occur.
Returns: the DocumentFilter
Since: 1.4
See Also: AbstractDocument.setDocumentFilter(javax.swing.text.DocumentFilter),

public DocumentListener getDocumentListeners () [Inherited From AbstractDocument]

Returns an array of all the document listeners registered on this document.

Returns an array of all the document listeners
registered on this document.
Returns: all of this document's DocumentListeners or an empty array if no document listeners are currently registered
Since: 1.4
See Also: AbstractDocument.addDocumentListener(javax.swing.event.DocumentListener), AbstractDocument.removeDocumentListener(javax.swing.event.DocumentListener),

public Dictionary<Object, Object> getDocumentProperties () [Inherited From AbstractDocument]

Supports managing a set of properties.

Supports managing a set of properties. Callers
can use the documentProperties dictionary
to annotate the document with document-wide properties.
Returns: a non-null Dictionary
See Also: AbstractDocument.setDocumentProperties(java.util.Dictionary),

public Element getElement (Element e, Object attribute, Object value)

Returns the child element of e that contains the attribute, attribute with value value, or null if one isn't found.

Returns the child element of e that contains the
attribute, attribute with value value, or
null if one isn't found. This is not thread-safe.
Returns: the element with the specified Attribute and the specified value, or null if it can't be found
Parameters:
- e - the root element where the search begins
- attribute - the desired Attribute
- value - the values for the specified Attribute
Since: 1.3
See Also: HTML.Attribute,

public Element getElement (String id)

Returns the element that has the given id Attribute.

Returns the element that has the given id Attribute.
If the element can't be found, null is returned.
Note that this method works on an Attribute,
not a character tag. In the following HTML snippet:
<a id="HelloThere"> the attribute is
'id' and the character tag is 'a'.
This is a convenience method for
getElement(RootElement, HTML.Attribute.id, id).
This is not thread-safe.
Returns: the element with the specified Attribute or null if it can't be found, or null if id is null
Parameters:
- id - the string representing the desired Attribute
Since: 1.3
See Also: HTML.Attribute,

publicfinal Position getEndPosition () [Inherited From AbstractDocument]

Returns a position that represents the end of the document.

public Font getFont (AttributeSet attr) [Inherited From DefaultStyledDocument]

Gets the font from an attribute set.

public Color getForeground (AttributeSet attr) [Inherited From DefaultStyledDocument]

Gets the foreground color from an attribute set.

public Iterator getIterator (Tag t)

Fetches an iterator for the specified HTML tag.

Fetches an iterator for the specified HTML tag.
This can be used for things like iterating over the
set of anchors contained, or iterating over the input
elements.
Returns: the Iterator for the given HTML tag
Parameters:
- t - the requested HTML.Tag
See Also: HTML.Tag,

public int getLength () [Inherited From AbstractDocument]

Returns the length of the data.

public T getListeners (Class< T> listenerType) [Inherited From AbstractDocument]

Returns an array of all the objects currently registered as FooListeners upon this document.

Returns an array of all the objects currently registered as FooListeners upon this document. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a document d for its document listeners with the following code:

DocumentListener[] mls = (DocumentListener[])(d.getListeners(DocumentListener.class));

If no such listeners exist, this method returns an empty array.
Returns: an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added
Parameters:
- listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Throws:
- ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener
Since: 1.3
See Also: AbstractDocument.getDocumentListeners(), AbstractDocument.getUndoableEditListeners(),

public Style getLogicalStyle (int p) [Inherited From DefaultStyledDocument]

Fetches the logical style assigned to the paragraph represented by the given position.

pack-private Map getMap (String name)

Returns the Map associated with the given name.

Returns the Map associated with the given name.
Returns: the Map or null if it can't be found, or if name is null
Parameters:
- the - name of the desired Map

pack-private Enumeration getMaps ()

Returns an Enumeration of the possible Maps.

Returns an Enumeration of the possible Maps.
Returns: the enumerated list of maps, or null if the maps are not an instance of Hashtable

public Element getParagraphElement (int pos) [Inherited From DefaultStyledDocument] [Specified in AbstractDocument]

Gets the paragraph element at the offset pos.

Gets the paragraph element at the offset pos.
A paragraph consists of at least one child Element, which is usually
a leaf.
Returns: the element
Parameters:
- pos - the starting offset >= 0

public Parser getParser ()

Returns the parser that is used when inserting HTML into the existing document.

public boolean getPreservesUnknownTags ()

Returns the behavior the parser observes when encountering unknown tags.

publicfinal Object getProperty (Object key) [Inherited From AbstractDocument]

A convenience method for looking up a property value.

A convenience method for looking up a property value. It is
equivalent to:


 getDocumentProperties().get(key);

Returns: the value of this property or null
Parameters:
- key - the non-null property key
See Also: AbstractDocument.getDocumentProperties(),

public ParserCallback getReader (int pos)

Fetches the reader for the parser to use when loading the document with HTML.

Fetches the reader for the parser to use when loading the document
with HTML. This is implemented to return an instance of
HTMLDocument.HTMLReader.
Subclasses can reimplement this
method to change how the document gets structured if desired.
(For example, to handle custom tags, or structurally represent character
style elements.)
Returns: the reader used by the parser to load the document
Parameters:
- pos - the starting position

public ParserCallback getReader (int pos, int popDepth, int pushDepth, Tag insertTag)

Returns the reader for the parser to use to load the document with HTML.

Returns the reader for the parser to use to load the document with HTML. This is implemented to return an instance of HTMLDocument.HTMLReader. Subclasses can reimplement this method to change how the document gets structured if desired. (For example, to handle custom tags, or structurally represent character style elements.)

This is a convenience method for getReader(int, int, int, HTML.Tag, TRUE).
Returns: the reader used by the parser to load the document
Parameters:
- popDepth - the number of ElementSpec.EndTagTypes to generate before inserting
- pushDepth - the number of ElementSpec.StartTagTypes with a direction of ElementSpec.JoinNextDirection that should be generated before inserting, but after the end tags have been generated
- insertTag - the first tag to start inserting into document

pack-private ParserCallback getReader (int pos, int popDepth, int pushDepth, Tag insertTag, boolean insertInsertTag)

Fetches the reader for the parser to use to load the document with HTML.

Fetches the reader for the parser to use to load the document
with HTML. This is implemented to return an instance of
HTMLDocument.HTMLReader. Subclasses can reimplement this
method to change how the document get structured if desired
(e.g. to handle custom tags, structurally represent character
style elements, etc.).
Returns: the reader used by the parser to load the document
Parameters:
- popDepth - the number of ElementSpec.EndTagTypes to generate before inserting
- pushDepth - the number of ElementSpec.StartTagTypes with a direction of ElementSpec.JoinNextDirection that should be generated before inserting, but after the end tags have been generated
- insertTag - the first tag to start inserting into document
- insertInsertTag - false if all the Elements after insertTag should be inserted; otherwise insertTag will be inserted

public Element getRootElements () [Inherited From AbstractDocument]

Gets all root elements defined.

publicfinal Position getStartPosition () [Inherited From AbstractDocument]

Returns a position that represents the start of the document.

public Style getStyle (String nm) [Inherited From DefaultStyledDocument]

Fetches a named style previously added.

public Enumeration<Object> getStyleNames () [Inherited From DefaultStyledDocument]

Fetches the list of of style names.

public StyleSheet getStyleSheet ()

Fetches the StyleSheet with the document-specific display rules (CSS) that were specified in the HTML document itself.

Fetches the StyleSheet with the document-specific display
rules (CSS) that were specified in the HTML document itself.
Returns: the StyleSheet

public String getText (int offset, int length) throws BadLocationException [Inherited From AbstractDocument]

Gets a sequence of text from the document.

public void getText (int offset, int length, Segment txt) throws BadLocationException [Inherited From AbstractDocument]

Fetches the text contained within the given portion of the document.

If the partialReturn property on the txt parameter is false, the data returned in the Segment will be the entire length requested and may or may not be a copy depending upon how the data was stored. If the partialReturn property is true, only the amount of text that can be returned without creating a copy is returned. Using partial returns will give better performance for situations where large parts of the document are being scanned. The following is an example of using the partial return to access the entire document:

   int nleft = doc.getDocumentLength();
   Segment text = new Segment();
   int offs = 0;
   text.setPartialReturn(true);   
   while (nleft > 0) {
       doc.getText(offs, nleft, text);
       // do something with text
       nleft -= text.count;
       offs += text.count;
   }

Parameters:
- offset - the starting offset >= 0
- length - the number of characters to retrieve >= 0
- txt - the Segment object to retrieve the text into
Throws:
- BadLocationException - the range given includes a position that is not a valid position within the document

public int getTokenThreshold ()

Gets the number of tokens to buffer before trying to update the documents element structure.

Gets the number of tokens to buffer before trying to update
the documents element structure. The default value is
Integer.MAX_VALUE.
Returns: the number of tokens to buffer

public UndoableEditListener getUndoableEditListeners () [Inherited From AbstractDocument]

Returns an array of all the undoable edit listeners registered on this document.

Returns an array of all the undoable edit listeners
registered on this document.
Returns: all of this document's UndoableEditListeners or an empty array if no undoable edit listeners are currently registered
Since: 1.4
See Also: AbstractDocument.addUndoableEditListener(javax.swing.event.UndoableEditListener), AbstractDocument.removeUndoableEditListener(javax.swing.event.UndoableEditListener),

pack-private boolean hasBaseTag ()

protected void insert (int offset, ElementSpec data) throws BadLocationException [Overrides DefaultStyledDocument]

Inserts new elements in bulk.

public void insertAfterEnd (Element elem, String htmlText) throws BadLocationException IOException

Inserts the HTML specified as a string after the the end of the given element.

public void insertAfterStart (Element elem, String htmlText) throws BadLocationException IOException

Inserts the HTML specified as a string at the start of the element.

public void insertBeforeEnd (Element elem, String htmlText) throws BadLocationException IOException

Inserts the HTML specified as a string at the end of the element.

public void insertBeforeStart (Element elem, String htmlText) throws BadLocationException IOException

Inserts the HTML specified as a string before the start of the given element.

public void insertString (int offs, String str, AttributeSet a) throws BadLocationException [Inherited From AbstractDocument]

Inserts some content into the document.

protected void insertUpdate (DefaultDocumentEvent chng, AttributeSet attr) [Overrides DefaultStyledDocument]

Updates document structure as a result of text insertion.

pack-private boolean isFrameDocument ()

Returns true if the document will be viewed in a frame.

pack-privatestatic boolean matchNameAttribute (AttributeSet attr, Tag tag)

Returns true if StyleConstants.NameAttribute is equal to the tag that is passed in as a parameter.

Returns true if StyleConstants.NameAttribute is
equal to the tag that is passed in as a parameter.
Returns: true if there is a match, false otherwise
Parameters:
- attr - the attributes to be matched
- tag - the value to be matched
See Also: HTML.Attribute,

pack-private void obtainLock ()

protected void postRemoveUpdate (DefaultDocumentEvent chng) [Inherited From AbstractDocument]

Updates any document structure as a result of text removal.

public void processHTMLFrameHyperlinkEvent (HTMLFrameHyperlinkEvent e)

Processes HyperlinkEvents that are generated by documents in an HTML frame.

Processes HyperlinkEvents that are generated by documents in an HTML frame. The HyperlinkEvent type, as the parameter suggests, is HTMLFrameHyperlinkEvent. In addition to the typical information contained in a HyperlinkEvent, this event contains the element that corresponds to the frame in which the click happened (the source element) and the target name. The target name has 4 possible values:

_self
_parent
_top
a named frame

If target is _self, the action is to change the value of the HTML.Attribute.SRC attribute and fires a ChangedUpdate event.

If the target is _parent, then it deletes the parent element, which is a <FRAMESET> element, and inserts a new <FRAME> element, and sets its HTML.Attribute.SRC attribute to have a value equal to the destination URL and fire a RemovedUpdate and InsertUpdate.

If the target is _top, this method does nothing. In the implementation of the view for a frame, namely the FrameView, the processing of _top is handled. Given that _top implies replacing the entire document, it made sense to handle this outside of the document that it will replace.

If the target is a named frame, then the element hierarchy is searched for an element with a name equal to the target, its HTML.Attribute.SRC attribute is updated and a ChangedUpdate event is fired.
Parameters:
- e - the event

publicfinal void putProperty (Object key, Object value) [Inherited From AbstractDocument]

A convenience method for storing up a property value.

A convenience method for storing up a property value. It is
equivalent to:


 getDocumentProperties().put(key, value);

If value is null this method will
remove the property.
Parameters:
- key - the non-null key
- value - the property value
See Also: AbstractDocument.getDocumentProperties(),

publicfinalsynchronized void readLock () [Inherited From AbstractDocument]

Acquires a lock to begin reading some state from the document.

Acquires a lock to begin reading some state from the
document. There can be multiple readers at the same time.
Writing blocks the readers until notification of the change
to the listeners has been completed. This method should
be used very carefully to avoid unintended compromise
of the document. It should always be balanced with a
readUnlock.
See Also: AbstractDocument.readUnlock(),

publicfinalsynchronized void readUnlock () [Inherited From AbstractDocument]

Does a read unlock.

Does a read unlock. This signals that one
of the readers is done. If there are no more readers
then writing can begin again. This should be balanced
with a readLock, and should occur in a finally statement
so that the balance is guaranteed. The following is an
example.


     readLock();
     try {
         // do something
     } finally {
         readUnlock();
     }

See Also: AbstractDocument.readLock(),

pack-private void releaseLock ()

public void remove (int offs, int len) throws BadLocationException [Inherited From AbstractDocument]

Removes some content from the document.

public void removeDocumentListener (DocumentListener listener) [Inherited From DefaultStyledDocument]

Removes a document listener.

pack-private void removeMap (Map map)

Removes a previously registered map.

Removes a previously registered map.
Parameters:
- map - the Map to be removed

public void removeStyle (String nm) [Inherited From DefaultStyledDocument]

Removes a named style previously added to the document.

public void removeUndoableEditListener (UndoableEditListener listener) [Inherited From AbstractDocument]

Removes an undo listener.

Removes an undo listener.
Parameters:
- listener - the UndoableEditListener to remove
See Also: Document.removeDocumentListener(javax.swing.event.DocumentListener),

protected void removeUpdate (DefaultDocumentEvent chng) [Inherited From DefaultStyledDocument]

Updates document structure as a result of text removal.

public void render (Runnable r) [Inherited From AbstractDocument]

This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously.

public void replace (int offset, int length, String text, AttributeSet attrs) throws BadLocationException [Inherited From AbstractDocument]

Deletes the region of text from offset to offset + length, and replaces it with text.

Deletes the region of text from offset to
offset + length, and replaces it with text.
It is up to the implementation as to how this is implemented, some
implementations may treat this as two distinct operations: a remove
followed by an insert, others may treat the replace as one atomic
operation.
Parameters:
- offset - index of child element
- length - length of text to delete, may be 0 indicating don't delete anything
- text - text to insert, null indicates no text to insert
- attrs - AttributeSet indicating attributes of inserted text, null is legal, and typically treated as an empty attributeset, but exact interpretation is left to the subclass
Throws:
- BadLocationException - the given position is not a valid position within the document
Since: 1.4

public void setAsynchronousLoadPriority (int p) [Inherited From AbstractDocument]

Sets the asynchronous loading priority.

public void setBase (URL u)

Sets the location to resolve relative URLs against.

public void setCharacterAttributes (int offset, int length, AttributeSet s, boolean replace) [Inherited From DefaultStyledDocument]

Sets attributes for some part of the document.

pack-private void setDefaultStyleSheetType (String contentType)

Sets the content type language used for style sheets that do not explicitly specify the type.

public void setDocumentFilter (DocumentFilter filter) [Inherited From AbstractDocument]

Sets the DocumentFilter.

Sets the DocumentFilter. The DocumentFilter
is passed insert and remove to conditionally
allow inserting/deleting of the text. A null value
indicates that no filtering will occur.
Parameters:
- filter - the DocumentFilter used to constrain text
Since: 1.4
See Also: AbstractDocument.getDocumentFilter(),

public void setDocumentProperties (Dictionary<Object, Object> x) [Inherited From AbstractDocument]

Replaces the document properties dictionary for this document.

pack-private void setFrameDocumentState (boolean frameDoc)

Sets a boolean state about whether the document will be viewed in a frame.

public void setInnerHTML (Element elem, String htmlText) throws BadLocationException IOException

Replaces the children of the given element with the contents specified as an HTML string.

public void setLogicalStyle (int pos, Style s) [Inherited From DefaultStyledDocument]

Sets the logical style to use for the paragraph at the given position.

public void setOuterHTML (Element elem, String htmlText) throws BadLocationException IOException

Replaces the given element in the parent with the contents specified as an HTML string.

public void setParagraphAttributes (int offset, int length, AttributeSet s, boolean replace) [Overrides DefaultStyledDocument]

Sets attributes for a paragraph.

public void setParser (Parser parser)

Sets the parser that is used by the methods that insert html into the existing document, such as setInnerHTML, and setOuterHTML.

HTMLEditorKit.createDefaultDocument will set the parser for you. If you create an HTMLDocument by hand, be sure and set the parser accordingly.
Parameters:
- parser - the parser to be used for text insertion
Since: 1.3

public void setPreservesUnknownTags (boolean preservesTags)

Determines how unknown tags are handled by the parser.

public void setTokenThreshold (int n)

Sets the number of tokens to buffer before trying to update the documents element structure.

protected void styleChanged (Style style) [Inherited From DefaultStyledDocument]

Called when any of this document's styles have changed.

protectedfinalsynchronized void writeLock () [Inherited From AbstractDocument]

Acquires a lock to begin mutating the document this lock protects.

Acquires a lock to begin mutating the document this lock protects. There can be no writing, notification of changes, or reading going on in order to gain the lock. Additionally a thread is allowed to gain more than one writeLock, as long as it doesn't attempt to gain additional writeLocks from within document notification. Attempting to gain a writeLock from within a DocumentListener notification will result in an IllegalStateException. The ability to obtain more than one writeLock per thread allows subclasses to gain a writeLock, perform a number of operations, then release the lock.

Calls to writeLock must be balanced with calls to writeUnlock, else the Document will be left in a locked state so that no reading or writing can be done.
Throws:
- IllegalStateException - thrown on illegal lock attempt. If the document is implemented properly, this can only happen if a document listener attempts to mutate the document. This situation violates the bean event model where order of delivery is not guaranteed and all listeners should be notified before further mutations are allowed.

protectedfinalsynchronized void writeUnlock () [Inherited From AbstractDocument]

Releases a write lock previously obtained via writeLock.

Releases a write lock previously obtained via writeLock.
After decrementing the lock count if there are no oustanding locks
this will allow a new writer, or readers.
See Also: AbstractDocument.writeLock(),