Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %CSP.Util.TablePane
Private  Storage   

%CSP.Util.TablePane


class %CSP.Util.TablePane extends
Pane, %ZEN.Portal.abstractRefreshable

This class is used internally by InterSystems IRIS. 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.

An AutoPage pane that displays a table based on a class query.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 21 20


Summary


Properties
Actions Align AutoRefresh CheckboxId
CommandFormClass CommandFormObject CommandSubmitPage Commands
Conditions FrameStyle HiddenColumns ItemsPerPage
MaxColumns MaxResults Name Query
SQLQuery ShowCheckboxes ShowFilter ShowLastUpdate
ShowRowNumbers ShowSearchPage ShowZebra Sortable
Styles Text URL bgcolor
border cellpadding cellspacing enableAutoRefresh

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CreateDataSet CreateResultSet CreateTempFile DrawBODY
DrawCommandForm DrawCommands DrawHEAD DrawLastUpdate
DrawSearch DrawStatusError DrawTable ExecuteResultSet
FilterTable GenerateCode GetDescriptiveText GetItemsPerPage
ItemsPerPageUpdate LocalizeColumnName LocalizeText OnDrawFilter
OnDrawHEADTablePane OnGenerateCode PurgeTempData QuoteCOS
RefreshTable XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType

Subclasses
%CSP.UI.SQL.BrowseTablePane %CSP.UI.System.DbGlobalsPane %CSP.UI.System.ExpListPane
%CSP.UI.System.JournalPane %CSP.UI.System.ShadowPane %CSP.UI.System.TablePaneList
%CSP.Util.SQLQueryPane CSPX.EnsBPInstanceTablePane CSPX.EnsBPListTablePane
CSPX.EnsDTLListTablePane CSPX.EnsDashboardListTablePane CSPX.EnsRuleTablePane
CSPX.EnsSuspendedMsgPane CSPX.SQLQueryPane

Parameters


• parameter COLUMNDOMAIN = "%UtilityColumns";
Default localization domain used for column headers
• parameter COLUMNHELPDOMAIN = "%UtilityColumnHelp";
Default localization domain used for column headers help messages
• parameter HIDEFILTERWHENEMPTY = 1;
Do not display filter box when there are no results
• parameter RefreshRate = 11000;
Default refresh rate (in milliseconds)
• parameter SHOWSEARCHFORM = 0;
Show advanced search form
• parameter SHOWSQLINFO = 0;
Should this page display SQL Info
• parameter SHOWSTATISTICS = 0;
Should this page display timing stats
• parameter WrapLimit = 40;
Default wrap limit

Properties


• property Actions as array of %CSP.Util.Action(XMLKEYNAME="name");
An array of actions, indexed by column name in the query. These are associated with columns in a table.
If the subscript name starts with a $, then the action is displayed as an additional column in the table.
• property AutoRefresh as %Boolean [ InitialExpression = 0 ];
If true, then this table is automatically updated.
• property CheckboxId as %String(MAXLEN=128);
If set, name of column that provides unique id values for checkboxes.
• property Conditions as list of %CSP.Util.Condition;
A list of conditions; these are expressions that are evaluated to add custom colors to the table
• property HiddenColumns as %String(MAXLEN=500);
Comma-separated list of columns that should not be displayed.
• property ItemsPerPage as %Integer [ InitialExpression = 20 ];
Number of items to show per page.
• property MaxColumns as %Integer;
Max number of columns to show. (deprecated)
• property MaxResults as %Integer [ InitialExpression = 10000 ];
Max number of results to find.
• property Query as %String(MAXLEN=128);
Name of the class query that provides info for the Table.
This is a full name: e.g., "Package.Class:QueryName"
• property SQLQuery as %String(MAXLEN=512);
Optional SQL query for this table.
If present, supercedes the value in Query.
• property ShowCheckboxes as %Boolean [ InitialExpression = 0 ];
If true, then checkboxes are displayed with each row.
• property ShowFilter as %Boolean [ InitialExpression = 1 ];
If true, then display the Filter box.
• property ShowLastUpdate as %Boolean [ InitialExpression = 1 ];
Show Last Update box (if set to 0 then do not show last update box)
• property ShowRowNumbers as %Boolean [ InitialExpression = 0 ];
If true, then rows numbers are displayed.
• property ShowSearchPage as %Boolean;
Show Advanced search page (deprecated)
• property ShowZebra as %Boolean [ InitialExpression = 0 ];
If true, then rows are displayed using zebra styling.
• property Sortable as %Boolean [ InitialExpression = 1 ];
If true, then rows in the table can be sorted.
• property bgcolor as %String(MAXLEN=50);
Table background color
• property border as %Integer;
Border of table (default is 0)
• property cellpadding as %Integer;
Cellpadding (default is 0)
• property cellspacing as %Integer;
Cellspacing (default is 0)

Methods


• method CreateDataSet(ByRef pID As %String, pFileID As %String, pTempID As %String) as %Status
Runs the query and builds a temp file
• method CreateResultSet(ByRef pID As %String, ByRef pRS As %ResultSet) as %Status
This method creates the %ResultSet object that is used for the table pane.
A subclass can override this to customize the table displayed by this pane.
pID is array of page variables...
• method CreateTempFile(pFileID As %String, pTempID As %String, ByRef pID As %String, pRS As %ResultSet) as %Status
Execute a result set and create a temp file
• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
• method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• method DrawLastUpdate()
Show Last Update box
• method DrawSearch(pInstance As %CSP.Util.PageInstance) as %Status
This callback is invoked when specific or advanced search criteria is being drawn to allow insert of additional UI elements at the end of table
• classmethod DrawStatusError(tSC As %String)
Generic method to draw error message for object status code.
• method DrawTable(pInstance As PageInstance, ByRef pID As %String, pFileID As %String, pTempID As %String, pPageNo As %Integer = 1, pSort As %String = "", pDirection As %Integer = 1, pFilter As %String = "", pCBState As %String = "", ByRef pFound As %String) as %Status
Generate JavaScript to draw the table Also updates paging buttons
• method ExecuteResultSet(pRS As %ResultSet, ByRef pID As %String) as %Status
This method performs the actual execution of the ResultSet This can be overridden by subclasses
• classmethod FilterTable(pPageNo As %Integer, pTimeSlot As %Integer, pTempID As %String, pSort As %String, pDirection As %String, pFilter As %String, pPageClass As %String, pFrame As %String, pCBState As %String, pID1, pID2, pNS As %String)
Called from client to refilter the table
• method GetDescriptiveText()
Return (localized) text message displayed near top of page. Subclasses may override this.
• method GetItemsPerPage() as %Integer
Returns default items per page value.
• classmethod ItemsPerPageUpdate(pPageSize As %Integer)
Called from client to update ItemsPerPage
• classmethod LocalizeColumnName(pName As %String, Output pHelpMsg) as %String
Lookup a column name in the localization global and return localized version if present
• method OnDrawFilter(pInstance As %CSP.Util.PageInstance) as %Status
This callback is invoked when the table filter is being drawn to allow insert of additional UI elements
• method OnDrawHEADTablePane(pInstance As %CSP.Util.PageInstance) as %Status
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod PurgeTempData()
Purge all out-of-date temp data used by TablePane
• classmethod RefreshTable(pPageNo As %Integer, pTimeSlot As %Integer, pTempID As %String, pSort As %String, pDirection As %String, pFilter As %String, pAuto As %Boolean, pPageClass As %String, pFrame As %String, pCBState As %String, pID1 As %String, pID2 As %String, pNS As %String, pRate As %Integer)
Called from client to refresh the table