com.plumtree.portaluiinfrastructure.tags.helper
Class ATagInfrastructure

java.lang.Object
  com.plumtree.portaluiinfrastructure.tags.helper.ATagInfrastructure

Direct Known Subclasses:

ATag

public abstract class ATagInfrastructure
extends java.lang.Object

This class separates out the infrastructure classes used in a tag so that they are not documented with the ATag class.

Author:

DonH

Constructor Summary

ATagInfrastructure()

Method Summary

java.lang.String	GetName() The Tag Container uses this method to get the name of this tag.
TagHelper	GetTagHelper() The Tag Container uses this method to get the tag helper class to perform various framework functions.
TagMetaDataHelper	GetTagMetaDataHelper() The Tag Container uses this method to get the meta data about this tag perform error checking.
void	InitForDisplay(TagHelper _helper) The Tag Container uses this method to initialize the Tag with all of the data it needs for display.
void	Release() The Tag Container uses this method to release all data stored in this tag to prevent excess memory retention and to prepare the tag for reuse.
abstract void	ReleaseTag() This method releases all data stored in this tag to prevent excess memory retention and to prepare the tag for reuse.
void	SetTagMetaDataHelper(TagMetaDataHelper _tagMetaDataHelper) This method is used to store the meta data about this tag and is only called once per tag class when the class is loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ATagInfrastructure

public ATagInfrastructure()

Method Detail

ReleaseTag

public abstract void ReleaseTag()

This method releases all data stored in this tag to prevent excess memory retention and to prepare the tag for reuse. This method should return the tag to the state it was in immediately after the Create() method was called. After this method is called, the tag should be able to be re-initialized and used again. All tags that store custom data as member variables should override this method and release the data here. If a tag does not store custom data as member variables, then there is no need to override this method. Default Tag Method

InitForDisplay

public void InitForDisplay(TagHelper _helper)

The Tag Container uses this method to initialize the Tag with all of the data it needs for display. This is called before the tag is used the first time, and before it is used after every Release call. Framework Helper Method

Parameters:

TagHelper - _helper The tag helper for this tag

GetName

public java.lang.String GetName()

The Tag Container uses this method to get the name of this tag. If m_TagMetaDataHelper is not yet initialized it is initialized by this method. Framework Helper Method

Returns:

String The name of this tag.

GetTagMetaDataHelper

public TagMetaDataHelper GetTagMetaDataHelper()

The Tag Container uses this method to get the meta data about this tag perform error checking. Framework Helper Method

Returns:

TagMetaDataHelper The meta data for this tag.

Throws:

XPException - if an attempt is made to access the tag meta data helper before it has been set. This should not happen.

SetTagMetaDataHelper

public void SetTagMetaDataHelper(TagMetaDataHelper _tagMetaDataHelper)

This method is used to store the meta data about this tag and is only called once per tag class when the class is loaded. Framework Helper Method

Parameters:

TagMetaDataHelper - _tagMetaDataHelper The meta data for this tag.

GetTagHelper

public TagHelper GetTagHelper()

The Tag Container uses this method to get the tag helper class to perform various framework functions. Framework Helper Method

Returns:

TagHelper The helper class for this tag.

Throws:

XPException - if an attempt is made to access the tag helper before it has been set. This should not happen.

Release

public void Release()

The Tag Container uses this method to release all data stored in this tag to prevent excess memory retention and to prepare the tag for reuse. After this method is called, the tag should be able to be re-initialized and used again. This method should not be used by Tag developers. ReleaseTag() should be used instead. Framework Helper Method