Class %CSP.UI.Portal.ClassList

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

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.

Zen page for System Management Portal - Classes list

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	3	23

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	AllowSelectRow	BeginDate	ClassSpec
ClassURL	DocPage	EndDate	FILETYPE
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	Delete	DoLogout	DrawLocator
DrawRibbon	DrawTableHeader	DrawTitle	Encrypt
EscapeHTML	EscapeURL	ExecuteRS	FindDBDir
FindDBName	GetCSPURL	GetContextLinks	GetDBList
GetDocPage	GetExpandState	GetHomePage	GetLastSearch
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
allowSelectRow	cancelPopup	changePage	changePassword
childrenMutated	correctIELayering	createComponent	createComponentNS
deleteComponent	doCompile	doDelete	doDoc
doExport	doFullView	doImport	doNamespace
doSearch	doSelectRow	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
keyUp	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

Parameters

• parameter AUTONS = 1;

Allow to change namespaces for this page.

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.ClassList.cls";

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 PAGENAME = "ClassList";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.cls";

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.

• parameter RESOURCE = "%Development";

Security requirement

Properties

• property AllowSelectRow as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

• property ClassSpec as %String [ InitialExpression = "*.cls" ];

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

Methods

• 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.

• method %OnGetPageName() as %String

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

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

Delete selected classes now.

• 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 mapping query.

• method GetLastSearch() as %String

• 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.

• method allowSelectRow(flag) [ Language = javascript ]

• method changePage(newPage) [ Language = javascript ]

User clicked Routines or Globals to change page. Namespace will be carried over, not Database.

• method doCompile() [ Language = javascript ]

• method doDelete() [ Language = javascript ]

• method doDoc(className, fullView) [ Language = javascript ]

Show class documatic in short view or full view. If fullView then open full Documatic.

• method doExport() [ Language = javascript ]

• method doFullView() [ Language = javascript ]

• method doImport() [ Language = javascript ]

• method doNamespace(selTypeChanged) [ Language = javascript ]

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

• method doSearch() [ Language = javascript ]

User clicked Go to start search.

• method doSelectRow(className) [ 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 onresizeHandler() [ Language = javascript ]

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


[BASEXML] > [%CSP] > [UI] > [Portal] > [ClassList]		Private Storage