Package fr.opensagres.xdocreport.template.formatter

Interface IDocumentFormatter

All Known Implementing Classes:

AbstractDocumentFormatter

public interface IDocumentFormatter

Method Summary

Modifier and Type	Method	Description
boolean	containsInterpolation(String content)
String	extractItemNameList(String content, String fieldName, boolean forceAsField)
int	extractListDirectiveInfo(String content, DirectivesStack directives)
int	extractListDirectiveInfo(String content, DirectivesStack directives, boolean dontRemoveListDirectiveInfo)
String	extractModelTokenPrefix(String newContent)
String	formatAsCallTextStyling(long variableIndex, String fieldName, String documentKind, String syntaxKind, boolean syntaxWithDirective, String elementId, String entryName)
String	formatAsFieldItemList(String content, String fieldName, boolean forceAsField)
String	formatAsSimpleField(boolean noescape, boolean encloseInDirective, String... fields)
String	formatAsSimpleField(boolean encloseInDirective, String... fields)
String	formatAsTextStylingField(long variableIndex, String textBeforeProperty)
String	getDefineDirective(String name, String value)
String	getElseDirective()
String	getEndDocumentDirective()
String	getEndIfDirective(String fieldName)
String	getEndLoopDirective(String itemNameList)
String	getEndNoParse()
String	getFunctionDirective(boolean noescape, boolean encloseInDirective, String key, String methodName, String... parameters)
String	getFunctionDirective(boolean encloseInDirective, String key, String methodName, String... parameters)
String	getFunctionDirective(String key, String methodName, String... parameters)
int	getIndexOfScript(String fieldName)
String	getLoopCountDirective(String fieldName)
String	getSetDirective(String name, String value)
String	getSetDirective(String name, String value, boolean valueIsField)
String	getStartDocumentDirective()
String	getStartIfDirective(String fieldName)
String	getStartIfDirective(String fieldName, boolean exists)
String	getStartIfDirectiveIfExists(String fieldName)
String	getStartLoopDirective(String itemNameList)
String	getStartLoopDirective(String itemNameList, String listName)
String	getStartNoParse()
boolean	hasDirective(String characters)
boolean	isInstruction(String tagContent)	Returns true if an instruction tag is included and false otherwise.

Method Details

getStartDocumentDirective

String getStartDocumentDirective()

getEndDocumentDirective

String getEndDocumentDirective()

formatAsFieldItemList

String formatAsFieldItemList(String content,
 String fieldName,
 boolean forceAsField)

extractItemNameList

String extractItemNameList(String content,
 String fieldName,
 boolean forceAsField)

getStartLoopDirective

String getStartLoopDirective(String itemNameList)

getStartLoopDirective

String getStartLoopDirective(String itemNameList,
 String listName)

getEndLoopDirective

String getEndLoopDirective(String itemNameList)

getLoopCountDirective

String getLoopCountDirective(String fieldName)

getStartIfDirective

String getStartIfDirective(String fieldName)

getStartIfDirectiveIfExists

String getStartIfDirectiveIfExists(String fieldName)

getStartIfDirective

String getStartIfDirective(String fieldName,
 boolean exists)

getEndIfDirective

String getEndIfDirective(String fieldName)

formatAsSimpleField

String formatAsSimpleField(boolean noescape,
 boolean encloseInDirective,
 String... fields)

formatAsSimpleField

String formatAsSimpleField(boolean encloseInDirective,
 String... fields)

containsInterpolation

boolean containsInterpolation(String content)

extractListDirectiveInfo

int extractListDirectiveInfo(String content,
 DirectivesStack directives)

extractListDirectiveInfo

int extractListDirectiveInfo(String content,
 DirectivesStack directives,
 boolean dontRemoveListDirectiveInfo)

extractModelTokenPrefix

String extractModelTokenPrefix(String newContent)

getIndexOfScript

int getIndexOfScript(String fieldName)

getFunctionDirective

String getFunctionDirective(boolean noescape,
 boolean encloseInDirective,
 String key,
 String methodName,
 String... parameters)

getFunctionDirective

String getFunctionDirective(boolean encloseInDirective,
 String key,
 String methodName,
 String... parameters)

getFunctionDirective

String getFunctionDirective(String key,
 String methodName,
 String... parameters)

hasDirective

boolean hasDirective(String characters)

formatAsCallTextStyling

String formatAsCallTextStyling(long variableIndex,
 String fieldName,
 String documentKind,
 String syntaxKind,
 boolean syntaxWithDirective,
 String elementId,
 String entryName)

formatAsTextStylingField

String formatAsTextStylingField(long variableIndex,
 String textBeforeProperty)

getElseDirective

String getElseDirective()

getSetDirective

String getSetDirective(String name,
 String value,
 boolean valueIsField)

getSetDirective

String getSetDirective(String name,
 String value)

getStartNoParse

String getStartNoParse()

getEndNoParse

String getEndNoParse()

getDefineDirective

String getDefineDirective(String name,
 String value)

isInstruction

boolean isInstruction(String tagContent)

Returns true if an instruction tag is included and false otherwise.

Parameters:

tagContent -

Returns: