|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.jelly.TagSupport
org.kohsuke.stapler.jelly.AttributeTag
public class AttributeTag
Documentation for an attribute of a Jelly tag file.
This tag should be placed right inside DocumentationTag
to describe attributes of a tag. The body would describe
the meaning of an attribute in a natural language.
The description text can also use
Textile markup
Field Summary |
---|
Fields inherited from class org.apache.commons.jelly.TagSupport |
---|
body, context, parent |
Constructor Summary | |
---|---|
AttributeTag()
|
Method Summary | |
---|---|
void |
doTag(org.apache.commons.jelly.XMLOutput output)
|
void |
setDeprecated(boolean v)
If the attribute is deprecated, set to true. |
void |
setName(java.lang.String v)
Name of the attribute. |
void |
setType(java.lang.String v)
If it makes sense, describe the Java type that the attribute expects as values. |
void |
setUse(java.lang.String v)
If the attribute is required, specify use="required". |
Methods inherited from class org.apache.commons.jelly.TagSupport |
---|
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributeTag()
Method Detail |
---|
public void doTag(org.apache.commons.jelly.XMLOutput output)
@Required public void setName(java.lang.String v)
public void setUse(java.lang.String v)
By default, use="optional" is assumed.
public void setType(java.lang.String v)
public void setDeprecated(boolean v)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |