xdoclet.tagshandler
Class IdTagsHandler
public class IdTagsHandler
Version:
- Ara Abrahamian (ara_e@email.com)
- namespace = "Id"
- Oct 15, 2001
String | id(Properties attributes) - Generates an id attribute based on the given tag values.
|
String | prefixedId(Properties attributes) - Generates an id attribute based on the given prefix.
|
static void | reset() - Resets the hashtable which backs the prefixId tag.
|
delimit , expandClassName , generate , getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getDocletContext , getEngine , getExpandedDelimitedTagValue , getTagValue , getTagValue , getTagValue , hasTag , isTagValueEqual , mandatoryParamNotFound , mandatoryTemplateTagParamNotFound , modifiers , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
id
public String id(Properties attributes)
throws XDocletException
Generates an id attribute based on the given tag values. This is used for generating id attribute for XML
elements.
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
- name = "tagName"
optional = "false"
description = "The tag from which the value of the id
is calculated."
- name = "paramNames"
optional = "false"
description = "Comma separated list of parameter
names. The list is ordered, preferred param is before another param which is less important. If the param
exists, its value is taken and used as the id value."
prefixedId
public String prefixedId(Properties attributes)
throws XDocletException
Generates an id attribute based on the given prefix. This is used for generating id attribute for XML elements.
attributes
- The attributes of the template tag
- An id in the form of <prefix>_<num>
XDocletException
- Description of Exception
- type = "content"
- name = "prefix"
optional = "false"
description = "The tag from which the value of the id
is calculated."
reset
public static void reset()
Resets the hashtable which backs the prefixId tag.