|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.RuntimeTagElement.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 RuntimeTagElement.doStart(JET2Context, JET2Writer) . |
TagInfo |
getTagInfo()
Return the tag context set by RuntimeTagElement.setTagInfo(TagInfo) . |
JET2Writer |
getWriter()
Return the writer passed to RuntimeTagElement.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 |
public void setRuntimeParent(RuntimeTagElement parentTag)
ready()
is called.
parentTag
- the parent tag, or null
if the tag has no parent in the template.public void setTagInfo(TagInfo tagInfo)
tagInfo
- the tag information. Will never by null
.TagInfo
public TagInfo getTagInfo()
RuntimeTagElement.setTagInfo(TagInfo)
.
null
if not yet set.public void doStart(JET2Context context, JET2Writer out)
context
- out
- public void doEnd()
public boolean okToProcessBody()
false
is returned. Each time true
is returned, RuntimeTagElement.handleBodyContent(JET2Writer)
is called.
true
if the body should be processed, false
otherwise.public void handleBodyContent(JET2Writer bodyContent)
okToProcessBody()
returns true
.
bodyContent
- the writer containing the body content. Will never by null
.public JET2Context getContext()
RuntimeTagElement.doStart(JET2Context, JET2Writer)
.
public JET2Writer getWriter()
RuntimeTagElement.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 |