Home > Class Reference > ENSLIB namespace > EnsPortal.Template.listPage

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

Properties

property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup?
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property msgSelectItemToExport as %String [ InitialExpression = "Please select an item to export." ];
Property methods: msgSelectItemToExportDisplayToLogical(), msgSelectItemToExportGet(), msgSelectItemToExportIsValid(), msgSelectItemToExportLogicalToDisplay(), msgSelectItemToExportLogicalToOdbc(), msgSelectItemToExportNormalize(), msgSelectItemToExportSet()
property showRefresh as %Boolean [ InitialExpression = 0 ];
Does this page have refresh functionality? Note that this value is ignored when enableAutoRefresh is false.
Property methods: showRefreshDisplayToLogical(), showRefreshGet(), showRefreshIsValid(), showRefreshLogicalToDisplay(), showRefreshLogicalToXSD(), showRefreshNormalize(), showRefreshSet(), showRefreshXSDToLogical()

Methods

method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod EnumerateExecute(ByRef qHandle As %Binary, pFilter As %String = "", QueryMethod As %String, QueryClass As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
classmethod Export(Filename As %String, Classname As %String) as %String [ Language = objectscript, ZenMethod ]
method FileExists(pFilename As %String) as %String [ Language = objectscript, ZenMethod ]
classmethod GetDefaultDir() as %String [ Language = objectscript, ZenMethod ]
clientmethod 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 [ Language = objectscript, ZenMethod ]
method OnDrawRibbon() as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar. Override to include buttons.
classmethod SetDefaultDir(pPathname As %String) [ Language = objectscript, ZenMethod ]
clientmethod changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value for the table; set a new timeout value and start the timer
clientmethod doExport() [ Language = javascript ]
clientmethod doImport() [ Language = javascript ]
clientmethod doRefresh() [ Language = javascript ]
Reload diagram with a fresh copy.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust size of table on the page, so buttons don't scroll off page
clientmethod refreshTimeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh the table and restart the timer
clientmethod searchBoxHandler(pValue) [ Language = javascript ]
User entered something into the searchbox. Re-load the table with filter value.

Inherited Methods

%AddCSPShareHyperevents() %RemoveComponent() enableCommandButton()
%AddChild() %RemoveFromSaveSet() endModal()
%AddChildAfter() %RunBackgroundMethod() exposeComponent()
%AddChildBefore() %Self() findElement()
%AddComponent() %SerializeObject() fireOnResizeEvent()
%AddEnsExceptionHandler() %SetBackgroundMethodStatus() fireOnUnloadEvent()
%AddImportedComponents() %SetErrorById() fireOnUpdateEvent()
%AddLocatorLinks() %SetErrorByName() firePopupAction()
%AddToSaveSet() %SetModified() getChildIndex()
%ApplyURLParms() %SetValueById() getComponent()
%Attr() %SetValueByName() getComponentById()
%BindExport() %SetValuesByName() getEnclosingDiv()
%ClassIsLatestVersion() %StartScript() getHidden()
%ClassName() %ValidateObject() getHintElement()
%ConstructClone() %ZENVersion() getLabelElement()
%DispatchClassMethod() BuildMenu() getOpener()
%DispatchGetModified() CheckAllBlanks() getPageTitle()
%DispatchGetProperty() CheckContextLinks() getProperty()
%DispatchMethod() CheckEnterpriseManager() getSettings()
%DispatchSetModified() ConvertParameter() getTitleAreaHeight()
%DispatchSetMultidimProperty() Decrypt() getType()
%DispatchSetProperty() DoLogout() goHome()
%DrawAutoLogout() DrawLocator() goMenu()
%DrawClassDefinitions() DrawRibbon() gotoNamespace()
%DrawComponentHTML() DrawTitle() gotoPage()
%DrawHTML() Encrypt() hideCommandButton()
%DrawHTMLPage() EscapeHTML() inResizeLoop()
%DrawJSStrings() EscapeURL() initPopupSuffix()
%DrawObjectDefinitions() EvalResult() invokeSuper()
%EnclosingDivId() GetCSPURL() isOfType()
%EndBackgroundMethod() GetContextLinks() launchPopupWindow()
%EndScript() GetDocURL() logout()
%Eval() GetHomePage() makeId()
%EvalC() GetHyperEventResources() navigate()
%Extends() GetNewURL() onCreate()
%ForceClientRender() GetQuickLinks() onDelete()
%GetChildIndex() HyperEventCall() onDisplayHandler()
%GetComponent() HyperEventHead() onEndModalHandler()
%GetComponentById() Include() onPopupAction()
%GetComponentByName() InsertHiddenField() onRefreshContents()
%GetEventHandlers() InsertHiddenFields() onSerialize()
%GetHomePage() IsPrivate() onServerMethodCall()
%GetHomeParam() Link() onServerMethodError()
%GetLinks() OnHTTPHeader() onServerMethodReturn()
%GetLocatorLinks() OnPage() onStartModalHandler()
%GetPageName() OnPageError() ondisabledHandler()
%GetParameter() OnPostHTTP() onkeydownHandler()
%GetProductName() OnPostHyperEvent() onkeyupHandler()
%GetRootLink() OnPreHTTP() onloadHandler()
%GetValueById() OnPreHyperEvent() onlogoutHandler()
%GetValueByName() Page() onoverlayHandler()
%GetXMLName() QuoteJS() onresizeHandler()
%IsA() RegisterRecent() onunloadHandler()
%IsModified() RewriteURL() onupdateHandler()
%Link() ShowError() popupActionHandler()
%LinkCSS() SimpleKeepAlive() refreshContents()
%LinkScript() StartTimer() removeChild()
%MakeId() StopTimer() removePopupSuffix()
%New() ThrowError() render()
%NormalizeObject() UnescapeHTML() renderContents()
%ObjectModified() UnescapeURL() renderSVG()
%OnAddToPageAfter() XMLDTD() searchBlur()
%OnAddToPageBefore() XMLExport() searchFocus()
%OnAfterCreatePage() XMLExportToStream() searchKeyDown()
%OnBeforeCreatePage() XMLExportToString() searchKeyPress()
%OnCreateApplication() XMLNew() setComponentId()
%OnCreatePage() XMLSchema() setConnectivityStatusMsg()
%OnDetermineCSSLevel() XMLSchemaNamespace() setHidden()
%OnDrawEnclosingDiv() XMLSchemaType() setModified()
%OnDrawHTMLBody() addChild() setOverlayMode()
%OnDrawHTMLHead() addChildAfter() setPageTitle()
%OnDrawHTMLMeta() addChildBefore() setProperty()
%OnDrawObjectProperties() addPopupSuffix() setPropertyAll()
%OnFinishBackgroundTask() arrowClick() setSortMode()
%OnGetPageName() cancelPopup() setSortModeHandler()
%OnGetProductName() changePassword() setTraceOption()
%OnGetSmallMenu() changeURLNamespace() setViewMode()
%OnMonitorBackgroundTask() checkEdit() setViewModeHandler()
%OnMutateChildren() childrenMutated() showAbout()
%OnObjectSynch() clientKeepAlive() showCommandButton()
%OnPreHTTP() correctIELayering() showContact()
%OnSubmit() createComponent() showDocumentation()
%OnUseSoftModals() createComponentNS() showHelp()
%OnZENDeserialize() deleteComponent() startKeepAlive()
%OriginalNamespace() disableCommandButton() startModal()
%PackageName() dragFinishHandler() startProgressBar()
%QuoteValue() dragHandler() stopKeepAlive()
%QuoteValueL10N() dragNotifyHandler() stopProgressBar()
%Register() dragStartHandler() switchNamespace()
%RemoveChild() dropHandler()
%RemoveChildren() dropStartHandler()

Queries

query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)
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

Subclasses

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