Class %CSP.UI.Template.List

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

This class is used internally by Caché. 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.

This is the template for SMP pages with a Search pane on the left and Result pane on the right. It is primarily used by the System Explorer's Classes/Routines/Globals list pages.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	11	20

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BeginDate	ClassURL	DocPage
EndDate	GlobalURL	HelpAddress	ISREADONLY
LocatorHeader	MaxRows	NamespaceList	ParentURL
RoutineURL	ShowGen	ShowSys	StdTitle
aboutPage	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	cssLevel
currSortMode	currStep	currViewMode	disabled
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	groupClass	groupStyle
height	hidden	hint	hintClass
hintStyle	home	homePage	id
index	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	lblTitle
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
%%OIDGet	%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	%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	ConvertParameter
Decrypt	DoLogout	DrawLocator	DrawRibbon
DrawTitle	Encrypt	EscapeHTML	EscapeURL
FindDBDir	FindDBName	GetCSPURL	GetContextLinks
GetDBList	GetDocPage	GetExpandState	GetHomePage
GetNSList	GetNewURL	GetQuickLinks	GetRecentList
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PrepareAction
QuoteJS	RegisterRecent	RewriteURL	SaveExpandState
SaveSelections	ShowError	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	ZStripW
addChild	addChildAfter	addChildBefore	adjustSizes
cancelPopup	changePassword	childrenMutated	correctIELayering
createComponent	createComponentNS	deleteComponent	doDoc
doSearch	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	endModal
exposeComponent	findElement	findNSMatch	fireOnLoadEvent
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getProperty	getSelectedNamespace	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	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	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setHidden	setModified	setOverlayMode
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showDocumentation	showExpand	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
toggleDetails	toggleSearch

Subclasses
%CSP.UI.Portal.ClassList	%CSP.UI.Portal.GlobalList	%CSP.UI.Portal.Resources
%CSP.UI.Portal.RoutineList

Parameters

• parameter PAGENAME = "Template List";

Displayed name of this page.

Properties

• property BeginDate as %String;

• property ClassURL as %String;

• property DocPage as %String;

• property EndDate as %String;

• property GlobalURL as %String;

• property MaxRows as %String;

• property NamespaceList as %String;

• property RoutineURL as %String;

• property ShowGen as %Boolean [ InitialExpression = "0" ];

• property ShowSys as %Boolean [ InitialExpression = "0" ];

Methods

• classmethod %ChangeNS(pNS As %String) as %Status

Proposed change to override %ChangeNS in %ZEN.Controller For SMP Explorer, we need to override the behavior of changing Namespace so that the error reporting is more appropriate.

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Subclass to override. Always include code in this method.

• classmethod FindDBDir(DBName) as %String [ ZenMethod ]

Given a DBName, return the DBDirectory. If we cannot find it, then return the first one we can find.

• classmethod FindDBName(DBDirectory) as %String [ ZenMethod ]

Given a DBDirectory, return the DBName

• classmethod GetDBList() as %String [ ZenMethod ]

Return Database list for UI's displayList. valueList (should not be loaded into


[BASEXML] > [%CSP] > [UI] > [Template] > [List]		Private Storage