This class is used internally by InterSystems IRIS. More...

Inheritance diagram for TablePane:

[legend]

Collaboration diagram for TablePane:

[legend]

Public Member Functions
_.Library.Status	CreateDataSet (_.Library.String pID, _.Library.String pFileID, _.Library.String pTempID)
	Runs the query and builds a temp file.

_.Library.Status	CreateResultSet (_.Library.String pID, _.Library.ResultSet pRS)
	This method creates the ResultSet object. More...

_.Library.Status	CreateTempFile (_.Library.String pFileID, _.Library.String pTempID, _.Library.String pID, _.Library.ResultSet pRS)
	Execute a result set and create a temp file.

_.Library.Status	DrawBODY (_.CSP.Util.PageInstance pInstance)
	Draw the BODY of the detail pane.

_.Library.Status	DrawHEAD (_.CSP.Util.PageInstance pInstance)
	Overwritten by subclasses to draw anything this pane needs for the HEAD section.

	DrawLastUpdate ()
	Show Last Update box.

_.Library.Status	DrawSearch (_.CSP.Util.PageInstance pInstance)
	This callback is invoked when specific or advanced search criteria is being drawn to. More...

_.Library.Status	DrawTable (_.CSP.Util.PageInstance pInstance, _.Library.String pID, _.Library.String pFileID, _.Library.String pTempID, _.Library.Integer pPageNo, _.Library.String pSort, _.Library.Integer pDirection, _.Library.String pFilter, _.Library.String pCBState, _.Library.String pFound)
	Generate JavaScript to draw the table. More...

_.Library.Status	ExecuteResultSet (_.Library.ResultSet pRS, _.Library.String pID)
	This method performs the actual execution of the ResultSet. More...

	GetDescriptiveText ()
	Return (localized) text message displayed near top of page. More...

_.Library.Integer	GetItemsPerPage ()
	Returns default items per page value.

_.Library.Status	OnDrawFilter (_.CSP.Util.PageInstance pInstance)
	This callback is invoked when the table filter is being drawn to. More...

_.Library.String	OnGenerateCode ()
	Subclasses override this to generate code during CSP processing.

def	__init__ (self)
	Max number of columns to show. More...

Public Member Functions inherited from Pane
_.Library.Status	DrawCommandForm (_.CSP.Util.PageInstance pInstance)
	Generic method to draw a command form for a pane.

_.Library.Status	DrawCommands (_.CSP.Util.PageInstance pInstance)
	Generic method to draw commands for a pane;. More...

_.Library.String	GenerateCode ()
	Called by CSP rules engine to generate code to construct an instance. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
	DrawStatusError (_.Library.String tSC)
	Generic method to draw error message for object status code.

	FilterTable (_.Library.Integer pPageNo, _.Library.Integer pTimeSlot, _.Library.String pTempID, _.Library.String pSort, _.Library.String pDirection, _.Library.String pFilter, _.Library.String pPageClass, _.Library.String pFrame, _.Library.String pCBState, pID1, pID2, _.Library.String pNS)
	Called from client to refilter the table.

	ItemsPerPageUpdate (_.Library.Integer pPageSize)
	Called from client to update ItemsPerPage.

_.Library.String	LocalizeColumnName (_.Library.String pName, pHelpMsg)
	Lookup a column name in the localization global and return localized. More...

	PurgeTempData ()
	Purge all out-of-date temp data used by TablePane.

	RefreshTable (_.Library.Integer pPageNo, _.Library.Integer pTimeSlot, _.Library.String pTempID, _.Library.String pSort, _.Library.String pDirection, _.Library.String pFilter, _.Library.Boolean pAuto, _.Library.String pPageClass, _.Library.String pFrame, _.Library.String pCBState, _.Library.String pID1, _.Library.String pID2, _.Library.String pNS, _.Library.Integer pRate)
	Called from client to refresh the table.

Static Public Member Functions inherited from Pane
_.Library.String	LocalizeText (_.Library.String pText, _.Library.String pDomain)
	Return the localized version of the string pText. More...

_.Library.String	QuoteCOS (_.Library.String pText)
	Return a quoted, COS version of a string.

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	Actions
	An array of actions, indexed by column name in the query. More...

	AutoRefresh
	If true, then this table is automatically updated. More...

	CheckboxId
	If set, name of column that provides unique id values for checkboxes. More...

	Conditions
	A list of conditions; these are expressions that. More...

	HiddenColumns
	Comma-separated list of columns that should not be displayed. More...

	ItemsPerPage
	Number of items to show per page. More...

	MaxColumns

	MaxResults
	Max number of results to find. More...

	Query
	Name of the class query that provides info for the Table. More...

	SQLQuery
	Optional SQL query for this table. More...

	ShowCheckboxes
	If true, then checkboxes are displayed with each row. More...

	ShowFilter
	If true, then display the Filter box. More...

	ShowLastUpdate
	Show Last Update box (if set to 0 then do not show last update box) More...

	ShowRowNumbers
	If true, then rows numbers are displayed. More...

	ShowSearchPage

	ShowZebra
	If true, then rows are displayed using zebra styling. More...

	Sortable
	If true, then rows in the table can be sorted. More...

	bgcolor
	Table background color. More...

	border
	Border of table (default is 0) More...

	cellpadding
	Cellpadding (default is 0) More...

	cellspacing
	Cellspacing (default is 0) More...

