Panel |
---|
|
Expand |
---|
| PySequence newRow - A sequence containing the values for the new row. The length of the sequence must match the number of columns in the table, and each value must be coercible into the correct datatype of the corresponding column. Client |
Expand |
---|
title | .deleteRow(rowIndex) |
---|
| int rowIndex - The index of the row to delete. Client |
Anchor |
---|
| table.exportCSV |
---|
| table.exportCSV |
---|
|
Expand |
---|
title | .exportCSV(filename, showHeaders) |
---|
| String filename - A suggested filename for the user. For example: "table_data.csv" boolean showHeaders - If true, include headers in CSV file. Client |
Anchor |
---|
| table.exportHTML |
---|
| table.exportHTML |
---|
|
Expand |
---|
title | .exportHTML(filename, headerName, cellSpacing) |
---|
| String filename - A suggested filename for the user. For example: "table_data.html" String headerName - A name for the HTML header. Int cellSpacing - A table width in pixels.
Client |
Expand |
---|
title | .getDataAsHTML(title, width) |
---|
| String title - The title for the HTML page. int width - The width (in pixels) for the "table" element in the resulting html page. Client |
Expand |
---|
title | .getRowsInViewOrder() |
---|
| none Client |
Expand |
---|
title | .getSelectedColumn() |
---|
| none Client |
Expand |
---|
title | .getSelectedColumnCount() |
---|
| none Client |
Expand |
---|
title | .getSelectedRowCount() |
---|
| none Client |
Expand |
---|
title | .isCellSelected(row, column) |
---|
| int row - The row to test. int column - The column to test. Client |
Expand |
---|
title | .isColumnSelected(column) |
---|
| int column- The column to test. Client |
Expand |
---|
| int row - The row to test. Client |
Expand |
---|
title | .print(fitWidth, headerFormat, footerFormat, showDialog, landscape) |
---|
| This specialized print function will paginate the table onto multiple pages.This function accepts keyword-style invocation. boolean fitWidth- If true, the table's width will be stretched to fit across one page's width. Rows will still paginate normally. If false, the table will paginate columns onto extra pages. (default = true) [optional] string headerFormat- A string to use as the table's page header. The substring "{0}" will be replaced with the current page number. (default = None) [optional] string footerFormat- A string to use as the table's page footer. The substring "{0}" will be replaced with the current page number. (default = "Page {0}") [optional] boolean showDialog- Whether or not the print dialog should be shown to the user. Default is true. [optional] boolean landscape- Used to specify portrait (0) or landscape (1) mode. Default is portrait (0). [optional] Client |
Expand |
---|
title | .setColumnLabel(column, label) |
---|
| Used to set a column's header label to a new string at runtime. int column - The column index that will get a new headel label. String label - The new header label. Client |
Expand |
---|
title | .setColumnSelectionInterval(index0, index1) |
---|
| Sets the given range of columns to be selected. If index0==index1, it will select a single column. int index0 - the first index. int index1 - the second index. Client |
Expand |
---|
title | .setColumnWidth(column, width) |
---|
| Used to set a column's width at runtime. int column - The index of the column. int width - The width to set it at in pixels. Client |
Expand |
---|
title | .setRowSelectionInterval(index0, index1) |
---|
| Sets the given range of rows to be selected. If index0==index1, it will select a single row. int index0 - The first index. int index1 - The second index. Client |
Expand |
---|
title | .setSelectedColumn(column) |
---|
| Sets the given column to be the selected column. int column - Column to select. Client |
Expand |
---|
title | .setSelectedRow(row) |
---|
| Sets the given row to be the selected row. int row - Row to select. Client |
Expand |
---|
title | .setValue(row, column, value) |
---|
| Sets the value in the specified cell, altering the table's Data property. Will fire a propertyChange event for the "data" property, as well as a cellEdited event. int row - The index of the row to set the value at. int column - The index or name of the column to set a value at. PyObject value - The new value to use at the given row/column location. Client |
Expand |
---|
title | .sortByColumn(columnName [, asc]) |
---|
| Instructs the table to sort the data by the named column. String columnName - The name of the column. boolean asc - 1 means ascending, 0 means descending. (default = 1) [optional] Client |
Expand |
---|
| Instructs the table to clear any custom sort columns and display the data as it is sorted in the underlying dataset. Client |
Expand |
---|
title | .updateRow(rowIndex, changes) |
---|
| Updates an entire row of the table's dataset. Client |
|
Panel |
---|
|
Expand |
---|
| Called for each cell, returns the appropriate background color. Do not block, sleep, or execute any I/O; called on painting thread. |
Expand |
---|
| Called for each cell, returns the appropriate foreground (text) color. Do not block, sleep, or execute any I/O; called on painting thread. |
Expand |
---|
| Called for each cell, returns a String which will be used as the text of the cell. Do not block, sleep or execute any I/O; called on the painting thread. |
|
Panel |
---|
|
Expand |
---|
|
Expand |
---|
| This event occurs when a component that can receive input, such as a text box, receives the input focus. This usually occurs when a user clicks on the component or tabs over to it. .source | The component that fired this event | .oldValue | The value that this property was before it changed. Note that not all components include an accurate oldValue in their events. | .newValue | The new value that this property changed to. | .row | The row of the dataset this cell represents. | .column | The column of the dataset this cell represents. |
|
|
Expand |
---|
|
Expand |
---|
| This event occurs when a component that can receive input, such as a text box, receives the input focus. This usually occurs when a user clicks on the component or tabs over to it. .source | The component that fired this event. | .oppositeComponent | The other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa. |
|
Expand |
---|
| This event occurs when a component that had the input focus lost it to another component. .source | The component that fired this event | .oppositeComponent | The other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa. |
|
|
Expand |
---|
|
Expand |
---|
| An integer that indicates whether the state was changed to "Selected" (on) or "Deselected" (off). Compare this to the event object's constants to determine what the new state is. .source | The component that fired this event. | .keyCode | The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants. | .keyChar | The character that was typed. Used with the keyTyped event. | .keyLocation | Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATIONconstants, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
Expand |
---|
| Fires when a key is released and the source component has the input focus. Works for all characters, including non-printable ones, such as SHIFT and F3. .source | The component that fired this event. | .keyCode | The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants. | .keyChar | The character that was typed. Used with the keyTyped event. | .keyLocation | Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATIONconstants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
Expand |
---|
| Fires when a key is pressed and then released when source component has the input focus. Only works for characters that can be printed on the screen. .source | The component that fired this event. | .keyCode | The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants. | .keyChar | The character that was typed. Used with the keyTyped event. | .keyLocation | Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATIONconstants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
|
Expand |
---|
|
Expand |
---|
| This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
Expand |
---|
title | mouseEnteredmousePressed |
---|
| This event fires when the mouse enters the space over the a mouse button is pressed down on the source component. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
Expand |
---|
title | mouseExitedmouseReleased |
---|
| This event fires when the mouse leaves the space over the source component. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
| Expand |
---|
| This event fires when a mouse button is pressed down on the source component. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
Expand |
---|
| This event fires when a mouse button is released, if that mouse button's press happened over this component. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
| Expand |
---|
| Expand |
---|
| Fires when the mouse moves over a component after a button has been pushed. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
Expand |
---|
| Fires when the mouse moves over a component, but no buttons are pushed. a mouse button is released, if that mouse button's press happened over this component. .source | The component that fired this event. | .button | The code for the button that caused this event to fire. | .clickCount | The number of mouse clicks associated with this event. | .x | The x-coordinate (with respect to the source component) of this mouse event. | .y | The y-coordinate (with respect to the source component) of this mouse event. | .popupTrigger | Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. | .altDown | True (1) if the Alt key was held down during this event, false (0) otherwise. | .controlDown | True (1) if the Control key was held down during this event, false (0) otherwise. | .shiftDown | True (1) if the Shift key was held down during this event, false (0) otherwise. |
|
|
Expand |
---|
|
Expand |
---|
| Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties. .source | The component that fired this event. | .newValue | The new value that this property changed to. | .oldValue | The value that this property was before it changed. | .propertyName | The name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change. |
|
|
|
|