Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%CSP] >  [Portal] >  [Template]
Private  Storage   

abstract class %CSP.Portal.Template extends %ZEN.Portal.standardPage, %ZEN.Portal.Utils

Template for Management Portal.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 7 13


Summary

This is a Zen Page class. It belongs to the application %CSP.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled enableAutoRefresh enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetPageName
%GetParameter %GetProductName %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocPage GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RegisterRecent RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore cancelPopup changePassword childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild render
renderContents renderSVG searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp startModal startProgressBar stopProgressBar
switchNamespace

Subclasses
%CSP.Portal.SourceControl.Dialog.Manager %CSP.UI.Portal.Template EnsPortal.Template.standardPage

Parameters

• parameter APPLICATION = "%CSP.Portal.Application";
Class name of application this page belongs to.
• parameter AUTONS = 1;
Allow pages to auto-switch namespaces if $NAMESPACE is specified
• parameter DOMAIN = "%Utility";
Domain used for localization.
• parameter PAGENAME = "Template for Management Portal";
Displayed name of this page.
• 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

• property HelpAddress as %ZEN.Datatype.string;
The help address that links to the "Help" (next to the "Logout" link) documentation
• property ISREADONLY as %Boolean [ InitialExpression = 0 ];
Indicates whether the page is read only due to EMS control.
• property LocatorHeader as %ZEN.Datatype.caption;
The text that is shown in TitlePane above the license
• property ParentURL as %String [ InitialExpression = ..Link($ZCVT(..#PARENTPAGE,"O","URL")) ];
Parent URL that Cancel and Save should return to
• property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown on page or browser tab header
• property home as %ZEN.Datatype.string(ZENURL="home");
home value to return to Home page to.
• property lblTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown between locator bar and details pane (form or table)

Methods

• method %AddLocatorLinks(pLocator As %ZEN.Component.locatorBar, pLocalize As %String, pParam As %String = "", pIsNew As %Boolean = 0)
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 %GetHomePage() as %String
This method is used by SMP to return home page. Set home to %session if not null for later use.
• method %GetHomeParam() as %String
Used to return "home" parameter for building return home links in sub-classes.
• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.
• classmethod %GetProductName() as %String
Get the product name for the page.Called from none-Zen classes in SMP.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
• classmethod EvalResult(pSC) as %String
Return tmsg. 1 means success. Otherwise error message in HTML.
• classmethod GetHomePage() as %String [ ZenMethod ]
This method allows us to get the home page URL from JavaScript.
• classmethod RegisterRecent(pTitle)
Recent item is only registered at the Home level.
• method showDocumentation(topic, anchor, url) [ Language = javascript ]


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.