org.rythmengine.template
Class TagBase

java.lang.Object
  extended by org.rythmengine.utils.TextBuilder
      extended by org.rythmengine.internal.TemplateBuilder
          extended by org.rythmengine.template.TemplateBase
              extended by org.rythmengine.template.TagBase
All Implemented Interfaces:
Cloneable, ITag, ITemplate
Direct Known Subclasses:
JavaTagBase, ToStringTemplateBase

public abstract class TagBase
extends TemplateBase
implements ITag

Define a tag


Nested Class Summary
 
Nested classes/interfaces inherited from class org.rythmengine.template.TemplateBase
TemplateBase.__Itr<T>
 
Nested classes/interfaces inherited from class org.rythmengine.utils.TextBuilder
TextBuilder.StrBuf
 
Nested classes/interfaces inherited from interface org.rythmengine.template.ITag
ITag.__Body, ITag.__Parameter, ITag.__ParameterList
 
Nested classes/interfaces inherited from interface org.rythmengine.template.ITemplate
ITemplate.__Context
 
Field Summary
protected  ITag.__Body __body
           
protected  ITag.__Body __context
           
protected  ITag.__Body _body
           
 
Fields inherited from class org.rythmengine.template.TemplateBase
__ctx, __engine, __logger, __logTime, __parent, __renderArgs
 
Fields inherited from class org.rythmengine.utils.TextBuilder
__buffer, __caller
 
Constructor Summary
TagBase()
           
 
Method Summary
 void __call(int line)
          Call this tag
 boolean __calling()
          Check if inside a tag calling context
 ITemplate __cloneMe(RythmEngine engine, ITemplate caller)
          Not to be used in user application or template
 String __getName()
          Get the tag name
protected  int __line()
           
protected  void __pLayoutContent()
          Print the layout content.
 ITag __setBodyContext(ITag.__Body body)
          Set body context and return this tag
 ITemplate __setRenderArg(String name, Object arg)
          Set a render arg by name
 ITemplate __setRenderArgs(Map<String,Object> args)
          Set renderArgs in name-value pair
 String __str()
           
protected  void __triggerRenderEvent(IEvent<Void,ITemplate> event, RythmEngine engine)
          Trigger render events.
protected  void _pTagBody(ITag.__ParameterList parameterList, StringBuilder out)
           
 
Methods inherited from class org.rythmengine.template.TemplateBase
__append, __append, __append, __append, __append, __append, __append, __append, __caller, __curCodeType, __curEscape, __curLocale, __debug, __defaultEscape, __endSection, __endSection, __engine, __error, __error, __eval, __get, __getAs, __getRenderArg, __getRenderProperty, __getRenderProperty, __getRenderPropertyAs, __getSection, __getSection, __getTemplateClass, __getUserContext, __handleTemplateExecutionException, __i18n, __info, __init, __internalBuild, __internalClone, __internalInit, __internalRender, __invokeTag, __invokeTag, __invokeTag, __invokeTag, __invokeTag, __invokeTag, __invokeTag, __invokeTag, __loadExtendingArgs, __log, __pLayoutSection, __prepareRender, __render, __render, __renderArgName, __renderArgTypeArray, __renderArgTypeMap, __set, __setLayoutContent, __setOutput, __setOutput, __setOutput, __setOutput, __setOutputStream, __setRenderArg, __setRenderArg, __setRenderArgs, __setRenderArgs0, __setRenderProperty, __setSecureCode, __setTemplateClass, __setup, __setUserContext, __setWriter, __startSection, __warn, __warn, build, pe, pe, render, render, render, s
 
Methods inherited from class org.rythmengine.internal.TemplateBuilder
pe, pe, pe, pe, pe, pe, pe, pe, pe, pe, pe, pe, pe
 
Methods inherited from class org.rythmengine.utils.TextBuilder
__append, __getBuffer, __setBuffer, buffer, caller, clone, getSelfOut, np, p, p, p, p, p, p, p, p, p, p2t, p2tn, p3t, p3tn, p4t, p4tn, pn, pn, pt, ptn, setSelfOut, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rythmengine.template.ITemplate
__getBuffer
 

Field Detail

__body

protected ITag.__Body __body

_body

protected ITag.__Body _body

__context

protected ITag.__Body __context
Constructor Detail

TagBase

public TagBase()
Method Detail

__line

protected int __line()

__calling

public boolean __calling()
Check if inside a tag calling context

Note this is not an API for user application

Returns:
true if is inside a tag calling context

__cloneMe

public ITemplate __cloneMe(RythmEngine engine,
                           ITemplate caller)
Description copied from class: TemplateBase
Not to be used in user application or template

Specified by:
__cloneMe in interface ITemplate
Overrides:
__cloneMe in class TemplateBase
Parameters:
engine - the rythm engine
caller - the caller template
Returns:
cloned template

__setRenderArgs

public ITemplate __setRenderArgs(Map<String,Object> args)
Description copied from interface: ITemplate
Set renderArgs in name-value pair

Specified by:
__setRenderArgs in interface ITemplate
Overrides:
__setRenderArgs in class TemplateBase
Returns:
this template instance

__setRenderArg

public ITemplate __setRenderArg(String name,
                                Object arg)
Description copied from interface: ITemplate
Set a render arg by name

Specified by:
__setRenderArg in interface ITemplate
Overrides:
__setRenderArg in class TemplateBase
Returns:
this template instance

__setBodyContext

public ITag __setBodyContext(ITag.__Body body)
Description copied from interface: ITag
Set body context and return this tag

Specified by:
__setBodyContext in interface ITag
Returns:
this tag

__triggerRenderEvent

protected void __triggerRenderEvent(IEvent<Void,ITemplate> event,
                                    RythmEngine engine)
Description copied from class: TemplateBase
Trigger render events.

Not an API for user application

Overrides:
__triggerRenderEvent in class TemplateBase

__call

public void __call(int line)
Description copied from interface: ITag
Call this tag

Specified by:
__call in interface ITag
Parameters:
line - the number of the caller template line which invoke this tag

_pTagBody

protected void _pTagBody(ITag.__ParameterList parameterList,
                         StringBuilder out)

__pLayoutContent

protected void __pLayoutContent()
Description copied from class: TemplateBase
Print the layout content. Not to be used in user application or template

Overrides:
__pLayoutContent in class TemplateBase

__getName

public String __getName()
Description copied from interface: ITag
Get the tag name

Specified by:
__getName in interface ITag
Returns:
tag name

__str

public String __str()


Copyright © 2013. All Rights Reserved.