Plumtree Portal UI  
 

TagState Members

TagState overview

Public Static Fields

HTTP_REQUEST_DATA_KEY This key is used to store HTTP request data collections on the session using the request as a key.
SHARED_JS_COLLECTION This key is used to store an http request level HTMLElementCollection that contains all of the shared javascript for the tags in the HTTP request.
SHARED_JS_COLLECTION_DISPLAYED This key is used to store an http request level Boolean that marks whether or not the current shared javascript collection for this HTTP request has been retrieved for displayed or not.
SHARED_JS_VAR_LIST This key is used to store an http request level list that stores whether or not a particular class of tags has been displayed on the page yet.
TEST_PORTLET_REQUEST_DATA This static variable can be used to supply a pre-populated hashtable for the portlet request data. This will be used during TagState construction only. This should only be used in unit tests and not in production code.

Public Static Methods

GetHTTPRequestData This method extracts the HTTP request data from the Activity Space.
GetSharedJavascriptCollection This method gets the shared JavaScript collection for this HTTP request, and initializes it if it has not been initialized yet.
ResetPageRequestData This method is called at the end of every HTTP request to reset the page request data. This is a framework method and should not be called by tag developers.
SetSharedJavascriptCollectionAsDisplayed This method marks the shared JavaScript collection for this HTTP request as retrieved for display.

Protected Static Fields

COMBINED_KEY_SEPARATOR The separator between library and tag name in the combined key.

Public Instance Constructors

TagState Constructor Creates a TagState object. The TagState object contains portlet request specific data and must either be reset between requests or re-created.

Public Instance Methods

EnterTag The tag container calls this method every time a new tag is displayed.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExitTag The tag container calls this method when a tag is finished displaying. This will clean up data stored in the tag scope.
GetAnyVariable 
GetApplication 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetPersistentSubSession 
GetSharedVariable 
GetSubSession 
GetType (inherited from Object)Gets the Type of the current instance.
GetVariable 
InternalGetVariable Helper method to get variables in memory.
ResetPortletRequestData The tag container calls this method to reset the portlet request data for each portlet on a page and to verify that the TagState is in the correct state after having finished displaying all of the tags in the current portlet request.
SetSharedVariable 
SetVariable 
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

m_Application The HTTP Application.
m_CurrentTag The current tag.
m_HTTPRequestScopeData The HTTP Request Data container. This hashtable is stored in the session using the request as a key and is cached in the TagState object.
m_nTagStackTop The index into the top of the Tag Stack.
m_PersistentSession The persistent sub-session.
m_PortletRequestScopeData The Portlet Request Data container. This cannot be re-used between portlet requests and must be reset.
m_Session The sub-session.
m_TagScopeData The Tag Data container. This cannot be re-used between portlet requests and must be reset.
m_TagStack The Tag Stack. This keeps track of which Tags have been entered. It is a list of ATags.
m_TagVarStack The Tag Var Stack. This keeps track of what Data has been stored by which tag in tag scope. It is a list of XPArrayLists.

Protected Instance Methods

CheckValidVariableName This method checks that the variable name does not contain any reserved characters (".").
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetTagName Get the name of the current tag.
InternalRemoveVariable This method removes a variable from the underlying collection.
InternalSetVariable Helper method to set variables in memory.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

TagState Class | com.plumtree.portaluiinfrastructure.tags.helper Namespace