 | Uiinfrastructure API Docs | ||
XMLBaseVarPack Members | |||
| Uiinfrastructure API Docs | ||
XMLBaseVarPack Members | |||
  STR_COMMENT_PREFIX | The marker for XML comments |
| VALUE_ATTRIBUTE | The value attribute |
 CanReloadVarPackFromUI (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| ExpireVarPackContent (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| GetConfigPath (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| GetExpireTimeout (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| 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. |
| GetReloadInterval (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| GetValueAsBoolean | This method will return the boolean value for a named node in a section under the root XML node. |
| GetValueAsInt | This method will return the int value for a named node in a section under the root XML node. |
| GetValueAsString | This method will return the String value for a named node in a section under the root XML node. |
| GetVarPackID | This method returns the name that the VarPack should be stored under on the application. |
| GetVarPackKeys | This method will return an enumeration of the top level nodes in the XML tree that was loaded by this VarPack. This is used by the Memory Debug page to query for the contents of the VarPack. |
| GetVarPackValue (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| GetVarPackXMLFileName | This method returns the name of the XML file that this VarPack should load. This should be the full name including the ".xml" suffix. The file will be loaded from the the portal config directory (ptportal\5.0\settings\config) and should be placed there. |
| IsLoaded (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| LoadVarPack (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| OnExpireEvent (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| OnReloadEvent (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| ReloadVarPack (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| SetExpireTimeout (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| SetReloadInterval (inherited from com.plumtree.uiinfrastructure.web.BaseVarPack) | |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
XMLBaseVarPack Constructor
|
Initializes a new instance of the XMLBaseVarPack class. |
| ExpireContent | You cannot expire the XML content. You can only reload it. This method does nothing. |
| 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. |
| GetValue | This method will return the String value for a named node in a section under the root XML node. GetValueAsString, GetValueAsInt, and GetValueAsBoolean are the preferred methods of accessing the data in this VarPack, and should be used instead of this method. |
| Load | This method loads the XML file into the hashtable in memory. |
| LoadSettingsIntoXPHashtable | Helper method to load the settings from the XML file and put them in a XPHashtable. This Hashtable will be used for the Memory Debug page where we need to be able to iterate through the keys and display all the name/value pairs. This can be overridden if the XML file has a different format. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
| Reload | This method reloads the XML file into memory. It delegates to Load(). This may not be entirely threadsafe. |
XMLBaseVarPack Class | com.plumtree.uiinfrastructure.application.varpacks Namespace