|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RuntimeTagElement
Defines the execution behavior an XML Element in a JET2 compiled template.
Clients do not typically use the class directly.
The tag has the following life cycle:
setParent()
. If the tag has no parent, null
is passed.setTagInfo(TagInfo)
.doStart()
.okToProcessBody()
is called.okToProcessBody()
returns true
, then handleBodyContent()
is called.okToProcessBody()
and handleBodyContent()
are called
repeatedly until okToProcessBody()
returns false
.doEnd()
is called.
This interface is not intended to be implemented by clients.
Method Summary | |
---|---|
void |
doEnd()
Perform any actions associated with the end of the tag element. |
void |
doStart(JET2Context context,
JET2Writer out)
Perform any actions associated with the start of the tag element. |
JET2Context |
getContext()
Return the context passed to doStart(JET2Context, JET2Writer) . |
TagInfo |
getTagInfo()
Return the tag context set by setTagInfo(TagInfo) . |
JET2Writer |
getWriter()
Return the writer passed to doStart(JET2Context, JET2Writer) . |
void |
handleBodyContent(JET2Writer bodyContent)
Handle the body content of the tag element. |
boolean |
okToProcessBody()
Determine if the tag element's body should be processed. |
void |
setRuntimeParent(RuntimeTagElement parentTag)
Set the parent tag of the element. |
void |
setTagInfo(TagInfo tagInfo)
Provide the tag with information on its context within the template, include attribute values and position. |
Method Detail |
---|
void setRuntimeParent(RuntimeTagElement parentTag)
ready()
is called.
parentTag
- the parent tag, or null
if the tag has no parent in the template.void setTagInfo(TagInfo tagInfo)
tagInfo
- the tag information. Will never by null
.TagInfo
TagInfo getTagInfo()
setTagInfo(TagInfo)
.
null
if not yet set.void doStart(JET2Context context, JET2Writer out)
context
- out
- void doEnd()
boolean okToProcessBody()
false
is returned. Each time true
is returned, handleBodyContent(JET2Writer)
is called.
true
if the body should be processed, false
otherwise.void handleBodyContent(JET2Writer bodyContent)
okToProcessBody()
returns true
.
bodyContent
- the writer containing the body content. Will never by null
.JET2Context getContext()
doStart(JET2Context, JET2Writer)
.
JET2Writer getWriter()
doStart(JET2Context, JET2Writer)
.
|
Copyright 2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |