java.lang.Object
javax.swing.text.AbstractWriter
- Direct Known Subclasses:
HTMLWriter,MinimalHTMLWriter
AbstractWriter is an abstract class that actually
does the work of writing out the element tree
including the attributes. In terms of how much is
written out per line, the writer defaults to 100.
But this value can be set by subclasses.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final charHow the text packages models newlines. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractWriter(Writer w, Document doc) Creates a new AbstractWriter.protectedAbstractWriter(Writer w, Document doc, int pos, int len) Creates a new AbstractWriter.protectedAbstractWriter(Writer w, Element root) Creates a new AbstractWriter.protectedAbstractWriter(Writer w, Element root, int pos, int len) Creates a new AbstractWriter. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidDecrements the indent level.protected booleanReturns whether or not the lines can be wrapped.protected intReturns the current line length.protected DocumentFetches the document.protected ElementIteratorFetches the ElementIterator.intReturns the last offset to be output.protected intReturns the current indentation level.protected intReturns the amount of space to indent.protected intReturns the maximum line length.Returns the string used to represent newlines.intReturns the first offset to be output.protected StringReturns the text associated with the element.protected WriterReturns the Writer that is used to output the content.protected voidIncrements the indent level.protected voidindent()Does indentation.protected booleanThis method determines whether the current element is in the range specified.protected booleanReturns true if the current line should be considered empty.protected voidoutput(char[] content, int start, int length) The last stop in writing out content.protected voidsetCanWrapLines(boolean newValue) Sets whether or not lines can be wrapped.protected voidsetCurrentLineLength(int length) Sets the current line length.protected voidsetIndentSpace(int space) Enables subclasses to specify how many spaces an indent maps to.protected voidsetLineLength(int l) Enables subclasses to set the number of characters they want written per line.voidsetLineSeparator(String value) Sets the String used to represent newlines.protected voidWrites out text.protected abstract voidwrite()This abstract method needs to be implemented by subclasses.protected voidwrite(char ch) Writes out a character.protected voidwrite(char[] chars, int startIndex, int length) All write methods call into this one.protected voidWrites out a string.protected voidwriteAttributes(AttributeSet attr) Writes out the set of attributes as " <name>=<value>" pairs.protected voidWrites the line separator.
-
Field Details
-
NEWLINE
protected static final char NEWLINEHow the text packages models newlines.- See Also:
-
-
Constructor Details
-
AbstractWriter
Creates a new AbstractWriter. Initializes the ElementIterator with the default root of the document.- Parameters:
w- a Writer.doc- a Document
-
AbstractWriter
Creates a new AbstractWriter. Initializes the ElementIterator with the element passed in.- Parameters:
w- a Writerdoc- an Elementpos- The location in the document to fetch the content.len- The amount to write out.
-
AbstractWriter
Creates a new AbstractWriter. Initializes the ElementIterator with the element passed in.- Parameters:
w- a Writerroot- an Element
-
AbstractWriter
Creates a new AbstractWriter. Initializes the ElementIterator with the element passed in.- Parameters:
w- a Writerroot- an Elementpos- The location in the document to fetch the content.len- The amount to write out.
-
-
Method Details
-
getStartOffset
public int getStartOffset()Returns the first offset to be output.- Returns:
- the first offset to be output
- Since:
- 1.3
-
getEndOffset
public int getEndOffset()Returns the last offset to be output.- Returns:
- the last offset to be output
- Since:
- 1.3
-
getElementIterator
Fetches the ElementIterator.- Returns:
- the ElementIterator.
-
getWriter
Returns the Writer that is used to output the content.- Returns:
- the Writer that is used to output the content
- Since:
- 1.3
-
getDocument
Fetches the document.- Returns:
- the Document.
-
inRange
This method determines whether the current element is in the range specified. When no range is specified, the range is initialized to be the entire document. inRange() returns true if the range specified intersects with the element's range.- Parameters:
next- an Element.- Returns:
- boolean that indicates whether the element is in the range.
-
write
This abstract method needs to be implemented by subclasses. Its responsibility is to iterate over the elements and use the write() methods to generate output in the desired format.- Throws:
IOException- if an I/O problem has occurredBadLocationException- for an invalid location within the document
-
getText
Returns the text associated with the element. The assumption here is that the element is a leaf element. Throws a BadLocationException when encountered.- Parameters:
elem- anElement- Returns:
- the text as a
String - Throws:
BadLocationException- if pos represents an invalid location within the document
-
text
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 errorBadLocationException- if pos represents an invalid location within the document.
-
setLineLength
protected void setLineLength(int l) Enables subclasses to set the number of characters they want written per line. The default is 100.- Parameters:
l- the maximum line length.
-
getLineLength
protected int getLineLength()Returns the maximum line length.- Returns:
- the maximum line length
- Since:
- 1.3
-
setCurrentLineLength
protected void setCurrentLineLength(int length) Sets the current line length.- Parameters:
length- the new line length- Since:
- 1.3
-
getCurrentLineLength
protected int getCurrentLineLength()Returns the current line length.- Returns:
- the current line length
- Since:
- 1.3
-
isLineEmpty
protected boolean isLineEmpty()Returns true if the current line should be considered empty. This is true whengetCurrentLineLength== 0 ||indenthas been invoked on an empty line.- Returns:
- true if the current line should be considered empty
- Since:
- 1.3
-
setCanWrapLines
protected void setCanWrapLines(boolean newValue) Sets whether or not lines can be wrapped. This can be toggled during the writing of lines. For example, outputting HTML might set this to false when outputting a quoted string.- Parameters:
newValue- new value for line wrapping- Since:
- 1.3
-
getCanWrapLines
protected boolean getCanWrapLines()Returns whether or not the lines can be wrapped. If this is false no lineSeparator's will be output.- Returns:
- whether or not the lines can be wrapped
- Since:
- 1.3
-
setIndentSpace
protected void setIndentSpace(int space) Enables subclasses to specify how many spaces an indent maps to. When indentation takes place, the indent level is multiplied by this mapping. The default is 2.- Parameters:
space- an int representing the space to indent mapping.
-
getIndentSpace
protected int getIndentSpace()Returns the amount of space to indent.- Returns:
- the amount of space to indent
- Since:
- 1.3
-
setLineSeparator
Sets the String used to represent newlines. This is initialized in the constructor from either the Document, or the System property line.separator.- Parameters:
value- the new line separator- Since:
- 1.3
-
getLineSeparator
Returns the string used to represent newlines.- Returns:
- the string used to represent newlines
- Since:
- 1.3
-
incrIndent
protected void incrIndent()Increments the indent level. If indenting would causegetIndentSpace()*getIndentLevel()to be > thangetLineLength()this will not cause an indent. -
decrIndent
protected void decrIndent()Decrements the indent level. -
getIndentLevel
protected int getIndentLevel()Returns the current indentation level. That is, the number of timesincrIndenthas been invoked minus the number of timesdecrIndenthas been invoked.- Returns:
- the current indentation level
- Since:
- 1.3
-
indent
Does indentation. The number of spaces written out is indent level times the space to map mapping. If the current line is empty, this will not make it so that the current line is still considered empty.- Throws:
IOException- on any I/O error
-
write
Writes out a character. This is implemented to invoke thewritemethod that takes a char[].- Parameters:
ch- a char.- Throws:
IOException- on any I/O error
-
write
Writes out a string. This is implemented to invoke thewritemethod that takes a char[].- Parameters:
content- a String.- Throws:
IOException- on any I/O error
-
writeLineSeparator
Writes the line separator. This invokesoutputdirectly as well as setting thelineLengthto 0.- Throws:
IOException- on any I/O error- Since:
- 1.3
-
write
All write methods call into this one. IfgetCanWrapLines()returns false, this will calloutputwith each sequence ofcharsthat doesn't contain a NEWLINE, followed by a call towriteLineSeparator. On the other hand, ifgetCanWrapLines()returns true, this will split the string, as necessary, sogetLineLengthis honored. The only exception is if the current string contains no whitespace, and won't fit in which case the line length will exceedgetLineLength.- Parameters:
chars- characters to outputstartIndex- starting indexlength- length of output- Throws:
IOException- on any I/O error- Since:
- 1.3
-
writeAttributes
Writes out the set of attributes as " <name>=<value>" pairs. It throws an IOException when encountered.- Parameters:
attr- an AttributeSet.- Throws:
IOException- on any I/O error
-
output
The last stop in writing out content. All the write methods eventually make it to this method, which invokeswriteon the Writer.This method also updates the line length based on
length. If this is invoked to output a newline, the current line length will need to be reset as will no longer be valid. If it is up to the caller to do this. UsewriteLineSeparatorto write out a newline, which will property update the current line length.- Parameters:
content- characters to outputstart- starting indexlength- length of output- Throws:
IOException- on any I/O error- Since:
- 1.3
-