javax.swing.text.html

Class HTMLWriter

java.lang.Object

javax.swing.text.AbstractWriter

javax.swing.text.html.HTMLWriter

public class HTMLWriter
extends javax.swing.text.AbstractWriter

HTMLWriter, A Writer for HTMLDocuments.

Field Summary

Fields inherited from class javax.swing.text.AbstractWriter

NEWLINE

Constructor Summary

Constructors

Constructor and Description
HTMLWriter(java.io.Writer writer, HTMLDocument doc) Constructs a HTMLWriter.
HTMLWriter(java.io.Writer writer, HTMLDocument doc, int pos, int len) Constructs a HTMLWriter which outputs a Html Fragment.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeOutUnwantedEmbeddedTags(javax.swing.text.AttributeSet attrSet) Closes out an unwanted embedded tag.
protected void	comment(javax.swing.text.Element paramElem) Writes out the comment.
protected void	emptyTag(javax.swing.text.Element paramElem) Writes out an empty tag. i.e. a tag without any child elements.
protected void	endTag(javax.swing.text.Element paramElem) Writes out an end tag.
protected boolean	isBlockTag(javax.swing.text.AttributeSet attrSet) Determines if it is a block tag or not.
protected boolean	matchNameAttribute(javax.swing.text.AttributeSet attrSet, HTML.Tag tag) Determines if javax.swing.text.StyleConstants.NameAttribute matches tag or not.
protected void	output(char[] chars, int off, int len) Write to the writer.
protected void	selectContent(javax.swing.text.AttributeSet attrSet) Writes out the contents of a select element.
protected void	startTag(javax.swing.text.Element paramElem) Writes out a start tag.
protected boolean	synthesizedElement(javax.swing.text.Element element) Determines if element is a synthesized javax.swing.text.Element or not.
protected void	text(javax.swing.text.Element paramElem) Writes out text, within the appropriate range if it is specified.
protected void	textAreaContent(javax.swing.text.AttributeSet attrSet) Writes out the contents of a textarea.
void	write() Call this method to start outputing HTML.
protected void	writeAttributes(javax.swing.text.AttributeSet attrSet) Writes all the attributes in the attrSet, except for attrbutes with keys of javax.swing.text.html.HTML.Tag, javax.swing.text.StyleConstants or javax.swing.text.html.HTML.Attribute.ENDTAG.
protected void	writeEmbeddedTags(javax.swing.text.AttributeSet attrSet) Writes out an embedded tag.
protected void	writeLineSeparator() Writes out a line separator.
protected void	writeOption(Option option) Writes out the contents of an option element.

Methods inherited from class javax.swing.text.AbstractWriter

decrIndent, getCanWrapLines, getCurrentLineLength, getDocument, getElementIterator, getEndOffset, getIndentLevel, getIndentSpace, getLineLength, getLineSeparator, getStartOffset, getText, getWriter, incrIndent, indent, inRange, isLineEmpty, setCanWrapLines, setCurrentLineLength, setIndentSpace, setLineLength, setLineSeparator, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLWriter

public HTMLWriter(java.io.Writer writer,
          HTMLDocument doc)

Constructs a HTMLWriter.

Parameters:

writer - writer to write output to

doc - the HTMLDocument to output

HTMLWriter

public HTMLWriter(java.io.Writer writer,
          HTMLDocument doc,
          int pos,
          int len)

Constructs a HTMLWriter which outputs a Html Fragment.

Parameters:

writer - Writer to write output to

doc - the javax.swing.text.html.HTMLDocument to output

pos - position to start outputing the document

len - amount to output the document

Method Detail

write

public void write()
           throws java.io.IOException,
                  javax.swing.text.BadLocationException

Call this method to start outputing HTML.

Specified by:

write in class javax.swing.text.AbstractWriter

Throws:

java.io.IOException - on any I/O exceptions

javax.swing.text.BadLocationException - if a pos is not a valid position in the html doc element

writeAttributes

protected void writeAttributes(javax.swing.text.AttributeSet attrSet)
                        throws java.io.IOException

Writes all the attributes in the attrSet, except for attrbutes with keys of javax.swing.text.html.HTML.Tag, javax.swing.text.StyleConstants or javax.swing.text.html.HTML.Attribute.ENDTAG.

Overrides:

writeAttributes in class javax.swing.text.AbstractWriter

Parameters:

attrSet - attrSet to write out

Throws:

java.io.IOException - on any I/O exceptions

emptyTag

protected void emptyTag(javax.swing.text.Element paramElem)
                 throws java.io.IOException,
                        javax.swing.text.BadLocationException

Writes out an empty tag. i.e. a tag without any child elements.

Parameters:

