xdoclet.tagshandler

Class IdTagsHandler

public class IdTagsHandler extends XDocletTagSupport

Version: $Revision: 1.9 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 15, 2001 namespace = "Id"

Method Summary
Stringid(Properties attributes)
Generates an id attribute based on the given tag values.
StringprefixedId(Properties attributes)
Generates an id attribute based on the given prefix.
static voidreset()
Resets the hashtable which backs the prefixId tag.

Method Detail

id

public String id(Properties attributes)
Generates an id attribute based on the given tag values. This is used for generating id attribute for XML elements.

Parameters: attributes The attributes of the template tag

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: 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)
Generates an id attribute based on the given prefix. This is used for generating id attribute for XML elements.

Parameters: attributes The attributes of the template tag

Returns: An id in the form of <prefix>_<num>

Throws: XDocletException Description of Exception

UNKNOWN: 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.