com.plumtree.portaluiinfrastructure.tags.metadata
Class RequiredParentTag

java.lang.Object
  extended by com.plumtree.portaluiinfrastructure.tags.metadata.ARelatedTag
      extended by com.plumtree.portaluiinfrastructure.tags.metadata.RequiredParentTag

public class RequiredParentTag
extends ARelatedTag

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

If a tag class requires a specific parent tag in order to function, the class needs to have at least one public static final RequiredParentTag member variable that specifies the required parent tag. The required parent tag must be in the same library as this tag.

If this tag is used outside of the required parent tag, 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.

If multiple required parent tags are specified, then at least one required parent tag must be present for the tag to function (but not all parent tags are required to be present).

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


Field Summary
 
Fields inherited from class com.plumtree.portaluiinfrastructure.tags.metadata.ARelatedTag
m_TagData
 
Constructor Summary
RequiredParentTag(ITagMetaData _TagData)
          Creates a new required parent 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

RequiredParentTag

public RequiredParentTag(ITagMetaData _TagData)
Creates a new required parent tag meta data object.

If a tag class requires a specific parent tag in order to function, the class needs to have at least one public static final RequiredParentTag member variable that specifies the required parent tag.

If this tag is used outside of the required parent tag, 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.

If multiple required parent tags are specified, then at least one required parent tag must be present for the tag to function.

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

Parameters:
_TagData - The related child tag data



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.