Plumtree Portal UI  
 

PlumtreeHelpers Methods

The methods of the PlumtreeHelpers class are listed below. For a complete list of PlumtreeHelpers class members, see the PlumtreeHelpers Members topic.

Public Static Methods

CheckCurrentUserIsAdmin Checks to see whether or not the user is in the Administrators group, using cached session's list of groups.
EveryoneHasAccess Returns true if the everyone group is on the ACL for the object passed in, false otherwise
GetExecuteViaEnterJScript To execute a javascript function when you press enter in a input field, set the onkeypress attribute of the input equal to "return executeViaEnter(event)". Also include the HTMLScript returned by GetExecuteViaEnterJScript in your page. Example: myInput.SetOnKeyPress("return " + PlumtreeHelpers.STR_JS_FUNC_NAME_EXECUTE_VIA_ENTER + "(event);");
GetHTMLImageOverloaded. Helper function to retrieve an HTML image, large or small. Alt is not specified
GetNewObjectName This helper function returns a localized new object name based on a classID. It is used by the editor framework to suggest object names for newly created objects.
GetQueryFilter Returns a simple queryfilter based on three parameters
GetSpacerImage Helper function to retrieve the spacer image with specified dimensions
GetStyleSheetLinks Returns a PTStyleSheetLink. A style sheet is named "stylesheetname- language", for instance "mainstyle12-en". This function creates a valid PTStyleSheetLink by collecting the style sheet name from the user's subportal, and the user's language from the activity space, then forming a PTStyleSheetLink object from this information.
IsEditingDefaultProfileOverloaded. This method checks whether or not the current session is editing a default profile user.
IsGuestSession Determines if this is a gues session or not as part of checking basic access.
MakeCreateObjectLinkOverloaded. Makes a simple link that creates an object in the parent window - passing in the added arguments.
PBReadString Reads a String value from a property bag. Returns strDefault if the value was not found or an error occurred. Copied from ModelHelpers in PortalPages. We may want to put this and other property bag helpers into their own class, or unifying class.
SetUIError This helper function sets a UI Error with the messages specified, and optionally throws an exception. The UI Error will contain the strings specified only, but the Debug log entry will also contain the text of the exception (e.getMessage())
StaticInit Initializes global language and stylesheet settings using the given config settings. Can only be called once globally.
TrimCardLanguage Inxight languages are specified as a two character string (like "en" or "fr"), with the exception of the chinese languages which can be "zh-TW" or "zh-CN"

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
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.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

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.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

PlumtreeHelpers Class | com.plumtree.portaluiinfrastructure.statichelpers Namespace