Class %CSP.UI.Portal.GlobalList

class %CSP.UI.Portal.GlobalList extends %CSP.UI.Template.List

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Zen page for System Management Portal - Global list

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	27

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BeginDate	ClassURL	CurrentColumn
CurrentSort	DocPage	EndDate	FILETYPE
Filter	FindPage	FirstFailed	GlobalSpec
GlobalURL	HelpAddress	ISREADONLY	InvalidParam
IsEMSReadOnly	IsEditForm	LocatorHeader	MaxRows
NAMESPACE	NamespaceList	OnclickArray	PID
ParentURL	RoutineURL	ShowGen	ShowMap
ShowSQL	ShowSys	StdTitle	TableMaxRows
TablePageSize	ValidationErrorMsg	ViewGlobalURL	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	writePERMISSION	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ChangeNS	%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
CreateRS	Decrypt	Delete	DoLogout
DrawAutoRefresh	DrawLocator	DrawRibbon	DrawSQLColumn
DrawTableHeader	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	ExecuteRS	FindDBDir
FindDBName	GetCSPURL	GetContextLinks	GetDBList
GetDocURL	GetExpandState	GetHomePage	GetLastSearch
GetList	GetNSList	GetNewURL	GetQuickLinks
GetRecentList	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
LastUpdateTime	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PrepareAction	PrepareSelection	QuoteJS	RegisterRecent
RewriteURL	SaveExpandState	SaveSelections	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateAutoRefreshRate	UpdateAutoRefreshState	UpdateTableNavState
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
adjustSizes	afterSave	afterValidate	cancelPopup
changePage	changePassword	checkURLNamespace	childrenMutated
columnSort	correctIELayering	createComponent	createComponentNS
deleteComponent	disableCommandButton	doCancel	doDelete
doDoc	doEdit	doExport	doFind
doImport	doList	doModified	doNamespace
doSearch	doSql	doView	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	enableCommandButton	endModal	exposeComponent
findElement	findNSMatch	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getPageTitle	getProperty
getSelectedNamespace	getSettings	getTime	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	keyUp	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	showExpand
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	toggleDetails	toggleSearch
trimSpace	updateTime	updateView	validateRequired
zeroFill

Parameters

• parameter AUTONS = 1;

Allow to change namespaces for this page.

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.GlobalList.zen";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter HELPADDRESS = "Home,Globals";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "GlobalList";

Displayed name of this page.

• parameter RESOURCE = "%Development";

Security requirement

Properties

• property FILETYPE as %String [ InitialExpression = "Global" ];

• property FindPage as %String;

• property GlobalSpec as %String [ InitialExpression = "*" ];

• property NAMESPACE as %String(ZENURL="$NAMESPACE");

• property ShowSQL as %Boolean(ZENURL="SQL");

• property ViewGlobalURL as %String;

• property writePERMISSION as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.GetGlobalPermission($namespace) [ "WRITE" ];

Methods

• method %OnAfterCreatePage() as %Status

Subclass to override. Always include code in this method.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method CreateRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet

pInfo holds details on how to create the query.

• classmethod Delete(filetype) as %String [ ZenMethod ]

Delete selected globals now.

• method DrawSQLColumn(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status

• method DrawTableHeader(pSeed As %String) as %Status

Draw the contents of the Table Header (the region between the diagram and the table).

• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean

Method for executing the global query.

• method GetLastSearch() as %String

• classmethod GetList() as %String [ ZenMethod ]

Return Namespace list for UI's valueList.

• method OnDrawRibbon() as %Status

This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.
To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.
To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• classmethod PrepareSelection(pFILETYPE, pSelectedRows) as %String [ ZenMethod ]

Pad selected items into string delimited by "^" before calling PrepareAction.

• method changePage(newPage) [ Language = javascript ]

• method doDelete() [ Language = javascript ]

• method doEdit(globalName) [ Language = javascript ]

• method doExport() [ Language = javascript ]

• method doFind(isReplace) [ Language = javascript ]

Open up the Find/Replace CSP page.

• method doImport() [ Language = javascript ]

• method doList(nd) [ Language = javascript ]

Load Nemespace list or Database list

• method doNamespace(selTypeChanged) [ Language = javascript ]

Changed Namespace <==> Database (implied namespace).

• method doSearch() [ Language = javascript ]

User clicked Go to start search.

• method doSql() [ Language = javascript ]

• method doView(globalName) [ Language = javascript ]

• method keyUp(zenEvent) [ Language = javascript ]

Check if user hit [Enter].

• 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 onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method updateView() [ Language = javascript ]

Update / Reload table. This overrides the one in Template.List.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search