com.plumtree.portaluiinfrastructure.tags.helper
Class TagVisitor

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

public class TagVisitor
extends java.lang.Object

This class is used to traverse the tag display tree and pass common data to each element as it is displayed.

Author:

donh

Field Summary

protected TagDisplayElement	m_CurrentTag
protected IEnvironment	m_Environment
protected HTMLElementCollection	m_SharedJavascript
protected TagState	m_TagState

Constructor Summary

TagVisitor(TagState _tagState, IEnvironment _environment, HTMLElementCollection _sharedJavaScript)
Constructor for TagVisitor.

Method Summary

IEnvironment	GetEnvironment() The environment for the current HTTP request.
HTMLElementCollection	GetJavaScriptCollection() The Shared JavaScript collection for the current http request.
TagState	GetState() The TagState for the current portlet request.
boolean	HasChildTags(ITagMetaData[] _childTags, java.lang.Object[] _results, TagLibraryMetaData _library)
int	HasParentTag(ITagMetaData _parentTag, TagLibraryMetaData _library)
void	SetCurrentTag(TagDisplayElement _currentTag) Sets the current Tag Display Element from the display tree so the TagVisitor can search the tree.

Methods inherited from class java.lang.Object

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

Field Detail

m_TagState

protected TagState m_TagState

m_Environment

protected IEnvironment m_Environment

m_CurrentTag

protected TagDisplayElement m_CurrentTag

m_SharedJavascript

protected HTMLElementCollection m_SharedJavascript

Constructor Detail

TagVisitor

public TagVisitor(TagState _tagState,
                  IEnvironment _environment,
                  HTMLElementCollection _sharedJavaScript)

Constructor for TagVisitor. This should only be called by the tag framework.

Parameters:

_tagState - The TagState object for this portlet request.

_environment - The environment for this HTTP request.

Method Detail

GetEnvironment

public IEnvironment GetEnvironment()

The environment for the current HTTP request.

Returns:

IEnvironment The environment for the current HTTP request.

GetState

public TagState GetState()

The TagState for the current portlet request.

Returns:

TagState The TagState for the current portlet request.

GetJavaScriptCollection

public HTMLElementCollection GetJavaScriptCollection()

The Shared JavaScript collection for the current http request.

Returns:

HTMLElementCollection The Shared JavaScript collection.

SetCurrentTag

public void SetCurrentTag(TagDisplayElement _currentTag)

Sets the current Tag Display Element from the display tree so the TagVisitor can search the tree.

Parameters:

_currentTag - The current TagDisplayElement in the display tree.

HasParentTag

public int HasParentTag(ITagMetaData _parentTag,
                        TagLibraryMetaData _library)

See Also:

IDisplayElement.HasParentElement(ITagMetaData, TagLibraryMetaData)

HasChildTags

public boolean HasChildTags(ITagMetaData[] _childTags,
                            java.lang.Object[] _results,
                            TagLibraryMetaData _library)

See Also:

com.plumtree.portaluiinfrastructure.tags.displaytree.IDisplayElement#HasChildElements(ITagMetaData[], Object[], TagLibraryMetaData)