This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

Property Inventory

Method Inventory

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?
Property methods: showRefreshDisplayToLogical(), showRefreshGet(), showRefreshIsValid(), showRefreshLogicalToDisplay(), showRefreshLogicalToXSD(), showRefreshNormalize(), showRefreshSet(), showRefreshXSDToLogical()

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 ]
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 [ 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 ]
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.

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

Inherited Members

Inherited Properties

Inherited Methods

Subclasses