com.lightdev.app.shtm
Class SHTMLDocument

java.lang.Object
  extended by javax.swing.text.AbstractDocument
      extended by javax.swing.text.DefaultStyledDocument
          extended by javax.swing.text.html.HTMLDocument
              extended by com.lightdev.app.shtm.SHTMLDocument
All Implemented Interfaces:
java.io.Serializable, javax.swing.text.Document, javax.swing.text.StyledDocument

public class SHTMLDocument
extends javax.swing.text.html.HTMLDocument

Extends HTMLDocument by a custom reader which supports the SPAN tag.

See Also:
Serialized Form

Nested Class Summary
 class SHTMLDocument.SHTMLReader
          This reader extends HTMLDocument.HTMLReader by the capability to handle SPAN tags
 
Nested classes/interfaces inherited from class javax.swing.text.html.HTMLDocument
javax.swing.text.html.HTMLDocument.BlockElement, javax.swing.text.html.HTMLDocument.HTMLReader, javax.swing.text.html.HTMLDocument.Iterator, javax.swing.text.html.HTMLDocument.RunElement
 
Nested classes/interfaces inherited from class javax.swing.text.DefaultStyledDocument
javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit, javax.swing.text.DefaultStyledDocument.ElementBuffer, javax.swing.text.DefaultStyledDocument.ElementSpec, javax.swing.text.DefaultStyledDocument.SectionElement
 
Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument
javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.AbstractDocument.LeafElement
 
Field Summary
 
Fields inherited from class javax.swing.text.html.HTMLDocument
AdditionalComments
 
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
SHTMLDocument()
          Constructs an SHTMLDocument.
SHTMLDocument(javax.swing.text.AbstractDocument.Content c, javax.swing.text.html.StyleSheet styles)
          Constructs an SHTMLDocument with the given content storage implementation and the given style/attribute storage mechanism.
SHTMLDocument(javax.swing.text.html.StyleSheet styles)
          Constructs an SHTMLDocument with the default content storage implementation and the given style/attribute storage mechanism.
 
Method Summary
 void addAttributes(javax.swing.text.Element e, javax.swing.text.AttributeSet a)
          apply a set of attributes to a given document element
 java.lang.String getDocumentTitle()
          get the title of this SHTMLDocument
 javax.swing.text.html.HTMLEditorKit.ParserCallback getReader(int pos)
          Fetches the reader for the parser to use to load the document with HTML.
 java.lang.String getStyleRef()
          get the style sheet reference of the document in this DocumentPane.
 boolean hasStyleRef()
          check whether or not this SHTMLDocument has an explicit style sheet reference
 void insertStyleRef()
          insert a style sheet reference into the head of this SHTMLDocument
 void removeElements(javax.swing.text.Element e, int index, int count)
          Remove a consecutive group of child Elements
 void setDocumentTitle(java.lang.String title)
          set the title of this SHTMLDocument
 
Methods inherited from class javax.swing.text.html.HTMLDocument
create, createBranchElement, createDefaultRoot, createLeafElement, fireChangedUpdate, fireUndoableEditUpdate, getBase, getElement, getElement, getIterator, getParser, getPreservesUnknownTags, getReader, getStyleSheet, getTokenThreshold, insert, insertAfterEnd, insertAfterStart, insertBeforeEnd, insertBeforeStart, insertUpdate, processHTMLFrameHyperlinkEvent, setBase, setInnerHTML, setOuterHTML, setParagraphAttributes, setParser, setPreservesUnknownTags, setTokenThreshold
 
Methods inherited from class javax.swing.text.DefaultStyledDocument
addDocumentListener, addStyle, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, removeDocumentListener, removeElement, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, styleChanged
 
Methods inherited from class javax.swing.text.AbstractDocument
addUndoableEditListener, createPosition, dump, fireInsertUpdate, fireRemoveUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, 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
 
Methods inherited from interface javax.swing.text.Document
addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render
 

Constructor Detail

SHTMLDocument

public SHTMLDocument()
Constructs an SHTMLDocument.


SHTMLDocument

public SHTMLDocument(javax.swing.text.html.StyleSheet styles)
Constructs an SHTMLDocument with the default content storage implementation and the given style/attribute storage mechanism.

Parameters:
styles - the styles

SHTMLDocument

public SHTMLDocument(javax.swing.text.AbstractDocument.Content c,
                     javax.swing.text.html.StyleSheet styles)
Constructs an SHTMLDocument with the given content storage implementation and the given style/attribute storage mechanism.

Parameters:
c - the container for the content
styles - the styles
Method Detail

addAttributes

public void addAttributes(javax.swing.text.Element e,
                          javax.swing.text.AttributeSet a)
apply a set of attributes to a given document element

Parameters:
e - the element to apply attributes to
a - the set of attributes to apply

removeElements

public void removeElements(javax.swing.text.Element e,
                           int index,
                           int count)
                    throws javax.swing.text.BadLocationException
Remove a consecutive group of child Elements

Parameters:
e - the parent element to remove child elements from
index - the index of the first child element to remove
count - the number of child elements to remove
Throws:
javax.swing.text.BadLocationException

setDocumentTitle

public void setDocumentTitle(java.lang.String title)
set the title of this SHTMLDocument

Parameters:
title - the title this document shall have

getDocumentTitle

public java.lang.String getDocumentTitle()
get the title of this SHTMLDocument

Returns:
the title of this document or null if none was set so far

insertStyleRef

public void insertStyleRef()
insert a style sheet reference into the head of this SHTMLDocument


hasStyleRef

public boolean hasStyleRef()
check whether or not this SHTMLDocument has an explicit style sheet reference

Returns:
true, if a style sheet reference was found, false if not

getStyleRef

public java.lang.String getStyleRef()
get the style sheet reference of the document in this DocumentPane.

Returns:
the reference to this document's style sheet or null if none is found

getReader

public javax.swing.text.html.HTMLEditorKit.ParserCallback getReader(int pos)
Fetches the reader for the parser to use to load the document with HTML. This is implemented to return an instance of SHTMLDocument.SHTMLReader.

Overrides:
getReader in class javax.swing.text.html.HTMLDocument