AbstractWriter JDK 1.6)

Hide/Show inherited methods

protected void decrIndent ()

Decrements the indent level.

protected boolean getCanWrapLines ()

Returns whether or not the lines can be wrapped.

protected int getCurrentLineLength ()

Returns the current line length.

protected Document getDocument ()

Fetches the document.

protected ElementIterator getElementIterator ()

Fetches the ElementIterator.

public int getEndOffset ()

Returns the last offset to be output.

protected int getIndentLevel ()

Returns the current indentation level.

Returns the current indentation level. That is, the number of times
incrIndent has been invoked minus the number of times
decrIndent has been invoked.
Since: 1.3

protected int getIndentSpace ()

Returns the amount of space to indent.

protected int getLineLength ()

Returns the maximum line length.

public String getLineSeparator ()

Returns the string used to represent newlines.

public int getStartOffset ()

Returns the first offset to be output.

protected String getText (Element elem) throws BadLocationException

Returns the text associated with the element.

Returns the text associated with the element.
The assumption here is that the element is a
leaf element. Throws a BadLocationException
when encountered.
Returns: the text as a String
Parameters:
- elem - an Element
Throws:
- BadLocationException - if pos represents an invalid location within the document

protected Writer getWriter ()

Returns the Writer that is used to output the content.

protected void incrIndent ()

Increments the indent level.

Increments the indent level. If indenting would cause
getIndentSpace() *getIndentLevel() to be >
than getLineLength() this will not cause an indent.

protected void indent () throws IOException

Does indentation.

protected boolean inRange (Element next)

This method determines whether the current element is in the range specified.

protected boolean isLineEmpty ()

Returns true if the current line should be considered empty.

Returns true if the current line should be considered empty. This
is true when getCurrentLineLength == 0 ||
indent has been invoked on an empty line.
Since: 1.3

protected void output (char[] content, int start, int length) throws IOException

The last stop in writing out content.

The last stop in writing out content. All the write methods eventually make it to this method, which invokes write on 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. Use writeLineSeparator to write out a newline, which will property update the current line length.
Since: 1.3

protected void setCanWrapLines (boolean newValue)

Sets whether or not lines can be wrapped.

protected void setCurrentLineLength (int length)

Sets the current line length.

protected void setIndentSpace (int space)

Enables subclasses to specify how many spaces an indent maps to.

protected void setLineLength (int l)

Enables subclasses to set the number of characters they want written per line.

public void setLineSeparator (String value)

Sets the String used to reprsent newlines.

protected void text (Element elem) throws BadLocationException IOException

Writes out text.

protectedabstract void write () throws IOException BadLocationException

This abstract method needs to be implemented by subclasses.

protected void write (char ch) throws IOException

Writes out a character.

Writes out a character. This is implemented to invoke
the write method that takes a char[].
Parameters:
- ch - a char.
Throws:
- IOException - on any I/O error

protected void write (char[] chars, int startIndex, int length) throws IOException

All write methods call into this one.

All write methods call into this one. If getCanWrapLines()
returns false, this will call output with each sequence
of chars that doesn't contain a NEWLINE, followed
by a call to writeLineSeparator. On the other hand,
if getCanWrapLines() returns true, this will split the
string, as necessary, so getLineLength is honored.
The only exception is if the current string contains no whitespace,
and won't fit in which case the line length will exceed
getLineLength.
Since: 1.3

protected void write (String content) throws IOException

Writes out a string.

Writes out a string. This is implemented to invoke the
write method that takes a char[].
Parameters:
- content - a String.
Throws:
- IOException - on any I/O error

protected void writeAttributes (AttributeSet attr) throws IOException

Writes out the set of attributes as " =" pairs.

protected void writeLineSeparator () throws IOException

Writes the line separator.

Writes the line separator. This invokes output directly
as well as setting the lineLength to 0.
Since: 1.3