jsx3.gui.GridAPI
| Adopt | Fires before a record from this grid is adopted by another object. |
| After Append | Fires after the user adds a CDF record and HTML table record (TR). |
| After Edit | Fires after the user finishes an edit session and before an edit is committed. |
| After Resize | Fires after the user resizes a column of this grid. |
| After Sort | Fires after the user sorts this grid. |
| Before Append | Fires when the user adds a new CDF record and before the change is committed. |
| Before Edit | Fires when the user begins an edit session. |
| Before Resize | Fires after the user releases the mouse after resizing a column of this grid and before the resize is committed. |
| Before Sort | Fires when the user clicks on the header cell of a sortable column in this grid and before the records are sorted. |
| Ctrl Drop | Fires after the user drops a record on this grid while pressing the Ctrl key. |
| Destroy | Fires after this grid is removed from the DOM. |
| Drag | Fires when the user drags this grid. |
| Drop | Fires after the user drops a record on this grid. |
| Execute | Fires after the user double-clicks a record or presses the Enter key with focus in a record of this grid. |
| Menu | Fires after the user right-clicks this grid and before the bound context menu displays. |
| Select | Fires after cell selection has changed but only if the cell has no edit mask. |
| Spyglass | Fires after the user hovers the mouse over this grid and before the spyglass displays. |
Fires after the user double-clicks a record or presses the Enter key with focus in a record of this grid.
Context Variables
strRECORDID {
String} - the CDF jsxid of the selected record.
intCOLUMNINDEX {
int} - the index of the column that receives the execute action.
Fires after cell selection has changed but only if the cell has no edit mask.
Context Variables
strRECORDID {
String} - CDF jsxid of the selected record,
null if a deselection event.
intCOLUMNINDEX {
int} - the index of the column that receives the select action,
null if a deselection event.
Fires when the user drags this grid. Canceling this event prevents the drag from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the record to be dragged.
strRECORDID {
String} - the CDF jsxid of the record to be dragged, same as
strDRAGID.
intCOLUMNINDEX {
int} - the index of the column where the drag begins.
Fires after the user drops a record on this grid. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strRECORDID {
String} - the CDF jsxid of the record that receives the drop.
intCOLUMNINDEX {
int} - the index of the column that receives the drop.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires after the user drops a record on this grid while pressing the Ctrl key. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strRECORDID {
String} - the CDF jsxid of the record that receives the drop.
intCOLUMNINDEX {
int} - the index of the column that receives the drop.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires before a record from this grid is adopted by another object. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the record to adopt.
objTARGET {
jsx3.gui.Grid} - the object that will adopt the record(s).
bCONTROL {
boolean} -
true if control drop,
false otherwise.
Fires after the user hovers the mouse over this grid and before the spyglass displays. The event script must evaluate to the HTML content to display in the spyglass. Canceling this event prevents the spyglass from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the spied record.
intCOLUMNINDEX {
int} - the index of the column that receives the spy.
Fires after the user right-clicks this grid and before the bound context menu displays. Canceling this event prevents the menu from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
intCOLUMNINDEX {
int} - the index of the column that receives the menu action.
Return Fields
objMENU {
jsx3.gui.Menu} - use this field to override the default menu with an instance of
jsx3.gui.Menu.
Fires when the user clicks on the header cell of a sortable column in this grid and before the records are sorted. Canceling this event prevents the sort from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intCOLUMNINDEX {
int} - the index of the column just clicked.
Return Fields
intCOLUMNINDEX {
int} - use this field to sort on a column other than the one that the user clicked on.
Fires after the user sorts this grid.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intCOLUMNINDEX {
int} - the index of the column that the grid is sorted on.
Fires after the user releases the mouse after resizing a column of this grid and before the resize is committed. Canceling this event prevents the resizing from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intCOLUMNINDEX {
int} - the index of the column being resized.
Fires after the user resizes a column of this grid. Canceling this event prevents the resizing from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intCOLUMNINDEX {
int} - the index of the column being resized.
intDIFF {
int} - the pixel difference in width.
intOLDWIDTH {
int} - the old width of the column.
vntWIDTH {
int | String} - the width of the column in implied pixels or percentage.
Return Fields
vntWIDTH {
int | String} - use this field to set the resulting column width to a value other than the width at which the user released the mouse.
Fires when the user adds a new CDF record and before the change is committed.
Fires after the user adds a CDF record and HTML table record (TR).
Context Variables
objTR {
HTMLElement} - the native HTML object reference to the new element.
Fires when the user begins an edit session. Canceling this event prevents the edit mask from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
strATTRIBUTENAME {
String} - the CDF attribute name without the leading @ symbol.
intCOLUMNINDEX {
int} - the index of the affected column.
Fires after the user finishes an edit session and before an edit is committed.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
strATTRIBUTENAME {
String} - the CDF attribute name without the leading @ symbol.
strATTRIBUTEVALUE {
String} - the CDF attribute value.
objGUI {
HTMLElement} - the HTML Table cell (TD) in the view.
intCOLUMNINDEX {
int} - the index of the affected column.
Fires after this grid is removed from the DOM.
Context Variables
objPARENT {
jsx3.app.Model} - the parent of this grid before it is removed from the DOM.
Copyright © 2001-2007, TIBCO Software Inc.