public class

HTMLWriter

extends AbstractWriter

java.lang.Object
↳	javax.swing.text.AbstractWriter
	↳	javax.swing.text.html.HTMLWriter

Class Overview

This is a writer for HTMLDocuments.

Summary

[Expand]

Inherited Constants

From class javax.swing.text.AbstractWriter

Public Constructors
	HTMLWriter(Writer w, HTMLDocument doc) Creates a new HTMLWriter.
	HTMLWriter(Writer w, HTMLDocument doc, int pos, int len) Creates a new HTMLWriter.

Public Methods
void	write() Iterates over the Element tree and controls the writing out of all the tags and its attributes.

Protected Methods
void	closeOutUnwantedEmbeddedTags(AttributeSet attr) Searches the attribute set and for each tag that is stored in the tag vector.
void	comment(Element elem) Writes out comments.
void	emptyTag(Element elem) Writes out all empty elements (all tags that have no corresponding end tag).
void	endTag(Element elem) Writes out an end tag for the element.
boolean	isBlockTag(AttributeSet attr) Determines if the HTML.Tag associated with the element is a block tag.
boolean	matchNameAttribute(AttributeSet attr, HTML.Tag tag) Returns true if the StyleConstants.NameAttribute is equal to the tag that is passed in as a parameter.
void	output(char[] chars, int start, int length) This method is overriden to map any character entities, such as < to <.
void	selectContent(AttributeSet attr) Writes out the content of the SELECT form element.
void	startTag(Element elem) Writes out a start tag for the element.
boolean	synthesizedElement(Element elem) Returns true if the element is a synthesized element.
void	text(Element elem) Writes out text.
void	textAreaContent(AttributeSet attr) Writes out text that is contained in a TEXTAREA form element.
void	writeAttributes(AttributeSet attr) Writes out the attribute set.
void	writeEmbeddedTags(AttributeSet attr) Searches for embedded tags in the AttributeSet and writes them out.
void	writeLineSeparator() Writes the line separator.
void	writeOption(Option option) Writes out the content of the Option form element.

[Expand]

Inherited Methods

From class javax.swing.text.AbstractWriter

void	decrIndent() Decrements the indent level.
boolean	getCanWrapLines() Returns whether or not the lines can be wrapped.
int	getCurrentLineLength() Returns the current line length.
Document	getDocument() Fetches the document.
ElementIterator	getElementIterator() Fetches the ElementIterator.
int	getEndOffset() Returns the last offset to be output.
int	getIndentLevel() Returns the current indentation level.
int	getIndentSpace() Returns the amount of space to indent.
int	getLineLength() Returns the maximum line length.
String	getLineSeparator() Returns the string used to represent newlines.
int	getStartOffset() Returns the first offset to be output.
String	getText(Element elem) Returns the text associated with the element.
Writer	getWriter() Returns the Writer that is used to output the content.
boolean	inRange(Element next) This method determines whether the current element is in the range specified.
void	incrIndent() Increments the indent level.
void	indent() Does indentation.
boolean	isLineEmpty() Returns true if the current line should be considered empty.
void	output(char[] content, int start, int length) The last stop in writing out content.
void	setCanWrapLines(boolean newValue) Sets whether or not lines can be wrapped.
void	setCurrentLineLength(int length) Sets the current line length.
void	setIndentSpace(int space) Enables subclasses to specify how many spaces an indent maps to.
void	setLineLength(int l) Enables subclasses to set the number of characters they want written per line.
void	setLineSeparator(String value) Sets the String used to reprsent newlines.
void	text(Element elem) Writes out text.
void	write(char[] chars, int startIndex, int length) All write methods call into this one.
abstract void	write() This abstract method needs to be implemented by subclasses.
void	write(char ch) Writes out a character.
void	write(String content) Writes out a string.
void	writeAttributes(AttributeSet attr) Writes out the set of attributes as " =" pairs.
void	writeLineSeparator() Writes the line separator.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public HTMLWriter (Writer w, HTMLDocument doc)

Creates a new HTMLWriter.

Parameters

w	a Writer
doc	an HTMLDocument

public HTMLWriter (Writer w, HTMLDocument doc, int pos, int len)

Creates a new HTMLWriter.

Parameters

w	a Writer
doc	an HTMLDocument
pos	the document location from which to fetch the content
len	the amount to write out

Public Methods

public void write ()

Iterates over the Element tree and controls the writing out of all the tags and its attributes.

Throws

