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).
Inherited description: If set, this indicates that this system component should be
placed in the given "module". A module is a grouping of components
within the same class package that share common include (js or css) files.
Note that certain root classes are implicitly placed within the "core"
Classes outside of the Zen library should not set this, they should use
the MODULE instead.
If true (the default), automatically re-execute the query for this
table when the user changes the value of a column filter.
If false, the query will only be re-executed when the
executeQuery() is called.
Specifies where the data columns of the table come from.
"query" (the default)- columns are displayed for each column in the
data source query.
"columns" - only columns explicitly defined in the columns
list are displayed.
Flag for backwards compatibility.
If permitClientSQL is set to true, query parameters
site and application settings this may constitute a security risk. If set
to false (the default), the parameters may only be set on the server. This
property is encrypted and any attempt to modify it on the client will result
in an error.
Flag for less intrusive remedial action when Client-side SQL modification is forbidden.
If permitClientSQL is set to false (the default), this flag controls
the rendering of the table if client side modification of the query parameters is detected.
By default, a Zen Exception will be raised, warning of the security risk. If this flag is set
to true, however, the exception will be suppressed and the table will re-render using the last
known (server-side) values for the query parameters. In this case the client-side modifications
are simply ignored. The default value is "false" indicating that the exception should be raised.
Tests if a column type is a numeric type.
Zen uses the CLIENTDATATYPE value, not ODBCTYPE. Client types are defined as:
Returns the type of column n in the result set where type is an integer associated with
the client datatype. If the type cannot be determined, 0 (zero) is returned.
Inherited description: If implemented, this callback method is called at page render-time
after this component has been added to a page and after any of its children
have been created but before the %DrawHTML methods are called.
This method is used (server-side only) to set the refreshRequired
property when changing the underlying query from ObjectScript at
run time. Client-side code should not "wrap" and call this
Fetch data from snapshot global and package up as a client object.
pIndex is index of client component. pID is internal ID of snapshot global. pRow is row number to fetch.
Associate a navigator component with this tablePane.
This is called by the navigator component.
Appends new column object to this table with the given
column name. Returns the new column object.
Call the executeQuery() method after calling this
to update the table.
If we are in autoExecute mode, then re-execute the query
for this table using the current value of any column filters.
If we are not in autoExecute mode, then do nothing.
Disable (or enable) the column filters for this table.
Force query for this table to be executed on the server.
If the table is in snapshot mode, then a new snapshot will
If remember is true, then the table will
stay on the same page after the new results are displayed.
If sync is defined and is true, the refresh will be executed
synchronously (unless we are in deferred mode).
User has changed the value of a filter.
filterName is the name of the filter. refresh indicates if the query should be re-executed. type (optional) is type of filter. index (optional) is control index for filters with multiple controls.
User has pressed a key within a filter.
For multi-page display, go to the first page.
Client-side method to input focus to this control.
Get column filters (if there are any).
Returns an associative array containing the current
values of the filter controls indexed by column name.
Get current value of column filter associated with column cname.
For multi-page display, calculate the number of pages.
Explore the DOM and extract the data for the specified phyiscal table row
(0-based) from the rendered table data (not to be confused with
the logical row number of the data itself in a multi-page table).
correspond to the names of the columns in the table. If
showRowNumbers is true the object will also contain a property
called rowNum and will be contain the logical, enumerated row
of the result set record
This is a client-side only call and can query only the values of
the current page of the current table. The full, logical contents
of the table (in snapshot mode) resides at the server and logical
rows may be accessed using getRowData()
If there are not data columns to report or if the requested row is
greater than the page size for the table, this function returns null.
For tables in snapshot mode only.
Go to the server and fetch the data for the specified row
(0-based) from the table snapshot data. This data is packaged
names of the columns in the snapshot table.
For non-snapshot tables or out of range row numbers, returns null.
For multi-page display, go to specified page (1 is first page), if possible.
User has clicked on a column header.
For multi-page display, go to the last page.
For multi-page display, go to next page, if possible.
Inherited description: This client event, if present, is fired when a popup page has specified
this component as its parent and fires an action. popupName is the name of the popup window sending the action. action is the name of the action. value is the value associated with the action.
When the page is loaded, check for alignment issues between the table header
and the table body.
For multi-page display, go to previous page, if possible.
If giveFocus is true, then give focus back to
the hidden control.
Remove the navigator component with this tablePane.
This is called by the navigator component.
Reset the values of the column filters (if there are any).
Under IE with fixedHeaders set to true, the table headers and the body
columns may become misaligned. This routine checks for alignment issues
in the rendered table and, if needed, reformats the header to accound for
the space taken up by a vertical scrollbar in the body of the table.
Set the value of all column filters (if there are any).
state is an associative array containing the current
values of the filter controls indexed by column name (as
returned by getColumnFilters().
Set value of date filter box. index is 0 or 1 to indicate
which date box to set.
Set the value of column filter associated with column cname.
Set the value of a named property.
Show or hide columns filters (if there are any).
Users should use setProperty('showFilters',true) instead.