jsx3.gui.MatrixAPI
| Adopt | Fires after a record from this matrix is adopted by another object and before the change is committed. |
| After Append | Fires after the user adds a new CDF record to the model and view using the auto record interface. |
| After Commit | Fires after the user commits an edit in this matrix. |
| After Edit | Fires after the user finishes an edit session in this matrix and before an edit is committed. |
| After Resize | Fires when the user releases the mouse button after resizing a column of this matrix. |
| After Sort | Fires after the user sorts this matrix. |
| Before Append | Fires when the user adds a new CDF record using the auto record interface and before the change is committed. |
| Before Drop | Fires continuously as the user drags the mouse over a record in this matrix during a drag-and-drop operation. |
| Before Edit | Fires when the user begins an edit session in this matrix. |
| Before Resize | Fires when the user depresses the mouse button on the resize divider of a column of this matrix. |
| Before Sort | Fires when the user clicks on the header cell of a sortable column of this matrix and before the records are sorted. |
| Change | Fires after the user changes the selected records of this matrix. |
| Ctrl Drop | Fires after the user drops a record on this matrix while pressing the Ctrl key. |
| Destroy | Fires after this matrix is removed from the DOM. |
| Drag | Fires when the user drags a record(s) of this matrix. |
| Drop | Fires after the user drops a record on this matrix. |
| Execute | Fires after the user double-clicks a record or presses the Enter key with focus in a record of this matrix. |
| Menu | Fires after the user right-clicks this matrix and before the bound context menu displays. |
| Reorder | Fires after the user reorders columns of this matrix. |
| Scroll | Fires after the user scrolls the data area of this matrix. |
| Select | Fires after the user selects a record of this matrix. |
| Spyglass | Fires after the user hovers the mouse over this matrix and before the spyglass displays. |
| Toggle | Fires when the user expands or collapses a node in this hierarchically rendered matrix. |
Fires after the user double-clicks a record or presses the Enter key with focus in a record of this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record. When more than one record is executed, this variable is set to just one of the executed records. Use
strRECORDIDS when this matrix is multi-select.
strRECORDIDS {
Array<String>} - the CDF jsxids of the selected records.
Fires after the user selects a record of this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record,
null if a deselection event.
strRECORDIDS {
Array<String>} - the CDF jsxids of the selected records.
Fires after the user changes the selected records of this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
Fires when the user drags a record(s) of this matrix. 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.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
Fires continuously as the user drags the mouse over a record in this matrix during a drag-and-drop operation. Canceling this event prevents the drop indicator from displaying.
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).
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid corresponding to the node hovered over in the view.
Fires after the user drops a record on this matrix. 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.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid of the record that receives the drop.
bINSERTBEFORE {
boolean} - whether the dropped record should be inserted before
strRECORDID. Otherwise, it is appended as a child of
strRECORDID.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires after the user drops a record on this matrix 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.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid of the record that receives the drop.
bINSERTBEFORE {
boolean} - whether the dropped record should be inserted before
strRECORDID. Otherwise, it is appended as a child of
strRECORDID.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires after a record from this matrix is adopted by another object and before the change is committed. 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.
strRECORDIDS {
Array<String>} - an array containing the jsxids of the records to adopt.
objTARGET {
jsx3.xml.CDF} - the object that will adopt the record(s).
bCONTROL {
boolean} -
true if Ctrl Drop,
false otherwise.
Fires after the user hovers the mouse over this matrix 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.
Fires after the user right-clicks this matrix 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.
Return Fields
objMENU {
jsx3.gui.Menu} - use this field to override the default menu with an instance of
jsx3.gui.Menu.
Reorderjsxafterreorder
Fires after the user reorders columns of this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intOLDINDEX {
int} - the index of the column before it is reordered.
intNEWINDEX {
int} - the index of the column after it is reordered.
Fires when the user clicks on the header cell of a sortable column of this matrix 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.
strSORTPATH {
String} - the CDF attribute that this matrix is sorted on.
strSORTTYPE {
String} - the data type assumed for the sort -
jsx3.gui.Matrix.Column.TYPE_TEXT (jsxtext="Text") or
jsx3.gui.Matrix.Column.TYPE_NUMBER (jsxtext="Numerical").
Return Fields
objCOLUMN {
jsx3.gui.Matrix.Column} - use this field to sort on a column of this matrix other than the one that the user selected.
Fires after the user sorts this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strSORTPATH {
String} - the CDF attribute that this matrix is sorted on.
strSORTTYPE {
String} - the data type assumed for the sort -
jsx3.gui.Matrix.Column.TYPE_TEXT (jsxtext="Text") or
jsx3.gui.Matrix.Column.TYPE_NUMBER (jsxtext="Numerical").
Fires when the user depresses the mouse button on the resize divider of a column of this matrix. Canceling this event prevents the column from resizing.
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 when the user releases the mouse button after resizing a column of this matrix. Canceling this event prevents the column from resizing.
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.
vntWIDTH {
int | String} - the width for 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 using the auto record interface and before the change is committed. Any modifications made to properties on objRECORD are persisted. Canceling this event prevents committing the new CDF record.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
Fires after the user adds a new CDF record to the model and view using the auto record interface.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
Fires when the user begins an edit session in this matrix. 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.
Fires after the user finishes an edit session in this matrix and before an edit is committed. Canceling this event prevents committing the edit to the CDF record.
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.
strNEWVALUE {
String} - the new value for the cell.
Return Fields
strNEWVALUE {
String} - override the new value before it is committed.
Fires after the user commits an edit in this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
strVALUE {
String} - the new value for the cell.
Fires when the user expands or collapses a node in this hierarchically rendered matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the toggled CDF record.
bOPEN {
boolean} - new open value for the CDF record.
Fires after the user scrolls the data area of this matrix.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDIRECTION {
String} - the direction of the scrolling, 'horizontal' or 'vertical'.
intPOSITION {
int} - the position of the scrollbar in implied pixels.
Fires after this matrix is removed from the DOM.
Context Variables
objPARENT {
jsx3.app.Model} - the parent of this matrix before it is removed from the DOM.
Copyright © 2001-2007, TIBCO Software Inc.