![]() | This method is used to add JavaScript for this tag. This method should not be used for common JavaScript for a tag (such as JavaScript includes) that only needs to be displayed once per page, regardless of how many instances of this tag there are on the page. DisplaySharedJavaScript() should be used instead. JavaScript added using this method will not be displayed in Section 508 compliance mode, as 508 screen readers do not allow JavaScript. Tag Utility Method |
![]() | This method is used to create new instance of managed (i.e. dynamically discovered) tags. Tag methods will not be functional during execution of this method (E.G. tag.SetStateVariable, etc... will not work). |
![]() | This method is used to display JavaScript that only needs to included on a page once, regardless of how many times a particular tag is used on that page (such as including JavaScript files). Tags that need to include javascript once per page should override this method and include the javascript here. This method is called automatically by the framework and does not need to be called in the DisplayTag() method. This method will not be called in Section 508 compliance mode, as 508 screen readers do not allow JavaScript. If there are errors in the tag and the JavaScript cannot be displayed properly, the tag should throw an XPException with the error message, and the tag framework will log the error and add the message and stack trace to the HTML as an HTML comment. The message contents will be HTML encoded before being added to the comment. Default Tag Method |
![]() | This is the main display method of the Tag. This method is responsible for displaying all of the tag specific HTML, as well as displaying the inner HTML of the tag. E.G. <pt:thistag><span><pt:innertag/></span></pt:thistag> This method is responsible for displaying the thistag UI and displaying the inner HTML (<span><pt:innertag/></span>) by calling ProcessTagBody and including the results in the HTMLElement returned by this method. This method is also responsible for displaying any instances of JavaScript need by this tag through the AddJavascript method. The DisplaySharedJavascript method will be called automatically by the framework and does not need to be called by this method. If there are errors in the tag and it cannot be displayed properly, the tag should throw an XPException with the error message, and the tag framework will log the error and add the message and stack trace to the HTML as an HTML comment. The message contents will be HTML encoded before being added to the comment. Abstract Tag Method |
![]() | Determines whether the specified Object is equal to the current Object. |
![]() | Gets a variable from memory from all scopes. The scope determines who can see this variable and how long it stays in memory. For instance, a variable can only be retrieved from Tag Scope if a tag that includes the current tag added the variable to Tag Scope. A variable can only be retrieved from Portlet Request Scope if another tag in the portlet stored the variable in memory. Standard variables (as opposed to shared variables) can only be accessed by tags from the same tag library as the tag that originally stored the variable. This method will first look for standard variables, and if not found will then look for shared variables. Note: Retrieving an HTMLElement from memory that has already been displayed in another tag and then adding more HTML to the original tag is not supported. HTMLElement trees can be retrieved from memory and re-used, as long as they are not modified. The safest way to do this is to make a clone of the cached HTMLElement tree before trying to display it again to make sure there are no threading problems. Tag State Variable Method |
![]() | Gets the environment for the current tag and request. Tag Utility Method |
![]() | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
![]() | 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 |
![]() | Gets the variable state helper object. This object allows you to get and set variables for various contexts (session, request, tag, etc...). Tag Utility Method |
![]() | Gets a shared variable from memory in the appropriate scope. The scope determines who can see this variable and how long it stays in memory. For instance, a variable can only be retrieved from Tag Scope if a tag that includes the current tag added the variable to Tag Scope. A variable can only be retrieved from Portlet Request Scope if another tag in the portlet stored the variable in memory. Shared variables can be accessed by tags from any tag library (as opposed to standard variables, which can only be accessed by tags from the same tag library). Note: Retrieving an HTMLElement from memory that has already been displayed in another tag and then adding more HTML to the original tag is not supported. HTMLElement trees can be retrieved from memory and re-used, as long as they are not modified. The safest way to do this is to make a clone of the cached HTMLElement tree before trying to display it again to make sure there are no threading problems. Tag State Variable Method |
![]() | Gets a variable from memory in the appropriate scope. The scope determines who can see this variable and how long it stays in memory. For instance, a variable can only be retrieved from Tag Scope if a tag that includes the current tag added the variable to Tag Scope. A variable can only be retrieved from Portlet Request Scope if another tag in the portlet stored the variable in memory. Standard variables (as opposed to shared variables) can only be accessed by tags from the same tag library as the tag that originally stored the variable. Note: Retrieving an HTMLElement from memory that has already been displayed in another tag and then adding more HTML to the original tag is not supported. HTMLElement trees can be retrieved from memory and re-used, as long as they are not modified. The safest way to do this is to make a clone of the cached HTMLElement tree before trying to display it again to make sure there are no threading problems. Tag State Variable Method |
![]() | This method gets the value of the requested pt attribute. E.G. <pt:tag pt:ptattr="test" width="10"/> would get the ptattr attribute, but not the width attribute. PT attributes are designed to specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. In general, PT Attributes should have a corresponding ATagAttribute class and should be retrieved using the GetTagAttributeAs* methods. These methods handle default attribute values and attribute type conversion. This method does not handle default attribute values if the attribute is not present, or if there is an error processing the attribute. This method is present for backwards compatibility with the standard Transformer tags and should not be used if at all possible. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute. E.G. <pt:tag pt:ptattr="false" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute. E.G. <pt:tag pt:ptattr="t" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute. E.G. <pt:tag pt:ptattr="1.5" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute. E.G. <pt:tag pt:ptattr="12" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute. E.G. <pt:tag pt:ptattr="100" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | This method gets the requested attribute if it was present in the tag. Otherwise it returns the default value for the attribute, if there is one. E.G. <pt:tag pt:ptattr="test" width="10"/> would get the ptattr attribute, but not the width attribute. A description of the valid formats for attributes can be found in the AttributeType class. PT Tag Attribute Method |
![]() | Gets an enumeration of the names of all the pt attributes in this tag. E.G. <pt:tag pt:ptattr="test" width="10"/> would return the ptattr attribute, but not the width attribute. PT attributes are designed to specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. In general, PT Attributes should have a corresponding ATagAttribute class and should be retrieved using the GetTagAttributeAs* methods. These methods handle default attribute values and attribute type conversion. This method is present for backwards compatibility with the standard Transformer tags and should not be used if at all possible. PT Tag Attribute Method |
![]() | The Tag Container uses this method to get the tag helper class to perform various framework functions. Framework Helper Method |
![]() | The Tag Container uses this method to get the meta data about this tag perform error checking. Framework Helper Method |
![]() | This method describes what kind of tag this is. The default is a simple tag (i.e. displays some HTML, displays the body, and then displays some more HTML). Tags that display the tag body more than once (e.g. looping tags) should override this method and return TagType.LOOPING. Tags that will never display the tag body should override this method and return TagType.NO_BODY to allow for performance optimizations. The TagType data is used for performance optimizations. Default Tag Method |
![]() | Gets the Type of the current instance. |
![]() | Gets a unique ID for this instance of this tag. This ID is unique across all tags on all portlets on a given page. This ID cannot be re-used across multiple pages and needs to be regenerated. Tag Utility Method |
![]() | This method gets the value of the requested non-pt attribute. E.G. <pt:tag pt:ptattr="test" width="10"/> would get the width attribute, but not the ptattr attribute. XML attributes are designed to let a web designer specify standard HTML attributes for a tag without the tag author having to handle them individually. PT attributes specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. This is only appropriate for tags that output a simple HTML tag. This method does not handle default attribute values. XML Tag Attribute Method |
![]() | Gets an enumeration of the names of all the non-pt attributes in this tag. E.G. <pt:tag pt:ptattr="test" width="10"/> would return the width attribute, but not the ptattr attribute. XML attributes are designed to let a web designer specify standard HTML attributes for a tag without the tag author having to handle them individually. PT attributes specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. XML Tag Attribute Method This is only appropriate for tags that output a simple HTML tag. |
![]() | Calculates a string containing all of the non-pt attributes that can be inserted inside an XML tag to add all of the attributes to the tag. E.G. <pt:tag pt:ptattr="test" width="10" length="20"/> would return the following string: width="10" length="20" XML attributes are designed to let a web designer specify standard HTML attributes for a tag without the tag author having to handle them individually. PT attributes specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. XML Tag Attribute Method This is only appropriate for tags that output a simple HTML tag. |
![]() | Check whether or not a particular Transformer Tag is nested inside the current Tag. The child tag must be in the same library as the current tag. E.G. <pt:thistag><span><pt:firstchildtag><pt:subsubchildtag/></pt:firstchildtag> <pt:secondchildtag/><span></pt:thistag> would return true for "firstchildtag", "secondchildtag", and "subsubchildtag", but not "span", since it is an HTML Tag, not a Transformer Tag. Tag Utility Method |
![]() | Check whether or not the current Tag is nested inside a given parent Tag. The parent tag must be in the same library as the current tag. E.G. <pt:parenttag><pt:thistag/></pt:parenttag> would return true for "parenttag". Tag Utility Method |
![]() | Check to see whether or not a specified attribute is present in the HTML for this tag. This will always return true for required tags. E.G. <pt:tag pt:ptattr="test" width="10"/> would return true for ptattr, but not for width. Note: Even though the tag may be present, it may produce an error when trying to process the tag. PT Tag Attribute Method |
![]() | Check to see whether or not a specified non-pt attribute is present in the HTML for this tag. This will always return true for required tags. E.G. <pt:tag pt:ptattr="test" width="10"/> would return true for the width attribute, but not for the ptattr attribute. XML attributes are designed to let a web designer specify standard HTML attributes for a tag without the tag author having to handle them individually. PT attributes specify the logic of the tag, while non-pt attributes specify the behavior of the resulting HTML tag. This is only appropriate for tags that output a simple HTML tag. Note: Even though the tag may be present, it may produce an error when trying to process the tag. XML Tag Attribute Method |
![]() | 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 |
![]() | This method displays the HTML and Transformer Tags that are inside this tag. This method may be called zero times, once, or multiple times during the lifecycle of a tag. Tags that call this method multiple times should return TagType.LOOPING from the GetTagType method. Tags that never call this method should return TagType.NO_BODY from the GetTagType method. Tag Utility Method |
![]() | 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 |
![]() | 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. Tag methods will not be functional during execution of this method (E.G. tag.GetEnvironment, etc... will not work). Default Tag Method |
![]() | Sets a variable in memory in the appropriate scope. The scope determines who can see this variable and how long it stays in memory. For instance, a variable stored in Tag Scope can only be seen by children of the current tag and will be removed from memory when the tag is finished. A variable stored in Portlet Request Scope will be visible to all tags in the same portlet as the current tag, and will be removed from memory when the portlet is finished displaying. Tags in other portlets on the same page will not be able to see the variable. Shared variables (as opposed to standard variables) can be accessed by tags from any library. If bOwnerEditOnly is set to true when a shared variable is first stored, then any tag can read the variable, but only tags from the same library as the tag that originally stored the variable can edit it (and replace the value in memory). Note: Displaying an HTMLElement in a tag and then caching it so that another tag can add more HTML to the original tag later is not supported. HTMLElement trees can be generated and stored for later use, as long as they are self-contained trees and used in a read only way. It is safest to make clones of a cached HTMLElement tree before trying to display it again to make sure there are no threading problems. Tag State Variable Method |
![]() | Sets a variable in memory in the appropriate scope. The scope determines who can see this variable and how long it stays in memory. For instance, a variable stored in Tag Scope can only be seen by children of the current tag and will be removed from memory when the tag is finished. A variable stored in Portlet Request Scope will be visible to all tags in the same portlet as the current tag, and will be removed from memory when the portlet is finished displaying. Tags in other portlets on the same page will not be able to see the variable. Standard variables (as opposed to shared variables) can only be accessed by tags from the same tag library as the tag that originally stored the variable. Note: Displaying an HTMLElement in a tag and then caching it so that another tag can add more HTML to the original tag later is not supported. HTMLElement trees can be generated and stored for later use, as long as they are self-contained trees and used in a read only way. It is safest to make clones of a cached HTMLElement tree before trying to display it again to make sure there are no threading problems. Tag State Variable Method |
![]() | 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 |
![]() | This method is used to verify whether or not this tag supports the passed in access style. By default we only support the standard access style. To support 508 access, the tag must be certified as not containing any javascript (onClick, etc...) If a tag does not support the current access style, an HTML comment saying that will be displayed in its place. Default Tag Method |
![]() | Returns a String that represents the current Object. |
![]() |
Initializes a new instance of the ATag class. |
![]() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
![]() | Creates a shallow copy of the current Object. |
ATag Class | com.plumtree.portaluiinfrastructure.tags Namespace | AttributeType | ITagMetaData | TagMetaData | RequiredTagAttribute | OptionalTagAttribute | RequiredParentTag | RequiredChildTag | RelatedChildTag | ITagState