IOException	on any I/O error
BadLocationException	if pos represents an invalid location within the document.

Protected Methods

protected void closeOutUnwantedEmbeddedTags (AttributeSet attr)

Searches the attribute set and for each tag that is stored in the tag vector. If the tag isnt found, then the tag is removed from the vector and a corresponding end tag is written out.

Throws

IOException	on any I/O error

protected void comment (Element elem)

Writes out comments.

Parameters

elem	an Element

Throws

IOException	on any I/O error
BadLocationException	if pos represents an invalid location within the document.

protected void emptyTag (Element elem)

Writes out all empty elements (all tags that have no corresponding end tag).

Parameters

elem	an Element

Throws

IOException	on any I/O error
BadLocationException	if pos represents an invalid location within the document.

protected void endTag (Element elem)

Writes out an end tag for the element.

Parameters

elem	an Element

Throws

IOException	on any I/O error

protected boolean isBlockTag (AttributeSet attr)

Determines if the HTML.Tag associated with the element is a block tag.

Parameters

attr	an AttributeSet

Returns

true if tag is block tag, false otherwise.

protected boolean matchNameAttribute (AttributeSet attr, HTML.Tag tag)

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

protected void output (char[] chars, int start, int length)

This method is overriden to map any character entities, such as < to <. super.output will be invoked to write the content.

Throws

IOException

protected void selectContent (AttributeSet attr)

Writes out the content of the SELECT form element.

Parameters

attr	the AttributeSet associated with the form element

Throws

IOException	on any I/O error

protected void startTag (Element elem)

Writes out a start tag for the element. Ignores all synthesized elements.

Parameters

elem	an Element

Throws

IOException	on any I/O error
BadLocationException

protected boolean synthesizedElement (Element elem)

Returns true if the element is a synthesized element. Currently we are only testing for the p-implied tag.

protected void text (Element elem)

Writes out text. If a range is specified when the constructor is invoked, then only the appropriate range of text is written out.

Parameters

elem	an Element

Throws

IOException	on any I/O error
BadLocationException	if pos represents an invalid location within the document.

protected void textAreaContent (AttributeSet attr)

Writes out text that is contained in a TEXTAREA form element.

Parameters

attr	an AttributeSet

Throws

IOException	on any I/O error
BadLocationException	if pos represents an invalid location within the document.

protected void writeAttributes (AttributeSet attr)

Writes out the attribute set. Ignores all attributes with a key of type HTML.Tag, attributes with a key of type StyleConstants, and attributes with a key of type HTML.Attribute.ENDTAG.

Parameters

attr	an AttributeSet

Throws

IOException	on any I/O error

protected void writeEmbeddedTags (AttributeSet attr)

Searches for embedded tags in the AttributeSet and writes them out. It also stores these tags in a vector so that when appropriate the corresponding end tags can be written out.

Throws

IOException	on any I/O error

protected void writeLineSeparator ()

Writes the line separator. This is overriden to make sure we don't replace the newline content in case it is outside normal ascii.

Throws

IOException

protected void writeOption (Option option)

Writes out the content of the Option form element.

Parameters

option	an Option

Throws

IOException	on any I/O error

Classes

Enums

HTMLWriter

Class Overview

Summary

Public Constructors

public HTMLWriter (Writer w, HTMLDocument doc)

Parameters

public HTMLWriter (Writer w, HTMLDocument doc, int pos, int len)

Parameters

Public Methods

public void write ()

Throws

Protected Methods

protected void closeOutUnwantedEmbeddedTags (AttributeSet attr)

Throws

protected void comment (Element elem)

Parameters

Throws

protected void emptyTag (Element elem)

Parameters

Throws

protected void endTag (Element elem)

Parameters

Throws

protected boolean isBlockTag (AttributeSet attr)

Parameters

Returns

protected boolean matchNameAttribute (AttributeSet attr, HTML.Tag tag)

protected void output (char[] chars, int start, int length)

Throws

protected void selectContent (AttributeSet attr)

Parameters

Throws

protected void startTag (Element elem)

Parameters

Throws

protected boolean synthesizedElement (Element elem)

protected void text (Element elem)

Parameters

Throws

protected void textAreaContent (AttributeSet attr)

Parameters

Throws

protected void writeAttributes (AttributeSet attr)

Parameters

Throws

protected void writeEmbeddedTags (AttributeSet attr)

Throws

protected void writeLineSeparator ()

Throws

protected void writeOption (Option option)

Parameters

Throws