|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface representing common characteristics of JET2 custom tags.
All custom tags have the same setup sequence. The following methods are always called to initialize a tag:
CustomTag.setParent(CustomTag)
specifying the containing tag, if any.CustomTag.setTagInfo(TagInfo)
specifying the tag attribute values.CustomTag.setContext(JET2Context)
specifying the JET execution context.CustomTag.setOut(JET2Writer)
specifying the writer to which the tag should write.
This interface is not intended to be directly implemented by clients
Method Summary | |
---|---|
java.lang.String |
getAttribute(java.lang.String name)
Return the processed value of the tag attribute (with dynamic XPath expressions already resolved. |
CustomTagKind |
getKind()
Return the kind of the custom tag |
JET2Writer |
getOut()
Return the writer to which the tag will write. |
CustomTag |
getParent()
Return the parent tag. |
java.lang.String |
getRawAttribute(java.lang.String name)
Return the 'raw' value of the named tag attribute. |
void |
setContext(JET2Context context)
Set the context of the tag. |
void |
setOut(JET2Writer out)
Set the writer to which the tag will write. |
void |
setParent(CustomTag parent)
Set the custom tag representing the parent of this tag. |
void |
setTagInfo(TagInfo td)
Set the tag info for the tag. |
Method Detail |
public void setParent(CustomTag parent)
parent
- the parent tag, or null
if the tag has none.public CustomTag getParent()
null
if the tag has none.public CustomTagKind getKind()
CustomTagKind
public void setTagInfo(TagInfo td)
td
- the tag info.public void setContext(JET2Context context)
context
- the context.public java.lang.String getRawAttribute(java.lang.String name)
name
- the tag attribute name.
null
if the attribute is not defined.public java.lang.String getAttribute(java.lang.String name) throws JET2TagException
name
- the tag attribute name.
null
if the attribute is not defined.
JET2TagException
- if an error occurs while processing a dynmaic XPath expression.public void setOut(JET2Writer out)
out
- a non-null instance of JET2Writer.public JET2Writer getOut()
|
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 |