DocBook|Search
Class Reference
%CSP.UI.System.SystemPane
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [System] >  [SystemPane]
Private  Storage  

class %CSP.UI.System.SystemPane extends %CSP.Util.Pane

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.

An AutoPage pane that displays a table based on a class query. This class is used for System utilities that do not have adquate SYSTEM queries defined.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10 6


Summary

Properties
Actions Align CommandFormClass CommandFormObject
CommandSubmitPage Commands FrameStyle MaxColumns
Name Query ShowRowNumbers ShowZebra
Sortable Styles Text URL
bgcolor border cellpadding cellspacing

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject BuildSortFile DrawBODY DrawCommandForm
DrawCommands DrawHEAD DrawSearch GenerateCode
LocalizeText OnGenerateCode QuoteCOS XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType listFreespaces
listNamespace


Parameters

• parameter DOMAIN = "%Utility";
Default Localization Domain

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 MaxColumns as %Integer;
Max number of columns to show.
• 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" In this SYSTEM class the Query is used to store the function name
• property ShowRowNumbers as %Boolean [ InitialExpression = 0 ];
If true, then rows numbers are displayed.
• property ShowZebra as %Boolean [ InitialExpression = 0 ];
If true, then rows are displayed using zebra styling.
• property Sortable as %Boolean [ InitialExpression = 0 ];
If true, then rows in the table can be sorted.
• property bgcolor as %String;
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

• classmethod BuildSortFile(pRS As %ResultSet, pSortCol As %String, pMaxCols As %Integer, ByRef pCols As %String, ByRef pSortFile) as %Boolean
Sort the data within a ResultSet and place the results in a tempfile. pCol contains the names of the columns ordered by column #.
• method DrawBODY(pInstance As PageInstance) as %Status
Draw the BODY of the detail pane
• classmethod DrawSearch(ID1)
Draw table for search file (ID1 is Namespace, ID2 is search Spec)
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod listFreespaces(ByRef listRec As %String, ByRef listTH As %String) as %Integer
Return freespaces of databases This method is needed because the query would not return anything when going TablePane directly
• classmethod listNamespace(Namespace As %String, ByRef listRec As %String, ByRef listTH As %String) as %Integer
Method to return dataset of a known Namespace