Class EnsPortal.Template.listPage

abstract class EnsPortal.Template.listPage extends EnsPortal.Template.standardPage

This is for simple list pages that consist of only a ribbon and a table

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	3	19	1

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
aux	backgroundTimerInterval	canEdit	canViewFileSystem
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	keepAliveInterval
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	limitPopups
msgNotPermitted	msgSelectItemToExport	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
pageModified	parent	searchKey	showLabel
showRefresh	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%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	%GetPageName	%GetParameter	%GetProductName
%GetRootLink	%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	CheckContextLinks	CheckEnterpriseManager	ConvertParameter
Decrypt	DoLogout	DrawLocator	DrawRibbon
DrawTitle	Encrypt	EnumerateClose	EnumerateExecute
EnumerateFetch	EscapeHTML	EscapeURL	EvalResult
Export	FileExists	GetCSPURL	GetContextLinks
GetDefaultDir	GetDefaultFile	GetDocURL	GetHomePage
GetHyperEventResources	GetNewURL	GetQuickLinks	HyperEventCall
HyperEventHead	Import	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	SetDefaultDir	ShowError	SimpleKeepAlive
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
addPopupSuffix	arrowClick	cancelPopup	changePassword
changeRefresh	changeURLNamespace	checkEdit	childrenMutated
clientKeepAlive	correctIELayering	createComponent	createComponentNS
createTimeWarning	deleteComponent	disableCommandButton	displayCountDown
doExport	doImport	doRefresh	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
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	hideTimeoutWarning
hideWarnContinue	inResizeLoop	initPopupSuffix	invokeSuper
isOfType	launchPopupWindow	logout	makeId
manualKeepAlive	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	refreshTimeout	removeChild
removePopupSuffix	render	renderContents	renderSVG
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setConnectivityStatusMsg	setHidden
setModified	setOverlayMode	setPageTitle	setProperty
setPropertyAll	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	setWarnInnerHTML	showAbout
showCommandButton	showContact	showDocumentation	showHelp
showTimeoutWarning	startKeepAlive	startModal	startProgressBar
stopKeepAlive	stopProgressBar	switchNamespace	warnclickListener

Subclasses
EnsPortal.BusinessProcesses	EnsPortal.DataTransformations	EnsPortal.DefaultSettings
EnsPortal.Deployment.DeploymentHistory	EnsPortal.Jobs	EnsPortal.Productions
EnsPortal.RecordMaps	EnsPortal.Rules	EnsPortal.Setting.Report.ProductionPorts
EnsPortal.SuspendedMsg	EnsPortal.WFTasklist	EnsPortal.WFWorklist

Properties

• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup?

• property msgSelectItemToExport as %String [ InitialExpression = "Please select an item to export." ];

• property showRefresh as %Boolean [ InitialExpression = 0 ];

Does this page have refresh functionality? Note that this value is ignored when enableAutoRefresh is false.

Methods

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status

• classmethod EnumerateExecute(ByRef qHandle As %Binary, pFilter As %String = "", QueryMethod As %String, QueryClass As %String) as %Status

Override this Method to pass more arguments to the class query

• classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

• classmethod Export(Filename As %String, Classname As %String) as %String [ ZenMethod ]

• method FileExists(pFilename As %String) as %String [ ZenMethod ]

• classmethod GetDefaultDir() as %String [ ZenMethod ]

• method GetDefaultFile(table) as %String [ Language = javascript ]

Override this in order to use a different naming scheme for default filename

• classmethod Import(Filename As %String) as %String [ ZenMethod ]

• method OnDrawRibbon() as %Status

Add to the contents of the tool ribbon.

• 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. Override to include buttons.

• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]

• method changeRefresh() [ Language = javascript ]

User chose a new Auto-Refresh value for the table; set a new timeout value and start the timer

• method doExport() [ Language = javascript ]

• method doImport() [ Language = javascript ]

• method doRefresh() [ Language = javascript ]

Reload diagram with a fresh copy.

• method onlayoutHandler(load) [ Language = javascript ]

Adjust size of table on the page, so buttons don't scroll off page

• method refreshTimeout(timer) [ Language = javascript ]

If auto-refresh is still on, refresh the table and restart the timer

• method searchBoxHandler(pValue) [ Language = javascript ]

User entered something into the searchbox. Re-load the table with filter value.

Queries

• query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)

Selects

Class query with filter added. This is a wrapper around Query QueryMethod in class QueryClass. Override this in order to add rowspec specific to the list being displayed

Class Reference IRIS for UNIX 2024.1.2
Documentation Search