uk.ac.ed.ph.snuggletex.utilities

Class LaTeXIndenter

java.lang.Object

uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

public final class LaTeXIndenter
extends Object

Simple utility class that does very basic indenting of LaTeX. NOTE: This has not been properly tested yet so is to be assumed experimental for the time being...!

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT_WIDTH Default indent width
static int	DEFAULT_MAX_INDENT_LEVEL Default maximum indent level

Constructor Summary

Constructors

Constructor and Description
LaTeXIndenter(Writer outputWriter) Creates a new indenter that will output to outputWriter.

Method Summary

Modifier and Type	Method and Description
int	getIndentWidth()
int	getMaxIndentLevel()
boolean	isCompactingBlankLines()
void	reset()
void	run(Reader inputReader) Indents the TeX read from the given inputReader, sending the results to outputWriter.
void	setCompactingBlankLines(boolean condenseBlankLines)
void	setIndentWidth(int indentWidth)
void	setMaxIndentLevel(int maxIndentLevel)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT_WIDTH

public static final int DEFAULT_INDENT_WIDTH

Default indent width

See Also:

Constant Field Values

DEFAULT_MAX_INDENT_LEVEL

public static final int DEFAULT_MAX_INDENT_LEVEL

Default maximum indent level

See Also:

Constant Field Values

Constructor Detail

LaTeXIndenter

public LaTeXIndenter(Writer outputWriter)

Creates a new indenter that will output to outputWriter. This will have default properties set and will compact blank lines by default.

Parameters:

outputWriter -

Method Detail

getIndentWidth

public int getIndentWidth()

setIndentWidth

public void setIndentWidth(int indentWidth)

getMaxIndentLevel

public int getMaxIndentLevel()

setMaxIndentLevel

public void setMaxIndentLevel(int maxIndentLevel)

isCompactingBlankLines

public boolean isCompactingBlankLines()

setCompactingBlankLines

public void setCompactingBlankLines(boolean condenseBlankLines)

reset

public void reset()

run

public void run(Reader inputReader)
         throws IOException

Indents the TeX read from the given inputReader, sending the results to outputWriter. The inputReader will be closed afterwards; the outputWriter is left open so the caller should arrange to flush or close it as required.

Throws:

IOException