Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Utils]
Private  Storage   

abstract class %CSP.UI.Portal.Utils extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

Extend to this class for pages that use tablePane as main component and needs auto-refresh to be shown on the ribbon bar. For example, Home->Operations->Databases or Processes.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 17


Summary

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

Properties
%condition %import %includeFiles %page
%resource CurrentColumn CurrentSort Filter
FirstFailed HelpAddress ISREADONLY InvalidParam
IsEMSReadOnly IsEditForm LocatorHeader OnclickArray
PID ParentURL StdTitle TableMaxRows
TablePageSize ValidationErrorMsg aboutPage align
aux backgroundTimerInterval captionLastUpdate 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 %GetNavTableState
%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 BuildMeter CheckAllBlanks
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
DoLogout DrawAutoRefresh DrawLocator DrawRibbon
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetCSPURL GetContextLinks GetDocURL
GetHomePage GetNewURL GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate JavaInstalled LastUpdateTime Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RegisterRecent
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL UpdateAutoRefreshRate
UpdateAutoRefreshState UpdateTableNavState UpdateTableState XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore afterSave afterValidate
cancelPopup changePassword childrenMutated columnSort
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doCancel doModified 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
getTime getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
invokeSuper isButtonDisabled isOfType launchPopupWindow
logout makeId navMaxRowsChanged navPageSizeChanged
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents refreshHandler refreshkeyUp removeChild
render renderContents renderSVG resetMsg
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setRefreshMode setRefreshRate setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace trimSpace updateTime
updateView validateRequired zeroFill

Subclasses
%CSP.UI.Portal.Applications.WebList %CSP.UI.Portal.Archives %CSP.UI.Portal.BackgroundTaskError
%CSP.UI.Portal.BackgroundTaskList %CSP.UI.Portal.DatabaseDetails %CSP.UI.Portal.Databases
%CSP.UI.Portal.ECPAppServers %CSP.UI.Portal.ECPDataServers %CSP.UI.Portal.ExternalLanguageServers
%CSP.UI.Portal.InteroperabilityUsage %CSP.UI.Portal.LicenseUsage %CSP.UI.Portal.LocksView
%CSP.UI.Portal.Mirror.Monitor %CSP.UI.Portal.Namespaces %CSP.UI.Portal.OpDatabases
%CSP.UI.Portal.ProcessDetails %CSP.UI.Portal.Processes %CSP.UI.Portal.RemoteDatabases
%CSP.UI.Portal.Roles %CSP.UI.Portal.SQL.CurrentStatements %CSP.UI.Portal.SQL.Logs
%CSP.UI.Portal.Servers %CSP.UI.Portal.TaskHistory %CSP.UI.Portal.TaskHistoryId
%CSP.UI.Portal.TaskInfo %CSP.UI.Portal.TaskSchedule %CSP.UI.Portal.TasksOnDemand
%CSP.UI.Portal.Transactions %CSP.UI.Portal.WQMCategories %CSP.UI.Portal.xDBCErrorNamespaces
%CSP.UI.Portal.xDBCErrors %CSP.UI.Template.List

Parameters

• parameter PAGENAME = "Template with Auto-Refresh";
Displayed name of this page.

Properties

• property CurrentColumn as %ZEN.Datatype.string;
• property CurrentSort as %ZEN.Datatype.string [ InitialExpression = "asc" ];
• property captionLastUpdate as %ZEN.Datatype.string [ InitialExpression = $$$TextJS("Last update: ") ];

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• classmethod BuildMeter(pLabel, pProperty, pWidth, pLink, pDetails) as %CSP.Util.HTMLValueMeter
Use this method to build a meter for Dashboard. (See example for usage in %CSP.UI.Portal.ProcessDetails.cls)
• classmethod DrawAutoRefresh(pRefreshName)
***** Refresh Feature for tablePane pages in SMP *****

The following methods are used by pages that want to display Refresh on/off and allow to enter refresh rate (number of seconds.) Sub-classes may over-ride them but please do not modify them unless you take care of all pages that use them and test each page thoroughly. When used, the tablePane on your page may be refreshed at the rate you define, and will remember the state, rate, current column and sort order.

To use this feature, do the following (see %CSP.UI.Portal.OpDatabases.cls for example):

  • Class extend to %CSP.UI.Portal.Utils
  • Add the following code:

  • Use tablePane with id="table" and add event onheaderClick for column sort.

  • Add to %OnAfterCreatePage to get TableState and AutoRefreshRate set into timeout.

  • In method OnDrawRibbon, add Do ..DrawAutoRefresh(..%GetPageName())

  • Override updateView() if your class has Filter turned on for tableNavigatorBar.

This method can be called from OnDrawRibbon of your UI Zen page. Pass in the page name which should be consistent with how the temp global is saved.
• classmethod LastUpdateTime() as %String [ ZenMethod ]
• classmethod UpdateAutoRefreshRate(refreshrate As %Integer) [ ZenMethod ]
Save auto refresh rate (how many seconds user entered) to server.
• classmethod UpdateAutoRefreshState(refreshstate) [ ZenMethod ]
Save auto refresh state (Refresh on or off) ito server.
• classmethod UpdateTableState(currColumn As %String, sortOrder As %String) [ ZenMethod ]
Save current column and state to server so that when page is refreshed or reloaded the sort and state remain the same.
• method columnSort(currColumn, sortOrder) [ Language = javascript ]
User clicked a column header to sort. Save that so we can come back to it when page is refreshed.
• method getTime() [ Language = javascript ]
This method returns current date and time in $ZDT($ZU(188),3,,3) format
• method onunloadHandler() [ Language = javascript ]
***** End of Refresh Feature for tablePane ***** ********************************************************/// If Refresh Feature is turned on, then clearTimer before exist.
• method refreshHandler() [ Language = javascript ]
Table auto-refresh timer handler.
• method refreshkeyUp(evnt, value) [ Language = javascript ]
Check if user hit [Enter] on refreshRate textbox.
• method setRefreshMode(newMode) [ Language = javascript ]
Turn auto-refresh mode on and off.
• method setRefreshRate(newRate) [ Language = javascript ]
User changed refresh rate. Validate it and save value to server.
• method updateTime() [ Language = javascript ]
• method updateView() [ Language = javascript ]
Update / Reload table. Subclass may override this method. Do not modify this method unless you are going to take care of all pages that use it.
• method zeroFill(value) [ Language = javascript ]


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