Home > Class Reference > ENSLIB namespace > CSPX.Portal.Template


abstract class CSPX.Portal.Template extends %ZEN.Component.page

Zen based template for Ensemble 2008.1

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLICATION = CSPX.Portal.Application;
Class name of application this page belongs to.
parameter AUTONS = 0;
Do Not Allow pages to auto-switch namespaces if $NAMESPACE is specified
parameter DOMAIN = Ensemble;
Domain used for localization.
parameter PAGENAME = Ensemble Portal Template;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter PARENTPAGE;
This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page. If the name ends in .cls, then the parent is assumed to be a Zen page. This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

Properties (Including Private)

property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Define the title that will be displayed within subclasses
Property methods: StdTitleDisplayToLogical(), StdTitleGet(), StdTitleIsValid(), StdTitleLogicalToDisplay(), StdTitleLogicalToOdbc(), StdTitleNormalize(), StdTitleSet()

Methods (Including Private)

Utility method. Add the locator links defined by the LOCATORINFO parameter to the given locator bar.
pLocalize is an array from calling DocLocalize for a page. (optional)
pParam contains extra parameters for the last or current page link. (optional) pIsNew is the flag indicating this page is for "Add" rather than "Edit". If it's true then we use a different locator text if defined.
classmethod %GetNamespaces(pSeed) as %Status [ Language = objectscript ]
classmethod DrawTitle(pSeed As %String) as %Status [ Language = objectscript ]
Draw HTML for the page title
Define any quick links for the page
clientmethod arrowClick(from, to) [ Language = javascript ]
*******************************************************************/// Generic Methods Used by moving one item from a listbox to another listbox. *******************************************************************/// Moving a list item from one box to the next, then remove it from the original box
clientmethod showDocumentation(topic, anchor, url) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)