|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.odfdom.taglet.OdfElementTaglet
public class OdfElementTaglet
This class implements a custom taglet to the map the ODF element to the
declaration of the ODF element in the OpenDocument specification.
The position of the OpenDocument specification in HTML can be provided using
an environment variable or java system property, while the system property overrides
the environment variable.
In case nothing is been a default path within the JavaDoc doc-files directory is being used.
For example the taglet {@odf.element text:span}
would be resolved without variable settings to
JAVA_DOC_BASE/doc-files/OpenDocument-v1.2-cd05-part1.html#element-text_span
.
Constructor Summary | |
---|---|
OdfElementTaglet()
|
Method Summary | |
---|---|
String |
getName()
Return the name of this custom tag. |
boolean |
inConstructor()
|
boolean |
inField()
|
boolean |
inMethod()
|
boolean |
inOverview()
|
boolean |
inPackage()
|
boolean |
inType()
|
boolean |
isInlineTag()
Will return true since this is an inline tag. |
static void |
register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
Register this Taglet. |
String |
toString(com.sun.javadoc.Tag tag)
Given the Tag representation of this custom
tag, return its string representation. |
String |
toString(com.sun.javadoc.Tag[] tags)
This method should not be called since arrays of inline tags do not exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OdfElementTaglet()
Method Detail |
---|
public String getName()
getName
in interface com.sun.tools.doclets.Taglet
public boolean inField()
inField
in interface com.sun.tools.doclets.Taglet
public boolean inConstructor()
inConstructor
in interface com.sun.tools.doclets.Taglet
public boolean inMethod()
inMethod
in interface com.sun.tools.doclets.Taglet
public boolean inOverview()
inOverview
in interface com.sun.tools.doclets.Taglet
public boolean inPackage()
inPackage
in interface com.sun.tools.doclets.Taglet
public boolean inType()
inType
in interface com.sun.tools.doclets.Taglet
public boolean isInlineTag()
isInlineTag
in interface com.sun.tools.doclets.Taglet
public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
tagletMap
- the map to register this tag to.public String toString(com.sun.javadoc.Tag tag)
Tag
representation of this custom
tag, return its string representation.
toString
in interface com.sun.tools.doclets.Taglet
tag
- he Tag
representation of this custom tag.public String toString(com.sun.javadoc.Tag[] tags)
toString
in interface com.sun.tools.doclets.Taglet
tags
- the array of Tag
s representing of this custom tag.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |