com.viaoa.template

Class OATemplate<F extends OAObject>

java.lang.Object

com.viaoa.template.OATemplate<F>

public class OATemplate<F extends OAObject>
extends Object

Dynamically converts text with custom property [paths] and processing tags into pure html text, by using a supplied OAObject or Hub to plug into the text.

Used for producing html, reports, web pages, emails, UI components like tooltips, autocomplete, renderers, and more.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fromText
protected String	hiliteText
protected String	toText

Constructor Summary

Constructors

Constructor and Description
OATemplate()
OATemplate(String htmlTemplate)

Method Summary

Modifier and Type	Method and Description
protected boolean	_generate(com.viaoa.template.OATemplate.TreeNode node, OAObject obj, Hub hub, StringBuilder sb, OAProperties props, int cntStop)
protected void	_removeRowTags(com.viaoa.template.OATemplate.TreeNode treeNode, int childPos)
protected void	_removeRowTagsAfter(com.viaoa.template.OATemplate.TreeNode treeNode)
protected void	_removeRowTagsBefore(com.viaoa.template.OATemplate.TreeNode treeNode)
protected OAObjectGrid	createObjectGrid(com.viaoa.template.OATemplate.TreeNode node, Hub hub)
protected com.viaoa.template.OATemplate.TreeNode	createTree(String doc)
protected boolean	generate(com.viaoa.template.OATemplate.TreeNode node, OAObject obj, Hub hub, StringBuilder sb, OAProperties props, int cntStop) Returns false if it did not complete (stopProcessing was called)
boolean	getHasParseError()
protected String	getIncludeText(String name) This is called to get the text for any include tags.
protected String	getOutputText(String s) Called to be able to convert before adding to output string.
protected Object	getProperty(OAObject oaObj, String propertyName) Method that is called to get an object property value.
String	getTemplate()
protected String	getValue(OAObject obj, String propertyName, int width, String fmt, OAProperties props, boolean bUseFormat)
protected void	parse(com.viaoa.template.OATemplate.TreeNode root)
protected ArrayList<com.viaoa.template.OATemplate.Token>	parseTokens(String doc)
protected String	preprocess(String doc)
protected String	preprocess(String doc, ArrayList<String> alInclude)
String	process()
String	process(F objRoot)
String	process(F objRoot1, F objRoot2)
String	process(F objRoot1, F objRoot2, Hub<F> hubRoot, OAProperties props)
String	process(F objRoot1, F objRoot2, OAProperties props)
String	process(F objRoot1, Hub<F> hubRoot, OAProperties props)
String	process(F objRoot, OAProperties props)
String	process(Hub<F> hub)
String	process(Hub<F> hub, OAProperties props)
protected void	removeRowTags(com.viaoa.template.OATemplate.TreeNode treeNode)
void	setHiliteOutputText(String text) Used by getOutPutText to call OAString.hilite(text)
void	setOutputTextConversion(String fromText, String toText) Used by getOutPutText to call OAString.convert(value, from, to)
void	setProperty(String name, Object value) Set a property, that is then referenced using <%=$name%> in the html.
void	setTemplate(String temp)
void	stopProcessing() Used to have a a call to getHtml stopped.

Methods inherited from class java.lang.Object

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

Field Detail

fromText

protected String fromText

toText

protected String toText

hiliteText

protected String hiliteText

Constructor Detail

OATemplate

public OATemplate()

OATemplate

public OATemplate(String htmlTemplate)

Method Detail

setTemplate

public void setTemplate(String temp)

getTemplate

public String getTemplate()

process

public String process()

process

public String process(F objRoot)

process

public String process(F objRoot1,
                      F objRoot2)

process

public String process(F objRoot1,
                      F objRoot2,
                      OAProperties props)

process

public String process(F objRoot,
                      OAProperties props)

process

public String process(Hub<F> hub,
                      OAProperties props)

process

public String process(Hub<F> hub)

stopProcessing

public void stopProcessing()

Used to have a a call to getHtml stopped.

process

public String process(F objRoot1,
                      Hub<F> hubRoot,
                      OAProperties props)

process

public String process(F objRoot1,
                      F objRoot2,
                      Hub<F> hubRoot,
                      OAProperties props)

setProperty

public void setProperty(String name,
                        Object value)

Set a property, that is then referenced using <%=$name%> in the html.

Parameters:

name - name used in html tag, without the '$' prefix. Note: it will remove '$' prefix if it is included.

createTree

protected com.viaoa.template.OATemplate.TreeNode createTree(String doc)

removeRowTags

protected void removeRowTags(com.viaoa.template.OATemplate.TreeNode treeNode)

_removeRowTags

protected void _removeRowTags(com.viaoa.template.OATemplate.TreeNode treeNode,
                              int childPos)

_removeRowTagsBefore

protected void _removeRowTagsBefore(com.viaoa.template.OATemplate.TreeNode treeNode)

_removeRowTagsAfter

protected void _removeRowTagsAfter(com.viaoa.template.OATemplate.TreeNode treeNode)

preprocess

protected String preprocess(String doc)

preprocess

protected String preprocess(String doc,
                            ArrayList<String> alInclude)

getIncludeText

protected String getIncludeText(String name)

This is called to get the text for any include tags. By default, it will return an error message.

parse

protected void parse(com.viaoa.template.OATemplate.TreeNode root)

getHasParseError

public boolean getHasParseError()

parseTokens

protected ArrayList<com.viaoa.template.OATemplate.Token> parseTokens(String doc)

generate

protected boolean generate(com.viaoa.template.OATemplate.TreeNode node,
                           OAObject obj,
                           Hub hub,
                           StringBuilder sb,
                           OAProperties props,
                           int cntStop)

Returns false if it did not complete (stopProcessing was called)

_generate

protected boolean _generate(com.viaoa.template.OATemplate.TreeNode node,
                            OAObject obj,
                            Hub hub,
                            StringBuilder sb,
                            OAProperties props,
                            int cntStop)

createObjectGrid

protected OAObjectGrid createObjectGrid(com.viaoa.template.OATemplate.TreeNode node,
                                        Hub hub)

getOutputText

protected String getOutputText(String s)

Called to be able to convert before adding to output string.

setOutputTextConversion

public void setOutputTextConversion(String fromText,
                                    String toText)

Used by getOutPutText to call OAString.convert(value, from, to)

setHiliteOutputText

public void setHiliteOutputText(String text)

Used by getOutPutText to call OAString.hilite(text)

getValue

protected String getValue(OAObject obj,
                          String propertyName,
                          int width,
                          String fmt,
                          OAProperties props,
                          boolean bUseFormat)

getProperty

protected Object getProperty(OAObject oaObj,
                             String propertyName)

Method that is called to get an object property value.

Parameters:

oaObj - object that is currently active. Either the report object or the object in foreach loop.