%ZEN.Component.dynaGrid

class %ZEN.Component.dynaGrid extends %ZEN.Component.control, %ZEN.Component.dataView

An editable grid control.
The data and size of the grid is provided by the %ZEN.Auxiliary.dataSet associated with the grid.
The first dimension of the dataSet supplies rows, the second supplies columns. The third dimension, if present, supplies "pages" for the grid. (One page is visible at a time).

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTCOLUMNWIDTH = 100;
Default value for the columnWidth property in pixels.
parameter DEFAULTGRIDCLASS = dynaGrid;
Subclasses can set this to change default css class used for grids.
parameter DEFAULTGRIDLABEL;
Default value for the gridLabel property.
parameter DEFAULTROWLABELWIDTH = 100;
Default value for the rowLabelWidth property in pixels.
parameter DEFAULTSHOWARROWS = 0;
Default value for the showArrows property.
parameter SYSMODULE;
Do not include in "form" module.

Properties

property OnCreateDataSet as %ZEN.Datatype.delegator (FORMALSPEC = "pGrid:%ZEN.Component.dynaGrid,pDataSet:%ZEN.Auxiliary.dataSet", RETURNTYPE = "%Status");
Name of Server-side callback method to call to information for each node of this tree.
This must be the name of a server-only method in the page class that contains this component.
Property methods: OnCreateDataSetDisplayToLogical(), OnCreateDataSetGet(), OnCreateDataSetIsValid(), OnCreateDataSetLogicalToDisplay(), OnCreateDataSetLogicalToOdbc(), OnCreateDataSetNormalize(), OnCreateDataSetSet()
property borders as %ZEN.Datatype.string (VALUELIST = ",all,none") [ InitialExpression = "all" ];
Specify whether cell borders should be "all" (the default) or "none".
Property methods: bordersDisplayToLogical(), bordersGet(), bordersIsValid(), bordersLogicalToDisplay(), bordersLogicalToOdbc(), bordersNormalize(), bordersSet()
property cells as list of %ZEN.Auxiliary.gridCell (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Additional specification for cells within the grid. This allows cell-by-cell overrides of formats and styles.
Property methods: cellsBuildValueArray(), cellsCollectionToDisplay(), cellsCollectionToOdbc(), cellsDisplayToCollection(), cellsGet(), cellsGetObject(), cellsGetObjectId(), cellsGetSwizzled(), cellsIsValid(), cellsOdbcToCollection(), cellsSet(), cellsSetObject(), cellsSetObjectId()
property columnHeaderStyle as %ZEN.Datatype.style;
Additional style to apply to column headers in this grid.
Property methods: columnHeaderStyleDisplayToLogical(), columnHeaderStyleGet(), columnHeaderStyleIsValid(), columnHeaderStyleLogicalToDisplay(), columnHeaderStyleLogicalToOdbc(), columnHeaderStyleNormalize(), columnHeaderStyleSet()
property columnWidth as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTCOLUMNWIDTH ];
This is the default width (in pixels) used for columns that do not supply a width.
Property methods: columnWidthDisplayToLogical(), columnWidthGet(), columnWidthIsValid(), columnWidthLogicalToDisplay(), columnWidthLogicalToOdbc(), columnWidthNormalize(), columnWidthSet()
property columns as list of %ZEN.Auxiliary.gridColumn (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Additional specification for columns within the grid.
Property methods: columnsBuildValueArray(), columnsCollectionToDisplay(), columnsCollectionToOdbc(), columnsDisplayToCollection(), columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsValid(), columnsOdbcToCollection(), columnsSet(), columnsSetObject(), columnsSetObjectId()
property currColumn as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the column number (1-based) of the current selected cell.
Property methods: currColumnDisplayToLogical(), currColumnGet(), currColumnIsValid(), currColumnLogicalToDisplay(), currColumnLogicalToOdbc(), currColumnNormalize(), currColumnSet()
property currPage as %ZEN.Datatype.integer [ InitialExpression = 1 ];
In case of 3-dimensional dataSet, this is the current "page" (third dimension) being displayed. (1-based).
Property methods: currPageDisplayToLogical(), currPageGet(), currPageIsValid(), currPageLogicalToDisplay(), currPageLogicalToOdbc(), currPageNormalize(), currPageSet()
property currRow as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the row number (1-based) of the current selected cell.
Property methods: currRowDisplayToLogical(), currRowGet(), currRowIsValid(), currRowLogicalToDisplay(), currRowLogicalToOdbc(), currRowNormalize(), currRowSet()
property dataSet as %ZEN.Auxiliary.dataSet (ZENSETTING = 0);
Data displayed by this grid control.
Property methods: dataSetGet(), dataSetGetSwizzled(), dataSetIsValid(), dataSetNewObject(), dataSetSet()
property editLabels as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, the user can double-click on row and column labels and edit their value.
Property methods: editLabelsDisplayToLogical(), editLabelsGet(), editLabelsIsValid(), editLabelsLogicalToDisplay(), editLabelsLogicalToOdbc(), editLabelsLogicalToXSD(), editLabelsNormalize(), editLabelsSet(), editLabelsXSDToLogical()
property format as %ZEN.Datatype.string;
Default format to apply to cells in this grid.
This is a DeepSee format string: e.g., "###.##" This is overridden by row and column-level formatting.
Property methods: formatDisplayToLogical(), formatGet(), formatIsValid(), formatLogicalToDisplay(), formatLogicalToOdbc(), formatNormalize(), formatSet(), formatValue()
property gridClass as %ZEN.Datatype.cssClass [ InitialExpression = ..#DEFAULTGRIDCLASS ];
Optional CSS class for the table containing the grid.
Property methods: gridClassDisplayToLogical(), gridClassGet(), gridClassIsValid(), gridClassLogicalToDisplay(), gridClassLogicalToOdbc(), gridClassNormalize(), gridClassSet()
property gridLabel as %ZEN.Datatype.caption [ InitialExpression = ..#DEFAULTGRIDLABEL ];
Caption to display in upper, left label cell.
Property methods: gridLabelDisplayToLogical(), gridLabelGet(), gridLabelHandler(), gridLabelIsValid(), gridLabelLogicalToDisplay(), gridLabelLogicalToOdbc(), gridLabelNormalize(), gridLabelSet()
property multiSelect as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, users can select a range of cells in the grid.
Property methods: multiSelectDisplayToLogical(), multiSelectGet(), multiSelectIsValid(), multiSelectLogicalToDisplay(), multiSelectLogicalToOdbc(), multiSelectLogicalToXSD(), multiSelectNormalize(), multiSelectSet(), multiSelectXSDToLogical()
property nowrap as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true (the default), then the contents of cells within the grid will not word wrap (by setting the nowrap attribute for the cell's td element).
Property methods: nowrapDisplayToLogical(), nowrapGet(), nowrapIsValid(), nowrapLogicalToDisplay(), nowrapLogicalToOdbc(), nowrapLogicalToXSD(), nowrapNormalize(), nowrapSet(), nowrapXSDToLogical()
property onarrowclick as %ZEN.Datatype.eventHandler;
onarrowclick event handler: If defined, this event is fired when the user clicks on a row or column arrow. The variable which will indicate which arrow is clicked.
Property methods: onarrowclickDisplayToLogical(), onarrowclickGet(), onarrowclickIsValid(), onarrowclickLogicalToDisplay(), onarrowclickLogicalToOdbc(), onarrowclickNormalize(), onarrowclickSet()
property onchangecell as %ZEN.Datatype.eventHandler;
onchangecell event handler: If defined, this event is fired when the user changes the value of a cell.
Property methods: onchangecellDisplayToLogical(), onchangecellGet(), onchangecellIsValid(), onchangecellLogicalToDisplay(), onchangecellLogicalToOdbc(), onchangecellNormalize(), onchangecellSet()
property onchangepage as %ZEN.Datatype.eventHandler;
onchangepage event handler: If defined, this event is fired when the user clicks on the next or previous page buttons for a 3D grid. If this callback returns false, the page change will not happen.
Property methods: onchangepageDisplayToLogical(), onchangepageGet(), onchangepageIsValid(), onchangepageLogicalToDisplay(), onchangepageLogicalToOdbc(), onchangepageNormalize(), onchangepageSet()
property onclickcolumn as %ZEN.Datatype.eventHandler;
onclickcolumn event handler: If defined, this event is fired when the user clicks on a column label.
Property methods: onclickcolumnDisplayToLogical(), onclickcolumnGet(), onclickcolumnIsValid(), onclickcolumnLogicalToDisplay(), onclickcolumnLogicalToOdbc(), onclickcolumnNormalize(), onclickcolumnSet()
property onclicklabel as %ZEN.Datatype.eventHandler;
onclicklabel event handler: If defined, this event is fired when the user clicks on grid label cell in the upper left.
Property methods: onclicklabelDisplayToLogical(), onclicklabelGet(), onclicklabelIsValid(), onclicklabelLogicalToDisplay(), onclicklabelLogicalToOdbc(), onclicklabelNormalize(), onclicklabelSet()
property onclickrow as %ZEN.Datatype.eventHandler;
onclickrow event handler: If defined, this event is fired when the user clicks on a row label.
Property methods: onclickrowDisplayToLogical(), onclickrowGet(), onclickrowIsValid(), onclickrowLogicalToDisplay(), onclickrowLogicalToOdbc(), onclickrowNormalize(), onclickrowSet()
property ondblclick as %ZEN.Datatype.eventHandler;
ondblclick event handler: This event is fired when the mouse is double-clicked on the control.
Property methods: ondblclickDisplayToLogical(), ondblclickGet(), ondblclickIsValid(), ondblclickLogicalToDisplay(), ondblclickLogicalToOdbc(), ondblclickNormalize(), ondblclickSet()
property ondrawcell as %ZEN.Datatype.eventHandler;
ondrawcell event handler: If defined, this event is fired when a cell is about to be drawn. If this event handler returns a value, then it is used as DHTML to render the cell contents.
Property methods: ondrawcellDisplayToLogical(), ondrawcellGet(), ondrawcellIsValid(), ondrawcellLogicalToDisplay(), ondrawcellLogicalToOdbc(), ondrawcellNormalize(), ondrawcellSet()
property oneditcell as %ZEN.Datatype.eventHandler;
oneditcell event handler: If defined, this event is fired when a cell is about to be edited. If this event handler returns a value, then it is used as DHTML to render the cell editor.
Property methods: oneditcellDisplayToLogical(), oneditcellGet(), oneditcellIsValid(), oneditcellLogicalToDisplay(), oneditcellLogicalToOdbc(), oneditcellNormalize(), oneditcellSet()
property oneditkeydown as %ZEN.Datatype.eventHandler;
onkeydown event handler for default cell edit control.
Property methods: oneditkeydownDisplayToLogical(), oneditkeydownGet(), oneditkeydownIsValid(), oneditkeydownLogicalToDisplay(), oneditkeydownLogicalToOdbc(), oneditkeydownNormalize(), oneditkeydownSet()
property oneditkeyup as %ZEN.Datatype.eventHandler;
onkeyup event handler for default cell edit control.
Property methods: oneditkeyupDisplayToLogical(), oneditkeyupGet(), oneditkeyupIsValid(), oneditkeyupLogicalToDisplay(), oneditkeyupLogicalToOdbc(), oneditkeyupNormalize(), oneditkeyupSet()
property ongetcellvalue as %ZEN.Datatype.eventHandler;
ongetcellvalue event handler: If defined, this event is fired to get the value to display in the current cell.
The current cell row and column number is updated before this call is made.
The event handler is passed 3 variables, row and col, which contain the row and column number of the current cell (1-based); and data, which is the value for the cell provided by the grid's data set.
If not defined or if this event return handler returns null, then the value from the grid's data set is used.
This callback is also invoked when the value of a cell is directly set by the setCellValue() method.
This is different than the ondrawcell event, which returns the actual HTML to display within a cell.
Property methods: ongetcellvalueDisplayToLogical(), ongetcellvalueGet(), ongetcellvalueIsValid(), ongetcellvalueLogicalToDisplay(), ongetcellvalueLogicalToOdbc(), ongetcellvalueNormalize(), ongetcellvalueSet()
property onrender as %ZEN.Datatype.eventHandler;
onrender event handler: If defined, this event is fired just before the grid is rendered.
Property methods: onrenderDisplayToLogical(), onrenderGet(), onrenderIsValid(), onrenderLogicalToDisplay(), onrenderLogicalToOdbc(), onrenderNormalize(), onrenderSet()
property onselectcell as %ZEN.Datatype.eventHandler;
onselectcell event handler: If defined, this event is fired when the user navigates to a new cell.
The current cell row and column number is updated before this call is made.
The event handler is passed 2 variables, row and col, which contain the row and column number of the current cell (1-based).
Property methods: onselectcellDisplayToLogical(), onselectcellGet(), onselectcellIsValid(), onselectcellLogicalToDisplay(), onselectcellLogicalToOdbc(), onselectcellNormalize(), onselectcellSet()
property rowHeaderStyle as %ZEN.Datatype.style;
Additional style to apply to row headers in this grid.
Property methods: rowHeaderStyleDisplayToLogical(), rowHeaderStyleGet(), rowHeaderStyleIsValid(), rowHeaderStyleLogicalToDisplay(), rowHeaderStyleLogicalToOdbc(), rowHeaderStyleNormalize(), rowHeaderStyleSet()
property rowLabelWidth as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTROWLABELWIDTH ];
Width used for row labels. This may be specified as either a fixed width in pixels or as a percentage of the total space allocated for the component.
Property methods: rowLabelWidthDisplayToLogical(), rowLabelWidthGet(), rowLabelWidthIsValid(), rowLabelWidthLogicalToDisplay(), rowLabelWidthLogicalToOdbc(), rowLabelWidthNormalize(), rowLabelWidthSet()
property rows as list of %ZEN.Auxiliary.gridRow (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Additional specification for rows within the grid.
Property methods: rowsBuildValueArray(), rowsCollectionToDisplay(), rowsCollectionToOdbc(), rowsDisplayToCollection(), rowsGet(), rowsGetObject(), rowsGetObjectId(), rowsGetSwizzled(), rowsIsValid(), rowsOdbcToCollection(), rowsSet(), rowsSetObject(), rowsSetObjectId()
property scrollIntoView as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, use the zenScrollIntoView function to try and make the current cell visible.
Property methods: scrollIntoViewDisplayToLogical(), scrollIntoViewGet(), scrollIntoViewIsValid(), scrollIntoViewLogicalToDisplay(), scrollIntoViewLogicalToOdbc(), scrollIntoViewLogicalToXSD(), scrollIntoViewNormalize(), scrollIntoViewSet(), scrollIntoViewXSDToLogical()
property selectedCellBackground as %ZEN.Datatype.style [ InitialExpression = "rgb(47,98,128)" ];
Background color applied to the selected cell.
Property methods: selectedCellBackgroundDisplayToLogical(), selectedCellBackgroundGet(), selectedCellBackgroundIsValid(), selectedCellBackgroundLogicalToDisplay(), selectedCellBackgroundLogicalToOdbc(), selectedCellBackgroundNormalize(), selectedCellBackgroundSet()
property selectedCellColor as %ZEN.Datatype.style [ InitialExpression = "white" ];
Color applied to the selected cell range.
Property methods: selectedCellColorDisplayToLogical(), selectedCellColorGet(), selectedCellColorIsValid(), selectedCellColorLogicalToDisplay(), selectedCellColorLogicalToOdbc(), selectedCellColorNormalize(), selectedCellColorSet()
property selectedRange as %ZEN.Datatype.csv;
This specifies the current selected range of cells as a comma-separated list of integers. The list is of the form:
startRow,startCol,endRow,endCol
All cells numbers are 1-based.
If the range is equal to "", then no cells are selected.
This is only used if multiSelect is true.
Property methods: selectedRangeBackgroundDisplayToLogical(), selectedRangeBackgroundGet(), selectedRangeBackgroundIsValid(), selectedRangeBackgroundLogicalToDisplay(), selectedRangeBackgroundLogicalToOdbc(), selectedRangeBackgroundNormalize(), selectedRangeBackgroundSet(), selectedRangeDisplayToLogical(), selectedRangeGet(), selectedRangeIsValid(), selectedRangeLogicalToDisplay(), selectedRangeLogicalToOdbc(), selectedRangeNormalize(), selectedRangeSet()
property selectedRangeBackground as %ZEN.Datatype.style [ InitialExpression = "rgb(87,138,168)" ];
Background color applied to the selected cell range.
Property methods: selectedRangeBackgroundDisplayToLogical(), selectedRangeBackgroundGet(), selectedRangeBackgroundIsValid(), selectedRangeBackgroundLogicalToDisplay(), selectedRangeBackgroundLogicalToOdbc(), selectedRangeBackgroundNormalize(), selectedRangeBackgroundSet()
property showArrows as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTSHOWARROWS ];
Specifies whether the add rows and columns arrows should be displayed.
Property methods: showArrowsDisplayToLogical(), showArrowsGet(), showArrowsIsValid(), showArrowsLogicalToDisplay(), showArrowsLogicalToOdbc(), showArrowsLogicalToXSD(), showArrowsNormalize(), showArrowsSet(), showArrowsXSDToLogical()
property showColumnLabels as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Specifies whether column labels should be displayed.
Property methods: showColumnLabelsDisplayToLogical(), showColumnLabelsGet(), showColumnLabelsIsValid(), showColumnLabelsLogicalToDisplay(), showColumnLabelsLogicalToOdbc(), showColumnLabelsLogicalToXSD(), showColumnLabelsNormalize(), showColumnLabelsSet(), showColumnLabelsXSDToLogical()
property showRowLabels as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Specifies whether row labels should be displayed.
Property methods: showRowLabelsDisplayToLogical(), showRowLabelsGet(), showRowLabelsIsValid(), showRowLabelsLogicalToDisplay(), showRowLabelsLogicalToOdbc(), showRowLabelsLogicalToXSD(), showRowLabelsNormalize(), showRowLabelsSet(), showRowLabelsXSDToLogical()
property showZebra as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Specify whether zebra striping should be applied to the grid.
Property methods: showZebraDisplayToLogical(), showZebraGet(), showZebraIsValid(), showZebraLogicalToDisplay(), showZebraLogicalToOdbc(), showZebraLogicalToXSD(), showZebraNormalize(), showZebraSet(), showZebraXSDToLogical()
property style as %ZEN.Datatype.style;
Additional style to apply to cells in this grid.
This is applied before any row and column-level styles.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()

Methods

method %ApplyDefaultLabels() [ Language = objectscript ]
Applies the row and column labels defined by the rows and columns collections.
method %CreateDataSet() as %Status [ Language = objectscript ]
This callback provides a way to fill in the dataSet object used to provide values for this grid.
method %OnAddToPageAfter() as %Status [ Language = objectscript ]
If implemented, this callback method is called at page render-time when this component is added to a page.
private method %OnNew(initvalue As %RawString) as %Status [ Language = objectscript ]
Inherited description: Constructor for Zen objects.
If subclasses override %OnNew, they should make sure to invoke this using #super.
method %SetDefaultValues() [ Language = objectscript ]
This method fills in reasonable default values for this control. Used by tools (such as Control Tester) to dynamically create controls.
clientmethod adjustSizes() [ Language = javascript ]
Adjust the column sizes of this grid.
clientmethod cellClickHandler(row, col, evt) [ Language = javascript ]
User has clicked on a cell.
clientmethod cellDblClickHandler(row, col, evt) [ Language = javascript ]
User has dbl-clicked on a cell.
clientmethod cellEditKeyHandler(evt) [ Language = javascript ]
Process keys pressed within the grid's cell edit control.
clientmethod cellEditKeyUpHandler(evt) [ Language = javascript ]
Process key up event within the grid's cell edit control.
clientmethod columnLabelDblClickHandler(col) [ Language = javascript ]
User has double-clicked on a column label.
clientmethod columnLabelHandler(col) [ Language = javascript ]
User has clicked on a column label.
clientmethod editCell(defval, which) [ Language = javascript ]
Display edit control in the current cell. If defval is defined, then use it as the initial value in the editor. which indicates what type of cell is being edited: "row" (row label), "column" (column label), otherwise a data cell.
clientmethod focus() [ Language = javascript ]
Client-side method to input focus to this control.
clientmethod getCSSWidthSpec(node) [ Language = javascript ]
Get the defined width of a node as specified in the CSS
clientmethod getCellContents(data, r, c) [ Language = javascript ]
Prepares data for display within a given cell. If there is an ondrawcell() callback, it is invoked. This callback has a chance to chance the contents that will be displayed within the cell.
clientmethod getCellEditor() [ Language = javascript ]
Return the html element for the current cell editor, if there is one.
clientmethod getCellInfo(page, row, col) [ Language = javascript ]
Return the cell descriptor for the given cell (if any). (0-based).
clientmethod getCellProperty(pageno, rowno, colno, property) [ Language = javascript ]
Get the value of a property for a cell descriptor of this grid. pageno, rowno, and colno are 1-based.
clientmethod getCellValue(r, c) [ Language = javascript ]
Return value of grid cell; Row and column are 1-based.
clientmethod getColumnCount() [ Language = javascript ]
Return number of columns in this grid.
clientmethod getColumnInfo(c) [ Language = javascript ]
Return an object containing display information for column c (0-based).
clientmethod getColumnProperty(colno, property) [ Language = javascript ]
Get the value of a property for a column descriptor of this grid.
clientmethod getCurrColumn() [ Language = javascript ]
Return column number (1-based) of the most recently selected column.
clientmethod getCurrRow() [ Language = javascript ]
Return row number (1-based) of the most recently selected row.
clientmethod getDataSet() [ Language = javascript ]
Return the dataSet object associated with this grid.
clientmethod getEdgeWidth(node, margins, borders, padding) [ Language = javascript ]
Calculate the pixels needed to render the edge of a given cell, including (potentially) the space needed for the margins, borders and padding
clientmethod getEditCellHTML(r, c, value, which) [ Language = javascript ]
Return the HTML that renders the cell editor for the given cell. r and c are 1-based. If r is 0, then we are editing a column header; If c is 0, then we are editing a row header; which indicates what is being edited (see editCell).
clientmethod getPageCount() [ Language = javascript ]
Return number of "pages" in this grid.
clientmethod getRowCount() [ Language = javascript ]
Return number of rows in this grid.
clientmethod getRowInfo(r) [ Language = javascript ]
Return an object containing display information for row r (0-based).
clientmethod getRowProperty(rowno, property) [ Language = javascript ]
Get the value of a property for a row descriptor of this grid.
clientmethod getSelectedRange() [ Language = javascript ]
Return the range of selected cells or null if nothing selected. The range is returned as an array of startRow,startCol,endRow,endCol.
clientmethod gridKeyBlur() [ Language = javascript ]
Focus taken from the grid's invisible edit control.
clientmethod gridKeyDownHandler(evt) [ Language = javascript ]
Process keydown event within the grid's invisible edit control.
clientmethod gridKeyFocus() [ Language = javascript ]
Focus passed to the grid's invisible edit control.
clientmethod gridKeyPressHandler(evt) [ Language = javascript ]
Process keypress event within the grid's invisible edit control.
clientmethod gridLabelHandler() [ Language = javascript ]
User has clicked on the grid label.
clientmethod isCellEditable(r, c) [ Language = javascript ]
Return whether a given cell can be edited; Row and column are 1-based.
clientmethod isCellVisible(r, c) [ Language = javascript ]
Return whether a given cell is visible; Row and column are 1-based.
clientmethod moveToCell(dir) [ Language = javascript ]
Move to a new, editable, cell. dir is "up","down","left","right" Returns true if move was successful.
clientmethod nextPage() [ Language = javascript ]
For 3-D grid, move to the next page of the grid.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
clientmethod onCreate() [ Language = javascript ]
Initialize additional client-side values
clientmethod previousPage() [ Language = javascript ]
For 3-D grid, move to the previous page of the grid.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this component.
clientmethod rowLabelDblClickHandler(row) [ Language = javascript ]
User has double-clicked on a row label.
clientmethod rowLabelHandler(row) [ Language = javascript ]
User has clicked on a row label.
clientmethod selectCell(r, c, notify) [ Language = javascript ]
Make the specified cell the current cell.
r and c are 1-based.
If notify is true, then raise an onSelectCell event.
clientmethod selectCellHandler(r, c) [ Language = javascript ]
Notification that user is about to move to a new cell.
clientmethod selectCellRange(startRow, startCol, endRow, endCol) [ Language = javascript ]
Set the selected cell range. Addresses are 1-based.
clientmethod setCellProperty(pageno, rowno, colno, property, value) [ Language = javascript ]
Set the value of a property for a cell descriptor of this grid. pageno, rowno, and colno are 1-based.
clientmethod setCellValue(value, r, c) [ Language = javascript ]
Set the value of grid cell; Row and column are 1-based.
clientmethod setColumnProperty(colno, property, value) [ Language = javascript ]
Set the value of a property for a column descriptor of this grid.
clientmethod setLabelValue(value, which, index) [ Language = javascript ]
Set the value of grid label; index is 1-based. which is "row" or "column".
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setRowProperty(rowno, property, value) [ Language = javascript ]
Set the value of a property for a row descriptor of this grid.
clientmethod stopEditCell(cancel) [ Language = javascript ]
Stop editing of the current cell.
If cancel is true, then do not save current control value.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback