com.plumtree.portaluiinfrastructure.tags.metadata
Class RequiredChildTag

java.lang.Object
  com.plumtree.portaluiinfrastructure.tags.metadata.ARelatedTag
      com.plumtree.portaluiinfrastructure.tags.metadata.RequiredChildTag

public class RequiredChildTag
extends ARelatedTag

This class provides programmatic access to the tag meta data for required child tags.

Tag classes need to have one public static final RequiredChildTag member variable for every child tag that this tag requires. The required child tag must be in the same library as this tag.

If this child tag is required to be present every time the main tag is used, and the child tag is not present, an error will be logged and the tag and its children will be skipped and not displayed. An HTML Comment describing the tag and error will be displayed instead.

E.G. If parenttag requires childtag to be present, then
<pt:parenttag><pt:childtag/></pt:parenttag>
will work, but
<pt:parenttag>text</pt:parenttag>
will not work, because childtag is required to be inside of parenttag.

Field Summary

Fields inherited from class com.plumtree.portaluiinfrastructure.tags.metadata.ARelatedTag

m_TagData

Constructor Summary

RequiredChildTag(ITagMetaData _TagData)
Creates a new required child tag meta data object.

Method Summary

Methods inherited from class com.plumtree.portaluiinfrastructure.tags.metadata.ARelatedTag

GetTagData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequiredChildTag

public RequiredChildTag(ITagMetaData _TagData)

Creates a new required child tag meta data object.

Tag classes need to have one public static final RequiredChildTag member variable for every child tag that this tag requires.

If this child tag is required to be present every time the main tag is used, and the child tag is not present, an error will be logged and the tag and its children will be skipped and not displayed. An HTML Comment describing the tag and error will be displayed instead.

E.G. If parenttag requires childtag to be present, then
<pt:parenttag><pt:childtag/></pt:parenttag>
will work, but
<pt:parenttag>text</pt:parenttag>
will not work, because childtag is required to be inside of parenttag.

Parameters:

_TagData - The related child tag data