IContext (Rythm Template Engine 1.4.1 API)

All Known Implementing Classes:

TemplateParser
```
public interface IContext
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IContext.Break

static class IContext.Continue

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IContext.Break`
`static class`	`IContext.Continue`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`closeBlock()` Notify context to close current block and return the block close carets
`boolean`	`compactMode()`
`IBlockHandler`	`currentBlock()` Return current block handler
`int`	`currentLine()` Return current line number
`String`	`currentSection()` Returns the current section name
`int`	`cursor()`
`void`	`enterDirectiveComment()`
`CodeBuilder`	`getCodeBuilder()` Return the root source code builder
`IDialect`	`getDialect()`
`RythmEngine`	`getEngine()`
`String`	`getRemain()` Return the remaining template string that has not parsed yet
`TemplateClass`	`getTemplateClass()`
`String`	`getTemplateSource(int start, int end)` Return any segment of template source
`boolean`	`hasRemain()` Do have have remain template content to be parsed
`boolean`	`insideBody()`
`boolean`	`insideBody2()`
`boolean`	`insideDirectiveComment()`
`void`	`leaveDirectiveComment()`
`void`	`openBlock(IBlockHandler bh)` Notify context to enter a block
`char`	`peek()`
`IContext.Break`	`peekBreak()`
`ICodeType`	`peekCodeType()`
`Boolean`	`peekCompact()`
`IContext.Continue`	`peekContinue()`
`Boolean`	`peekInsideBody()`
`Boolean`	`peekInsideBody2()`
`Locale`	`peekLocale()`
`char`	`pop()`
`IContext.Break`	`popBreak()`
`ICodeType`	`popCodeType()`
`Boolean`	`popCompact()`
`IContext.Continue`	`popContinue()`
`Boolean`	`popInsideBody()`
`Boolean`	`popInsideBody2()`
`Locale`	`popLocale()`
`void`	`pushBreak(IContext.Break b)`
`void`	`pushCodeType(ICodeType type)`
`void`	`pushCompact(Boolean compact)`
`void`	`pushContinue(IContext.Continue c)`
`void`	`pushInsideBody(Boolean b)`
`void`	`pushInsideBody2(Boolean b)`
`void`	`pushLocale(Locale locale)`
`void`	`setDialect(IDialect dialect)`
`void`	`step(int i)` Move the current cursor i steps ahead

- Method Detail
  - getCodeBuilder
```
CodeBuilder getCodeBuilder()
```
    Return the root source code builder
    
    Returns:
    
    the code builder
  - getRemain
```
String getRemain()
```
    Return the remaining template string that has not parsed yet
    
    Returns:
    
    remaining text to be parsed
  - hasRemain
```
boolean hasRemain()
```
    Do have have remain template content to be parsed
    
    Returns:
    
    true if there are remaining text to be parsed
  - peek
```
char peek()
```
    Returns:
    
    the first remain character without moving cursor
  - pop
```
char pop()
```
    Returns:
    
    the first remain character and move the cursor one step
  - step
```
void step(int i)
```
    Move the current cursor i steps ahead
    
    Parameters:
    
    i -
  - getTemplateSource
```
String getTemplateSource(int start,
                         int end)
```
    Return any segment of template source
    
    Parameters:
    
    start -
    
    end -
    
    Returns:
    
    template source
  - openBlock
```
void openBlock(IBlockHandler bh)
```
    Notify context to enter a block
    
    Parameters:
    
    bh - the block handler
  - currentBlock
```
IBlockHandler currentBlock()
```
    Return current block handler
    
    Returns:
    
    current block handler
    
    Throws:
    
    ParseException
  - closeBlock
```
String closeBlock()
           throws ParseException
```
    Notify context to close current block and return the block close carets
    
    Throws:
    
    ParseException
  - currentSection
```
String currentSection()
```
    Returns the current section name
    
    Returns:
    
    the name of the current section
  - setDialect
```
void setDialect(IDialect dialect)
```
  - getDialect
```
IDialect getDialect()
```
  - currentLine
```
int currentLine()
```
    Return current line number
    
    Returns:
    
    current parsing line
  - cursor
```
int cursor()
```
  - getTemplateClass
```
TemplateClass getTemplateClass()
```
  - getEngine
```
RythmEngine getEngine()
```
  - pushBreak
```
void pushBreak(IContext.Break b)
```
  - peekBreak
```
IContext.Break peekBreak()
```
  - popBreak
```
IContext.Break popBreak()
```
  - pushContinue
```
void pushContinue(IContext.Continue c)
```
  - peekContinue
```
IContext.Continue peekContinue()
```
  - popContinue
```
IContext.Continue popContinue()
```
  - compactMode
```
boolean compactMode()
```
  - pushCompact
```
void pushCompact(Boolean compact)
```
  - peekCompact
```
Boolean peekCompact()
```
  - popCompact
```
Boolean popCompact()
```
  - insideBody
```
boolean insideBody()
```
  - peekInsideBody
```
Boolean peekInsideBody()
```
  - pushInsideBody
```
void pushInsideBody(Boolean b)
```
  - popInsideBody
```
Boolean popInsideBody()
```
  - insideBody2
```
boolean insideBody2()
```
  - peekInsideBody2
```
Boolean peekInsideBody2()
```
  - pushInsideBody2
```
void pushInsideBody2(Boolean b)
```
  - popInsideBody2
```
Boolean popInsideBody2()
```
  - insideDirectiveComment
```
boolean insideDirectiveComment()
```
  - enterDirectiveComment
```
void enterDirectiveComment()
```
  - leaveDirectiveComment
```
void leaveDirectiveComment()
```
  - peekCodeType
```
ICodeType peekCodeType()
```
  - pushCodeType
```
void pushCodeType(ICodeType type)
```
  - popCodeType
```
ICodeType popCodeType()
```
  - peekLocale
```
Locale peekLocale()
```
  - pushLocale
```
void pushLocale(Locale locale)
```
  - popLocale
```
Locale popLocale()
```

Interface IContext

Nested Class Summary

Method Summary

Method Detail

getCodeBuilder

getRemain

hasRemain

peek

pop

step

getTemplateSource

openBlock

currentBlock

closeBlock

currentSection

setDialect

getDialect

currentLine

cursor

getTemplateClass

getEngine

pushBreak

peekBreak

popBreak

pushContinue

peekContinue

popContinue

compactMode

pushCompact

peekCompact

popCompact

insideBody

peekInsideBody

pushInsideBody

popInsideBody

insideBody2

peekInsideBody2

pushInsideBody2

popInsideBody2

insideDirectiveComment

enterDirectiveComment

leaveDirectiveComment

peekCodeType

pushCodeType

popCodeType

peekLocale

pushLocale

popLocale