com.plumtree.portaluiinfrastructure.tags.metadata
Interface ITagMetaData

All Known Implementing Classes:

LegacyTagMetaData, TagMetaData

public interface ITagMetaData

This class provides programmatic access to the tag meta data for name, description, and example.

Tag classes need to have exactly one public static final ITagMetaData member variable that provides the name, description, and example text for this Tag.

E.G.
<pt:thistag/>
would need
public static final ITagMetaData = new TagMetaData("thistag", "This tag displays some HTML ...");

Method Summary

java.lang.String	GetDescription() Gets the description of the tag
java.lang.String	GetExample() Gets the example text for this tag
java.lang.String	GetName() Gets the name of the tag

Method Detail

GetName

java.lang.String GetName()

Gets the name of the tag

Returns:

String The name of the tag

GetDescription

java.lang.String GetDescription()

Gets the description of the tag

Returns:

String The description of the tag

GetExample

java.lang.String GetExample()

Gets the example text for this tag

Note that example text containing HTML formatting must be in xml CDATA format

Returns:

String The example for this tag