net.sf.jaxme.js
Interface IndentationEngine

All Known Subinterfaces:

ConditionalIndentationEngine, LocalJavaField, TextFile

All Known Implementing Classes:

ConditionalIndentationJavaSourceObject, ConditionalIndentationJavaSourceObject.LJFImpl, IndentationEngineImpl, TextFileImpl

public interface IndentationEngine

Version:

$Id: IndentationEngine.java,v 1.3 2003/08/11 10:26:25 joe Exp $

Author:

Jochen Wiedmann

Field Summary

static java.lang.Object

NOTHING

Method Summary

void	addLine() Adds an empty line, shortcut for addLine(getIndentationLevel, new Object[0]).
void	addLine(int pLevel, java.lang.Object[] pTokens) Adds the given tokens as a complete line, using the given level of indentation.
void	addLine(java.lang.Object pLine) Shortcut for addLine(getIndentationLevel(), new Object[]{pLine}).
void	addLine(java.lang.Object[] pTokens) Shortcut for addLine(getIndentationLevel(), pTokens).
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2}).
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3}).
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4}).
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5}).
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10, java.lang.Object pToken11) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10, java.lang.Object pToken11, java.lang.Object pToken12) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10, java.lang.Object pToken11, java.lang.Object pToken12, java.lang.Object pToken13) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10, java.lang.Object pToken11, java.lang.Object pToken12, java.lang.Object pToken13, java.lang.Object pToken14) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken14}) .
void	addLine(java.lang.Object pToken1, java.lang.Object pToken2, java.lang.Object pToken3, java.lang.Object pToken4, java.lang.Object pToken5, java.lang.Object pToken6, java.lang.Object pToken7, java.lang.Object pToken8, java.lang.Object pToken9, java.lang.Object pToken10, java.lang.Object pToken11, java.lang.Object pToken12, java.lang.Object pToken13, java.lang.Object pToken14, java.lang.Object pToken15) Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken15}) .
void	clear() Clears the IndentationEngine's contents.
int	getLevel() Returns the current level of indentation.
PlaceHolder	getPlaceHolder(java.lang.String pName) Searches for the placeholder with the given name.
void	indent() Increases the current level of indentation.
void	moveToBottom() Moves the cursor to the bottom of the method.
void	moveToTop() Moves the cursor to the top of the method.
PlaceHolder	newPlaceHolder(java.lang.String pName, boolean pAutoRemove) Sets a placeholder with the given name.
void	setLevel(int pLevel) Sets the current level of indentation.
void	unindent() Decreases the current level of indentation.
void	write(IndentationTarget pTarget) Adds the IndentationEngine's contents to the given IndentationTarget.
void	write(IndentationTarget pTarget, java.lang.Object pObject) Adds the given objects contents to the given IndentationTarget.

Field Detail

NOTHING

public static final java.lang.Object NOTHING

Method Detail

indent

public void indent()

Increases the current level of indentation.

unindent

public void unindent()

Decreases the current level of indentation.

write

public void write(IndentationTarget pTarget)
           throws java.io.IOException

Adds the IndentationEngine's contents to the given IndentationTarget.

Throws:

java.io.IOException

write

public void write(IndentationTarget pTarget,
                  java.lang.Object pObject)
           throws java.io.IOException

Adds the given objects contents to the given IndentationTarget.

Throws:

java.io.IOException

clear

public void clear()

Clears the IndentationEngine's contents.

setLevel

public void setLevel(int pLevel)

Sets the current level of indentation.

getLevel

public int getLevel()

Returns the current level of indentation.

addLine

public void addLine(int pLevel,
                    java.lang.Object[] pTokens)

Adds the given tokens as a complete line, using the given level of indentation.

addLine

public void addLine(java.lang.Object[] pTokens)

Shortcut for addLine(getIndentationLevel(), pTokens).

addLine

public void addLine()

Adds an empty line, shortcut for addLine(getIndentationLevel, new Object[0]).

addLine

public void addLine(java.lang.Object pLine)

Shortcut for addLine(getIndentationLevel(), new Object[]{pLine}).

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2}).

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3}).

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4}).

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5}).

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10,
                    java.lang.Object pToken11)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10,
                    java.lang.Object pToken11,
                    java.lang.Object pToken12)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10,
                    java.lang.Object pToken11,
                    java.lang.Object pToken12,
                    java.lang.Object pToken13)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10,
                    java.lang.Object pToken11,
                    java.lang.Object pToken12,
                    java.lang.Object pToken13,
                    java.lang.Object pToken14)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken14}) .

addLine

public void addLine(java.lang.Object pToken1,
                    java.lang.Object pToken2,
                    java.lang.Object pToken3,
                    java.lang.Object pToken4,
                    java.lang.Object pToken5,
                    java.lang.Object pToken6,
                    java.lang.Object pToken7,
                    java.lang.Object pToken8,
                    java.lang.Object pToken9,
                    java.lang.Object pToken10,
                    java.lang.Object pToken11,
                    java.lang.Object pToken12,
                    java.lang.Object pToken13,
                    java.lang.Object pToken14,
                    java.lang.Object pToken15)

Shortcut for addLine(getIndentationLevel(), new Object[]{pToken1, pToken2, pToken3, pToken4, pToken5, pToken6, pToken7, pToken8, pToken9, pToken10, pToken11, pToken12, pToken13, pToken15}) .

moveToTop

public void moveToTop()

Moves the cursor to the top of the method.

moveToBottom

public void moveToBottom()

Moves the cursor to the bottom of the method.

newPlaceHolder

public PlaceHolder newPlaceHolder(java.lang.String pName,
                                  boolean pAutoRemove)

Sets a placeholder with the given name.

Parameters:

pName - The placeholders name

pAutoRemove - Whether the placeholder must be removed by invoking PlaceHolder.remove() (false) or not (true).

getPlaceHolder

public PlaceHolder getPlaceHolder(java.lang.String pName)

Searches for the placeholder with the given name. The cursor will be set to the line after the placeholder, if it is found. In that case subsequent invocations of addLine() will add code to the lines following the placeholder. Otherwise the cursor is unchanged.

Parameters:

pName - The placeholders name

Returns:

The placeholder or null, if it wasn't found.