Public Attributes inherited from Pane
	Align
	Suggestion for how to align this pane; Actual implementation is up. More...

	CommandFormClass
	Name of class used to provide an option CommandForm: a form. More...

	CommandFormObject
	Used to hold the object instance for the command form. More...

	CommandSubmitPage
	Page (URL) to go to when the command form is submitted. More...

	Commands
	A list of commands; these are actions that. More...

	FrameStyle
	Optional Style Sheet for a pane; Set to "none" to supress style-sheet for a fram. More...

	Name
	Transient: name of the pane/frame this pane is being used for. More...

	Styles
	Arbitrary array of styles (name/value pairs). More...

	Text
	Test for this pane. More...

	URL
	Optional URL to display instead of this pane (for frame-pages) More...

Public Attributes inherited from abstractRefreshable
	enableAutoRefresh
	True if pages in the management portal are permitted to use auto-refresh behaviour. More...

Static Public Attributes
	COLUMNDOMAIN = None
	This class is used internally by InterSystems IRIS. More...

	COLUMNHELPDOMAIN = None
	Default localization domain used for column headers help messages.

	HIDEFILTERWHENEMPTY = None
	Do not display filter box when there are no results.

	RefreshRate = None
	Default refresh rate (in milliseconds)

	SHOWSEARCHFORM = None
	Show advanced search form.

	SHOWSQLINFO = None
	Should this page display SQL Info.

	SHOWSTATISTICS = None
	Should this page display timing stats.

	WrapLimit = None
	Default wrap limit.

Static Public Attributes inherited from Pane
	DOMAIN = None
	Default Localization Domain.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

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.

Constructor & Destructor Documentation

◆ init()

def __init__ ( self )

Max number of columns to show.

(deprecated)

Show Advanced search page (deprecated)

Reimplemented from Pane.

Reimplemented in SQLQueryPane.

Member Function Documentation

◆ CreateResultSet()

_.Library.Status CreateResultSet	(	_.Library.String	pID,
		_.Library.ResultSet	pRS
	)

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

Reimplemented in JournalPane, GlobalListPane, ExpListPane, QueryPane, and OpenPane.

◆ DrawSearch()

_.Library.Status DrawSearch ( _.CSP.Util.PageInstance pInstance )

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

◆ DrawTable()

_.Library.Status DrawTable	(	_.CSP.Util.PageInstance	pInstance,
		_.Library.String	pID,
		_.Library.String	pFileID,
		_.Library.String	pTempID,
		_.Library.Integer	pPageNo,
		_.Library.String	pSort,
		_.Library.Integer	pDirection,
		_.Library.String	pFilter,
		_.Library.String	pCBState,
		_.Library.String	pFound
	)

Generate JavaScript to draw the table.

Also updates paging buttons

◆ ExecuteResultSet()

_.Library.Status ExecuteResultSet	(	_.Library.ResultSet	pRS,
		_.Library.String	pID
	)

This method performs the actual execution of the ResultSet.

This can be overridden by subclasses

Reimplemented in TablePaneList, ShadowPane, GlobalListPane, ExpListPane, DbGlobalsPane, QueryPane, and BrowseTablePane.

◆ GetDescriptiveText()

GetDescriptiveText ( )

Return (localized) text message displayed near top of page.

Subclasses may override this.

Reimplemented in ExpListPane.

◆ LocalizeColumnName()

_.Library.String LocalizeColumnName	(	_.Library.String	pName,
			pHelpMsg
	)

static

Lookup a column name in the localization global and return localized.

version if present

Reimplemented in SQLQueryPane.

◆ OnDrawFilter()

_.Library.Status OnDrawFilter ( _.CSP.Util.PageInstance pInstance )

This callback is invoked when the table filter is being drawn to.

allow insert of additional UI elements

Member Data Documentation

◆ COLUMNDOMAIN

COLUMNDOMAIN = None

static

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.

Default localization domain used for column headers

◆ Actions

Actions

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.

◆ AutoRefresh

AutoRefresh

If true, then this table is automatically updated.

◆ CheckboxId

CheckboxId

If set, name of column that provides unique id values for checkboxes.

◆ Conditions

Conditions

A list of conditions; these are expressions that.

are evaluated to add custom colors to the table

◆ HiddenColumns

HiddenColumns

Comma-separated list of columns that should not be displayed.

◆ ItemsPerPage

ItemsPerPage

Number of items to show per page.

◆ MaxColumns

MaxColumns

Deprecated:

◆ MaxResults

MaxResults

Max number of results to find.

◆ Query

Query

Name of the class query that provides info for the Table.

This is a full name: e.g., "Package.Class:QueryName"

◆ SQLQuery

SQLQuery

Optional SQL query for this table.

If present, supercedes the value in Query.

◆ ShowCheckboxes

ShowCheckboxes

If true, then checkboxes are displayed with each row.

◆ ShowFilter

ShowFilter

If true, then display the Filter box.

◆ ShowLastUpdate

ShowLastUpdate

Show Last Update box (if set to 0 then do not show last update box)

◆ ShowRowNumbers

ShowRowNumbers

If true, then rows numbers are displayed.

◆ ShowSearchPage

ShowSearchPage

Deprecated:

◆ ShowZebra

ShowZebra

If true, then rows are displayed using zebra styling.

◆ Sortable

Sortable

If true, then rows in the table can be sorted.

◆ bgcolor

bgcolor

Table background color.

◆ border

border

Border of table (default is 0)

◆ cellpadding

cellpadding

Cellpadding (default is 0)

◆ cellspacing

cellspacing

Cellspacing (default is 0)

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes