abstract class %DeepSee.UserPortal.standardPage
extends %ZEN.Component.page, %ZEN.Portal.abstractRefreshable
Base class for pages within the DeepSee user portal.
• parameter APPLICATION = "%DeepSee.UserPortal.Application";
Set this to the appropriate application class.
• parameter DOMAIN = "%DeepSee";
Set this to the correct domain.
• parameter FAVORITEICON = "portal/ISC_IRIS_icon.ico";
DeepSee favorite icon.
• parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";
URL of home page (used in links).
• parameter JSINCLUDES = "zenCSLM.js,zenESVG.js,DeepSee.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "User Portal";
Name of this page.
• parameter RESOURCE = "%DeepSee_Portal,%DeepSee_PortalEdit";
All DeepSee pages require %DeepSee_Portal USE.
• parameter WORKLIST1MODE = "html";
Starting mode for worklist 1: html or group.
• parameter WORKLIST2MODE = "html";
Starting mode for worklist 2: html or group.
• property StdTitle
as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Define the title that will be displayed within subclasses
• property aboutPage
as %ZEN.Datatype.string [ InitialExpression = ..Link("_CSP.UI.Portal.About.zen?USERPORTAL=1") ];
About page URL
• property alertId
as %ZEN.Datatype.string(ZENURL="ALERT");
ID of alert that launched this page, if any.
• property canWrite
as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify this page.
• property chartSeriesColors
as %ZEN.Datatype.string;
Chart series color list.
• property chartSeriesScheme
as %ZEN.Datatype.string;
Chart series color scheme.
• property companyLogo
as %ZEN.Datatype.string;
Local override of company logo.
• property companyName
as %ZEN.Datatype.string;
Local override of company name.
• property companyStyle
as %ZEN.Datatype.string;
Local override of company cell style.
• property homePage
as %ZEN.Datatype.string [ InitialExpression = ..#HOMEPAGE ];
URL of the Home Page.
• property isEmbedded
as %ZEN.Datatype.boolean(ZENURL="EMBED");
Convenience property. Setting this true is equivalent to
NOTITLE=1,NOBORDER=1,NOMODIFY=1,WORKLISTS=0
• property limitPopups
as %ZEN.Datatype.boolean [ InitialExpression = ##class(%CSP.Portal.Utils).%IsConnectivityPopupDisabled() ];
Set to true to suppress hyperevent error pop-ups in
the event of a connectitivity failure.
• property noBorder
as %ZEN.Datatype.boolean(ZENURL="NOBORDER");
If true, then do not display the outer border around the desktop area of this page.
• property noModify
as %ZEN.Datatype.boolean(ZENURL="NOMODIFY");
If true, then do not allow user to modify this page (this is only a convenience, it is
not enforced by privileges).
• property noTitle
as %ZEN.Datatype.boolean(ZENURL="NOTITLE");
If true, then do not display the title area of this page.
• property searchKey
as %ZEN.Datatype.string;
Current search key.
• property urlWorklistCount
as %ZEN.Datatype.integer(ZENURL="WORKLISTS");
If set override the worklist count (number of worklist boxes on side of page). This
can be 0,1, or 2.
• property useClientEmail
as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, send e-mail using client-side mailto application.
• property viewerURL
as %ZEN.Datatype.uri;
URL of viewer page.
• property worklistCount
as %ZEN.Datatype.integer(MAXVAL=2,MINVAL=0) [ InitialExpression = 2 ];
Number of worklist panels to display: 0,1,or 2.
• final classmethod %DrawWorklist(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List)
as %Status
Draw the contents of a worklist panel within the user portal.
pMode indicates the type of contents to display (which item in the options list).
pPanelId is the id of the html component displaying the panel.
pPanelNo is the worklist number.
pOptions is a list of the available options:
pOptions(n) = $LB(name,type,class)
• final classmethod %DrawWorklistHeader(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List)
as %Status
Draw the contents of a worklist panel within the user portal.
pMode indicates the type of contents to display.
pPanelId is the id of the html component displaying the panel.
pPanelNo is the worklist number.
pOptions is a list of the available options:
pOptions(n) = $LB(name,type,class)
• method %OnAfterCreatePage()
as %Status
Decorate the page.
• method %OnDrawHTMLHead()
as %Status
Add include files to support color schemes.
• method %OnDrawHTMLMeta()
as %Status
This callback is called at the start of the HTML HEAD section of the page (just after the title).
It allows a page to write out meta tags, if desired.
The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back
into Compatibility Mode when we are returning an HTML5 page (i.e. cssLevel is set to 3).
• method %OnGetPageName()
as %String
Get the (localized) name of the page.
This should be implemented in a subclass.
• method %OnGetSmallMenu(Output pMenu)
Get the contents of the small menu in the title area.
• method %OnGetTitle()
as %String
Get the (localized) title string for the page.
This should be implemented in a subclass.
• method %OnGetWorklistOptions1(Output pOptions, Output pDefaultMode)
as %Status
Return list of options for work list 1.
• method %OnGetWorklistOptions2(Output pOptions, Output pDefaultMode)
as %Status
Return list of options for work list 2.
• classmethod AddFavorite(pName As %String)
as %Boolean
[ ZenMethod ]
• classmethod DoLogout()
as %Boolean
[ ZenMethod ]
• method DrawTitle(pSeed As %String)
as %Status
Draw the contents of the title area.
Dispatch to application class.
• method DrawWorklist1(pSeed As %String)
as %Status
Draw the contents of the worklist 1.
• method DrawWorklist2(pSeed As %String)
as %Status
Draw the contents of the worklist 2.
• method DrawWorklistHeader1(pSeed As %String)
as %Status
Draw the header for worklist 1.
• method DrawWorklistHeader2(pSeed As %String)
as %Status
Draw the the header for worklist 2.
• method DrawWorklistTitle(pSeed As %String)
as %Status
Draw the contents of the worklist title area.
• classmethod GetQuickLinks(Output pLinks)
as %Status
Define any quick links for the page
• classmethod RemoveAlert(pAlertId As %String)
as %Boolean
[ ZenMethod ]
• classmethod RemoveFavorite(pName As %String)
as %Boolean
[ ZenMethod ]
• classmethod RemoveRecentItem(pName As %String)
as %Boolean
[ ZenMethod ]
• method SendItemToTrash(pName As %String)
as %String
[ ZenMethod ]
Move the given folder item to the trash folder.
• method addToFavorites(name)
[ Language = javascript ]
Add item to favorites
• method adjustSizes(load)
[ Language = javascript ]
Adjust sizes of components on the page.
• method getNavigator()
[ Language = javascript ]
Get the navigator component.
• method getTitleAreaHeight()
[ Language = javascript ]
Return the height of the title area (titleBar plus locator).
• method goHome()
[ Language = javascript ]
Go to the home page.
• method gotoAlert(url)
[ Language = javascript ]
View the given alert.
• method gotoFavorite(url)
[ Language = javascript ]
View the given favorite.
• method gotoNamespace(url)
[ Language = javascript ]
Navigate to a new namespace in the portal.
• method logout()
[ Language = javascript ]
End the current session.
• method navCloseButtonClick(key)
[ Language = javascript ]
Click on close button in navigator.
• method navDataArrange(key, swap, final)
[ Language = javascript ]
Re-arrange of a list in navigator.
• method navDataChange(key, value, final)
[ Language = javascript ]
Change of data value in navigator.
• method navExpand()
[ Language = javascript ]
Expand or contract of navigator.
• method navGetContentForLevel(level, key)
[ Language = javascript ]
Return an object describing what to display for this level within the navigator.
• method navHeaderButtonClick(key)
[ Language = javascript ]
Click on header button in navigator.
• method navPopupAction(key, value)
[ Language = javascript ]
Popup action in navigator.
• method navSelectItem(key, value, which)
[ Language = javascript ]
Select of item within the navigator.
• method navigate(url)
[ Language = javascript ]
Navigate to a new page in the portal.
• method onAdjustSizes(load, contentWidth, contentHeight)
[ Language = javascript ]
Adjust sizes of content area.
• method onPopupAction(popupName, action, value)
[ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onServerMethodError(err, errObject)
[ Language = javascript ]
Custom handler for hyperEvent handlers to be (optionally) less
intrusive if the cause of the error was an auto-refresh timer
losing commectivity with the host.
• method onlayoutHandler(load)
[ Language = javascript ]
Adjust sizes of components on the page.
• method reloadPage()
[ Language = javascript ]
Reload this page in an IE-friendly way!
• method removeFromAlerts(alertId)
[ Language = javascript ]
Remove item from alerts.
• method removeFromFavorites(name)
[ Language = javascript ]
Remove item from favorites
• method removeFromRecentList(name)
[ Language = javascript ]
Remove item from recent list.
• method sendAlert()
[ Language = javascript ]
Launch the send alert dialog.
• method sendMail(url, title)
[ Language = javascript ]
Launch the send email dialog.
• method setCompanyCell(content)
[ Language = javascript ]
Set the HTML contents of the company logo cell in the title.
If content is null, restore original content.
• method setConnectivityStatusMsg(msg)
[ Language = javascript ]
• method setPortalTitleMsg(msg)
[ Language = javascript ]
Set the contents of the small message box in the title.
• method setProperty(property, value, value2)
[ Language = javascript ]
Set the value of a named property.
• method setWorklistView(id, mode, type)
[ Language = javascript ]
Called when user updates or clicks on an icon in a worklist.
• method showAbout()
[ Language = javascript ]
Go to the home page.
• method showHelp()
[ Language = javascript ]
Show documentation.
• method toggleWorklists()
[ Language = javascript ]
Toggle display of work lists.
• method updateCompanyCell(load)
[ Language = javascript ]
Update the contents of the company cell in the title (if present) to
match the local settings of this page.
• method updateWorklistTitle()
[ Language = javascript ]
Update the title for the worklist.
• method updateWorklistType(mode)
[ Language = javascript ]
Update the all worklists showing the given type.
