jsx3.gui.ListAPI
| Adopt | Fires before a record from this list is adopted by another object. |
| After Append | Fires after the user adds a new 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. |
| After Sort | Fires after the user sorts this list. |
| Before Append | Fires when the user adds a new CDF record and before the change is committed. |
| Before Resize | Fires after the user releases the mouse after resizing a column of this list and before the resize is committed. |
| Before Sort | Fires when the user clicks on the header cell of a sortable column in this list and before the records are sorted. |
| Change | Fires after the user changes the selected records. |
| Ctrl Drop | Fires after the user drops a record on this list while pressing the Ctrl key. |
| Destroy | Fires after this list is removed from the DOM. |
| Drag | Fires when the user drags a record of this list. |
| Drop | Fires after the user drops a record on this list. |
| Execute | Fires after the user double-clicks a list item or presses the Enter key with focus in a record of this list. |
| Menu | Fires after the user right-clicks this list and before the bound context menu displays. |
| Select | Fires after the user selects a record. |
| Spyglass | Fires after the user hovers the mouse over this list and before the spyglass displays. |
Fires after the user double-clicks a list item or presses the Enter key with focus in a record of this list.
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 the list is multi-select.
Fires after the user selects a record.
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.
Fires after the user changes the selected records.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
Fires when the user drags a record of this list. 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 list. 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 list 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 {
String} - an array containing the CDF jsxids of the dragged records.
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 list 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.List} - 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 list 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} - CDF jsxid of the spied record
intCOLUMNINDEX {
int} - the index of the column that receives the spy action
Fires after the user right-clicks this list 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 list 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 clicked column.
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 list.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
intCOLUMNINDEX {
int} - the index of the column that this list is sorted on.
Fires after the user releases the mouse after resizing a column of this list 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. 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 for the column.
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 and before the change is committed.
Fires after the user adds a new CDF record and HTML table record (TR).
Context Variables
objTR {
HTMLElement} - the native HTML object reference to the new element.
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.
Fires after this list is removed from the DOM.
Context Variables
objPARENT {
jsx3.app.Model} - the parent of this list before it is removed from the DOM.
Copyright © 2001-2007, TIBCO Software Inc.