Plumtree Portal UI  
 

TagHelper Members

TagHelper overview

Public Static Fields

ATTRIBUTE_I18N_MARKER The marker used for attribute i18n string replacement ($#n.file).
ATTRIBUTE_VARIABLE_MARKER The marker for the beginning of a $var or $data.var attribute value replacement.
ATTRIBUTE_VARIABLE_SEPARATOR The separator between data collection name and value key in $data.var attribute value replacement.
UNIQUE_ID_COUNTER_KEY This key is used to store the unique ID counter in the HTTP request data.
UNIQUE_ID_KEY This key is used to store the unique ID for each tag in Tag Scope.

Public Instance Constructors

TagHelper Constructor Constructor for the TagHelper. This object should only be created by the tag framework.

Public Instance Methods

AddJavascript 
DisplayTag The Tag Container uses this method to display this tag. This method calls the DisplayTag() method. The TagVisitor must be set before this method can be called. Framework Helper Method
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetAttribute 
GetAttributeAsBoolean 
GetAttributeAsChar 
GetAttributeAsDouble 
GetAttributeAsInt 
GetAttributeAsLong 
GetAttributeAsString 
GetAttributeNames 
GetEnvironment 
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.
GetState 
GetType (inherited from Object)Gets the Type of the current instance.
GetUniqueID 
GetXMLAttribute 
GetXMLAttributeNames 
GetXMLTagAttributesAsString 
HasAttribute 
HasChildTag 
HasParentTag 
HasXMLAttribute 
ProcessTagBody 
ReleaseTagVisitor This method releases the tag visitor to make sure it is not leaked (retained). This should be called after the tag has been validated and processed.
SetTagVisitor This method sets the tag visitor so we can process the tag. This needs to be called before we can validate or process the tag. The tag visitor needs to be released after the tag has been validated and processed.
ToString (inherited from Object)Returns a String that represents the current Object.
ValidateContext The Tag Container uses this method to check whether or not this tag is being displayed in the correct context. This method checks for required parent and child tags, as well as for proper formatting and presence of required attributes. If the tag is not being used in a valid way, the Tag Container will log an error and not display this tag. Framework Helper Method
ValidateRequiredAttributes This helper method processes all the required PT attributes, validates them, and stores them in the hashtable. This method is public for testing purposes and should not be called otherwise.
ValidateRequiredChildTags This helper method processes the tag display tree for required child tags. This method is public for testing purposes and should not be called otherwise.
ValidateRequiredParentTags This helper method processes the tag display tree for required parent tags (at least one must be present). This method is public for testing purposes and should not be called otherwise.

Protected Instance Fields

m_attributeObjXML 
m_bPTAttributesProcessed 
m_bXMLAttributesProcessed 
m_processedPTAttributes 
m_processedXMLAttributes 
m_strUniqueID 
m_strXMLAttributeDisplaystring 
m_tag 
m_tagBody 
m_tagVisitor 

Protected Instance Methods

CheckAttribute Check the type safety of the requested attribute.
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.
GetCollectionVariable Looks up the data collection in memory, accesses the specified key, and converts the value to a string.
GetProcessedPTAttributes Helper access method to allow lazy initialization of the processed PT attribute hashtable. This method will create the hashtable when the method is called.
GetProcessedXMLAttributes Helper access method to allow lazy initialization of the processed XML attribute hashtable. This method will create the hashtable when the method is called.
GetVariable Looks up the variable in memory and converts the value to a string.
GetVariableObject Looks up the variable in memory and converts the value to a string.
InternalGetAttribute This helper method gets an attribute as a string.
InternalGetAttributeFromNameOverloaded. This helper method gets an attribute from a String object rather than an attribute object.
IsProcessedXMLAttributesEmpty Helper method to check if the hashtable is empty. This method will not create the hashtable if it does not exist.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
ProcessAllAttributes This helper method process all the PT attributes and stores them in the hashtable. This is only used if we are looping through the PT attributes instead of accessing them using their associated ATagAttribute objects.
ProcessAllXMLAttributes This helper method process all the XML attributes and stores them in the hashtable.
ProcessAttribute Performs attribute value replacement on the attribute. I.E. Replaces $var with the value of the tag variable var and $data.var with the value of the key var in the tag variable data collection data. Replaces $#n.file with the internationalized string with ID n in file file.
ProcessI18NStringAttribute Performs attribute value replacement on the attribute. I.E. Replaces $var with the value of the tag variable var and $data.var with the value of the key var in the tag variable data collection data. Replaces $#n.file with the internationalized string with ID n in file file.

See Also

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