paramElem - the element to output as an empty tag

Throws:

java.io.IOException - on any I/O exceptions

javax.swing.text.BadLocationException - if a pos is not a valid position in the html doc element

isBlockTag

protected boolean isBlockTag(javax.swing.text.AttributeSet attrSet)

Determines if it is a block tag or not.

Parameters:

attrSet - the attrSet of the element

Returns:

true if it is a block tag false if it is a not block tag

startTag

protected void startTag(javax.swing.text.Element paramElem)
                 throws java.io.IOException,
                        javax.swing.text.BadLocationException

Writes out a start tag. Synthesized elements are skipped.

Parameters:

paramElem - the element to output as a start tag

Throws:

java.io.IOException - on any I/O exceptions

javax.swing.text.BadLocationException - if a pos is not a valid position in the html doc element

textAreaContent

protected void textAreaContent(javax.swing.text.AttributeSet attrSet)
                        throws java.io.IOException,
                               javax.swing.text.BadLocationException

Writes out the contents of a textarea.

Parameters:

attrSet - the attrSet of the element to output as a text area

Throws:

java.io.IOException - on any I/O exceptions

javax.swing.text.BadLocationException - if a pos is not a valid position in the html doc element

text

protected void text(javax.swing.text.Element paramElem)
             throws java.io.IOException,
                    javax.swing.text.BadLocationException

Writes out text, within the appropriate range if it is specified.

Overrides:

text in class javax.swing.text.AbstractWriter

Parameters:

paramElem - the element to output as a text

Throws:

java.io.IOException - on any I/O exceptions

javax.swing.text.BadLocationException - if a pos is not a valid position in the html doc element

selectContent

protected void selectContent(javax.swing.text.AttributeSet attrSet)
                      throws java.io.IOException

Writes out the contents of a select element.

Parameters:

attrSet - the attrSet of the element to output as a select box

Throws:

java.io.IOException - on any I/O exceptions

writeOption

protected void writeOption(Option option)
                    throws java.io.IOException

Writes out the contents of an option element.

Parameters:

option - the option object to output as a select option

Throws:

java.io.IOException - on any I/O exceptions

endTag

protected void endTag(javax.swing.text.Element paramElem)
               throws java.io.IOException

Writes out an end tag.

Parameters:

paramElem - the element to output as an end tag

Throws:

java.io.IOException - on any I/O exceptions

comment

protected void comment(javax.swing.text.Element paramElem)
                throws java.io.IOException,
                       javax.swing.text.BadLocationException

Writes out the comment.

Parameters:

paramElem - the element to output as a comment

Throws:

java.io.IOException

javax.swing.text.BadLocationException

synthesizedElement

protected boolean synthesizedElement(javax.swing.text.Element element)

Determines if element is a synthesized javax.swing.text.Element or not.

Parameters:

element - the element to test

Returns:

true if it is a synthesized element, false if it is a not synthesized element

matchNameAttribute

protected boolean matchNameAttribute(javax.swing.text.AttributeSet attrSet,
                         HTML.Tag tag)

Determines if javax.swing.text.StyleConstants.NameAttribute matches tag or not.

Parameters:

attrSet - the javax.swing.text.AttributeSet of element to be matched

tag - the HTML.Tag to match

Returns:

true if it matches, false if it does not match

writeEmbeddedTags

protected void writeEmbeddedTags(javax.swing.text.AttributeSet attrSet)
                          throws java.io.IOException

Writes out an embedded tag. The tags not already in openEmbededTagHashSet will written out.

Parameters:

attrSet - the javax.swing.text.AttributeSet of the element to write out

Throws:

java.io.IOException - on any I/O exceptions

closeOutUnwantedEmbeddedTags

protected void closeOutUnwantedEmbeddedTags(javax.swing.text.AttributeSet attrSet)
                                     throws java.io.IOException

Closes out an unwanted embedded tag. The tags from the openEmbededTagHashSet not found in attrSet will be written out.

Parameters:

attrSet - the AttributeSet of the element to write out

Throws:

java.io.IOException - on any I/O exceptions

writeLineSeparator

protected void writeLineSeparator()
                           throws java.io.IOException

Writes out a line separator. Overwrites the parent to write out a new line.

Overrides:

writeLineSeparator in class javax.swing.text.AbstractWriter

Throws:

java.io.IOException - on any I/O exceptions.

output

protected void output(char[] chars,
          int off,
          int len)
               throws java.io.IOException

Write to the writer. Character entites such as <, > are escaped appropriately.

Overrides:

output in class javax.swing.text.AbstractWriter

Parameters:

chars - char array to write out

off - offset

len - length

Throws:

java.io.IOException - on any I/O exceptions