Class: Fox::FXTable

Attributes

anchorColumn	[R]	Column number for anchor cell [Integer]
anchorRow	[R]	Row number for anchor cell [Integer]
baseColor	[RW]	Base GUI color [FXColor]
borderColor	[RW]	Border color [FXColor]
cellBorderColor	[RW]	Cell border color [FXColor]
cellBorderWidth	[RW]	Cell border width, in pixels [Integer]
columnHeader	[R]	Column header control [FXHeader]
columnHeaderHeight	[RW]	The fixed column header height, if columnHeaderMode is `LAYOUT_FIX_HEIGHT`.
columnHeaderMode	[RW]	The column header height mode is either fixed (LAYOUT_FIX_HEIGHT) or variable. In variable height mode, the column header will size to fit the contents in it. In fixed height mode, the size is explicitly set via the columnHeaderHeight attribute.
currentColumn	[R]	Column number for current cell [Integer]
currentRow	[R]	Row number for current cell [Integer]
defColumnWidth	[RW]	Default column width, in pixels [Integer]
defRowHeight	[RW]	Default row height, in pixels [Integer]
font	[RW]	Text font [FXFont]
gridColor	[RW]	Grid color [FXColor]
helpText	[RW]	Status line help text [String]
hiliteColor	[RW]	Highlight color [FXColor]
leadingCols	[RW]	Number of leading columns [Integer]
leadingRows	[RW]	Number of leading rows [Integer]
marginBottom	[RW]	Bottom cell margin, in pixels [Integer]
marginLeft	[RW]	Left cell margin, in pixels [Integer]
marginRight	[RW]	Right cell margin, in pixels [Integer]
marginTop	[RW]	Top cell margin, in pixels [Integer]
numColumns	[R]	Number of columns [Integer]
numRows	[R]	Number of rows [Integer]
rowHeader	[R]	Row header control [FXHeader]
rowHeaderMode	[RW]	The row header width mode is either fixed (LAYOUT_FIX_WIDTH) or variable. In variable width mode, the row header will size to fit the contents in it. In fixed width mode, the size is explicitly set via the rowHeaderWidth attribute.
rowHeaderWidth	[RW]	The fixed row header width, if rowHeaderMode is `LAYOUT_FIX_WIDTH`.
selBackColor	[RW]	Background color for selected cell(s) [FXColor]
selEndColumn	[R]	Ending column number for selection, or -1 if there is no selection [Integer]
selEndRow	[R]	Ending row number for selection, or -1 if there is no selection [Integer]
selStartColumn	[R]	Starting column number for selection, or -1 if there is no selection [Integer]
selStartRow	[R]	Starting row number for selection, or -1 if there is no selection [Integer]
selTextColor	[RW]	Text color for selected cell(s) [FXColor]
shadowColor	[RW]	Shadow color [FXColor]
stippleColor	[RW]	Stipple color [FXColor]
tableStyle	[RW]	Table style [Integer]
textColor	[RW]	Text color [FXColor]
trailingCols	[RW]	Number of trailing columns [Integer]
trailingRows	[RW]	Number of trailing rows [Integer]
visibleCols	[RW]	Number of visible columns [Integer]
visibleRows	[RW]	Number of visible rows [Integer]

Public Class methods

csvType()

Returns the drag type for CSV data

csvTypeName()

Returns the drag type name for CSV data

new(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0, pl=DEFAULT_MARGIN, pr=DEFAULT_MARGIN, pt=DEFAULT_MARGIN, pb=DEFAULT_MARGIN) {|theTable| ...}

Construct a new FXTable instance. The table is initially empty, and reports a default size based on the scroll areas’s scrollbar placement policy.

Parameters:

`p`:	the parent window for this table [FXComposite]
`tgt`:	the message target (if any) for this table [FXObject]
`sel`:	the message identifier for this table [Integer]
`opts`:	table options [Integer]
`x`:	initial x-position [Integer]
`y`:	initial y-position [Integer]
`w`:	initial width [Integer]
`h`:	initial height [Integer]
`pl`:	internal padding on the left side, in pixels [Integer]
`pr`:	internal padding on the right side, in pixels [Integer]
`pt`:	internal padding on the top side, in pixels [Integer]
`pb`:	internal padding on the bottom side, in pixels [Integer]

Public Instance methods

anythingSelected?()

Return true if any cells are selected.

appendColumns(numColumns=1, notify=false)

Append numColumns columns to the right of the table.. If notify is true, a SEL_INSERTED message is sent to the tableÕs message target for each cell that is inserted.

appendRows(numRows=1, notify=false)

Append numRows rows to the bottom of the table.. If notify is true, a SEL_INSERTED message is sent to the tableÕs message target for each cell that is inserted.

clearItems(notify=false)

Remove all items from table. If notify is true, a SEL_DELETED message is sent to the table’s message target before the cells are removed.

colAtX(x)

Determine column containing x. Returns -1 if x is to the left of the first column, and numColumns if x is to the right of the last column. Otherwise, returns the column in the table containing x.

columnSelected?(c)

Return true if the specified column of cells is selected. Raises IndexError if c is out of bounds.

createItem(text, icon, data)

Create a new table item

disableItem(row, column)

Disable cell. Raises IndexError if either row or column is out of bounds.

drawCell(dc, xlo, xhi, ylo, yhi, xoff, yoff, startRow, endRow, startCol, endCol)

Draw a table cell

drawRange(dc, xlo, xhi, ylo, yhi, xoff, yoff, rlo, rhi, clo, chi)

Draw a range of cells

each(

Alias for each_row

each_column( {|itemArray| ...}

Calls block once for each column in the table, passing an array of references (one element per row) as a parameter.

each_row( {|itemArray| ...}

Calls block once for each row in the table, passing an array of references (one element per column) as a parameter.

enableItem(row, column)

Enable cell. Raises IndexError if either row or column is out of bounds.

extendSelection(row, column, notify=false)

Extend selection. If notify is true, a series of SEL_SELECTED and SEL_DESELECTED messages are sent to the table’s message target after each affected item is selected or deselected. Raises IndexError if either row or column is out of bounds.

extractText(startrow, endrow, startcol, endcol, cs='\t', rs='\n')

Extract the text from all the cells in the specified range and return the result as a string. Within the result string, each column’s text is delimited by the character specified by cs, and each row is delimited by the character specified by rs. To reverse this operation (i.e. set the table cells’ text from a string), see overlayText. Raises IndexError if any of startrow, endrow, startcol or endcol is out of bounds.

Parameters:

`startrow`:	the starting row for the range [Integer]
`endrow`:	the ending row for the range [Integer]
`startcol`:	the starting column for the range [Integer]
`endcol`:	the ending column for the range [Integer]
`cs`:	the character to insert at each column break [String]
`rs`:	the character to insert at each row break [String]

getCellColor(row, column)

Obtain cell background color. The values for row and column are either zero or one. If the value is zero, returns the background color used for even-numbered rows (columns). If the value is one, returns the background color used for odd-numbered rows (columns). See also setCellColor.

getColumnText(index)

Return text of column header at index.

getColumnWidth(column)

Get column width. Raises IndexError if column is out of bounds.

getColumnX(column)

Get x-coordinate of column. Raises IndexError if column is out of bounds.

getItem(row, column)

Return the item (a reference to an FXTableItem) at the given row and column. Raises IndexError if either row or column is out of bounds.

getItemBorders(r, c)

Return the border style for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

getItemData(row, column)

Return cell user data. Raises IndexError if either row or column is out of bounds.

getItemIcon(row, column)

Return item icon. Raises IndexError if either row or column is out of bounds.

getItemIconPosition(r, c)

Return the relative position of the icon and text for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

getItemJustify(r, c)

Return item justification for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

getItemStipple(r, c)

Return the background stipple style for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

getItemText(row, column)

Return cell text for item at specified row and column. Raises IndexError if either row or column is out of bounds.

getRowHeight(row)

Get row height. Raises IndexError if row is out of bounds.

getRowText(index)

Return text of row header at index.

getRowY(row)

Get y-coordinate of row. Raises IndexError if row is out of bounds.

horizontalGridShown=(vis)

Set visibility of horizontal grid to true or false.

horizontalGridShown?()

Return true if horizontal grid is shown.

insertColumns(column, numColumns=1, notify=false)

Insert numColumns columns beginning at the specified column number. If column is equal to the number of columns in the table, the new columns are added to the right of the table. If notify is true, a SEL_INSERTED message is sent to the table’s message target for each cell that is inserted. Raises IndexError if column is out of bounds.

insertRows(row, numRows=1, notify=false)

Insert numRows rows beginning at the specified row number. If row is equal to the number of rows in the table, the new rows are added to the bottom of the table. If notify is true, a SEL_INSERTED message is sent to the table’s message target for each cell that is inserted. Raises IndexError if row is out of bounds.

itemCurrent?(row, column)

Returns true if the cell at position (row, column) is the current cell. Raises IndexError if either row or column is out of bounds.

itemEnabled?(row, column)

Returns true if the cell at position (row, column) is enabled. Raises IndexError if either row or column is out of bounds.

itemSelected?(row, column)

Returns true if the cell at position (row, column) is selected. Raises IndexError if either row or column is out of bounds.

itemSpanning?(r, c)

Return true if the cell at position (r, c) is a spanning cell. Raises IndexError if either r or c is out of bounds.

itemVisible?(row, column)

Returns true if the cell at position (row, column) is visible. Raises IndexError if either row or column is out of bounds.

killSelection(notify=false)

Kill selection. If notify is true, a SEL_DESELECTED message is sent to the table’s message target for each cell that was previously selected.

makePositionVisible(row, column)

Scroll to make cell at (row, column) fully visible. Raises IndexError if either row or column is out of bounds.

minColumnWidth(c)

Return minimum column width for column c. Raises IndexError if c is out of bounds.

minRowHeight(r)

Return minimum row height for row r. Raises IndexError if r is out of bounds.

overlayText(startrow, endrow, startcol, endcol, text, cs='\t', rs='\n')

Overlay the text for the cells in the specified range with the fields specified in text. Within the text string, each column’s text should delimited by the character specified by cs, and each row should be delimited by the character specified by rs. To reverse this operation (i.e. extract the table cells’ text into a string), see extractText. Raises IndexError if any of startrow, endrow, startcol or endcol is out of bounds.

Parameters:

`startrow`:	the starting row for the range [Integer]
`endrow`:	the ending row for the range [Integer]
`startcol`:	the starting column for the range [Integer]
`endcol`:	the ending column for the range [Integer]
`text`:	the text containing the new cell text [String]
`cs`:	the character to insert at each column break [String]
`rs`:	the character to insert at each row break [String]

removeColumns(column, nc=1, notify=false)

Remove the nc columns starting at the specified column. If notify is true, a SEL_DELETED message is sent to the table’s message target for each cell that is removed. Raises IndexError if column is less than zero, or if column + nc is greater than the current number of table columns.

removeItem(row, col, notify=false)

Remove item at (row, col), replacing it with nil. If notify is true, a SEL_REPLACED message is sent to the table’s message target before this cell is removed. Raises IndexError if either row or col is out of bounds.

removeRange(startrow, endrow, startcol, endcol, notify=false)

Remove all cells in the specified range of rows and columns. If notify is true, a SEL_REPLACED message is sent to the table’s message target before each cell is removed. Raises IndexError if startrow, endrow, startcol or endcol is out of bounds.

removeRows(row, nr=1, notify=false)

Remove the nr rows starting at the specified row. If notify is true, a SEL_DELETED message is sent to the table’s message target for each cell that is removed. Raises IndexError if row is less than zero, or if row + nr is greater than the current number of table rows.

rowAtY(y)

Determine row containing y. Returns -1 if y is above the first row, and numRows if y is below the last row. Otherwise, returns the row in the table containing y.

rowSelected?(r)

Return true if the specified row of cells is selected. Raises IndexError if r is out of bounds.

selectColumn(col, notify=false)

Select a column of cells. If notify is true, a SEL_DESELECTED message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a SEL_SELECTED message is sent to the table’s message target for each newly-selected cell. Raises IndexError if col is out of bounds.

selectItem(row, col, notify=false)

Select cell at (row, col). If notify is true, a SEL_SELECTED message is sent to the table’s message target after the item is selected. Raises IndexError if either row or col is out of bounds.

selectRange(startRow, endRow, startColumn, endColumn, notify=false)

Select range. If notify is true, a SEL_DESELECTED message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a SEL_SELECTED message is sent to the table’s message target for each newly-selected cell. Raises IndexError if startRow, endRow, startColumn or endColumn is out of bounds.

selectRow(row, notify=false)

Select a row of cells. If notify is true, a SEL_DESELECTED message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a SEL_SELECTED message is sent to the table’s message target for each newly-selected cell. Raises IndexError if row is out of bounds.

setAnchorItem(row, column)

Change anchored cell. Raises IndexError if either row or column is out of bounds.

setCellColor(row, column, color)

Change cell background color. The values for row and column are either zero or one. If the value is zero, this background color is used for even-numbered rows (columns). If the value is one, this background color is used for odd-numbered rows (columns). See also getCellColor.

setColumnText(index, text)

Set column header at index to text.

setColumnWidth(column, columnWidth)

Set column width. Raises IndexError if column is out of bounds.

setColumnX(column, x)

Set x-coordinate for column. Raises IndexError if column is out of bounds.

setCurrentItem(row, column, notify=false)

Change current cell. If notify is true, a SEL_CHANGED message is sent to the table’s message target after the current item changes. Raises IndexError if either row or column is out of bounds.

setItem(row, column, item)

Replace the item at the given row and column with a (possibly subclassed) item. Raises IndexError if either row or column is out of bounds.

setItemBorders(r, c, borders)

Set the border style for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

setItemData(row, column, data)

Modify cell user data. Raises IndexError if either row or column is out of bounds.

setItemIcon(row, column, icon)

Modify cell icon. Raises IndexError if either row or column is out of bounds.

setItemIconPosition(r, c, mode)

Set the relative position of the icon and text for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

setItemJustify(r, c, justify)

Set item justification for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

setItemStipple(r, c, pat)

Set the background stipple style for the cell at (r, c). Raises IndexError if either r or c is out of bounds.

setItemText(row, column, text)

Modify cell text for item at specified row and column. Raises IndexError if either row or column is out of bounds.

setRowHeight(row, rowHeight)

Set row height. Raises IndexError if row is out of bounds.

setRowText(index, text)

Set row header at index to text.

setRowY(row, y)

Set y-coordinate of row. Raises IndexError if row is out of bounds.

setTableSize(numRows, numCols, notify=false)

Resize the table content to numRows rows and numCols columns. Note that all existing items in the table will be destroyed and new items will be constructed. If notify is true, then

a SEL_DELETED message will be sent to the table’s message target indicating which cells (if any) are about to be destroyed as a result of the resize;
a SEL_INSERTED message will be sent to the table’s message target indicating which cells (if any) were added as a result of the resize; and,
a SEL_CHANGED message will be sent to the table’s message target indicating the new current cell.

Raises ArgError if either numRows or numCols is less than zero.

showHorzGrid(on=true)

Show or hide horizontal grid. Note that this is equivalent to the horizontalGridShown=() method.

showVertGrid(on=true)

Show or hide vertical grid. Note that this is equivalent to the verticalGridShown=() method.

updateItem(row, column)

Repaint cell. Raises IndexError if either row or column is out of bounds.

updateRange(startRow, endRow, startCol, endCol)

Repaint cells between grid lines (startRow, endRow) and grid lines (startCol, endCol). Raises IndexError if any of the starting or ending grid lines is out of bounds.

verticalGridShown=(vis)

Set visibility of vertical grid to true or false.

verticalGridShown?()

Is vertical grid shown?

`SEL_COMMAND`:	sent when a new item is clicked; the message data is an FXTablePos instance indicating the current cell.
`SEL_KEYPRESS`:	sent when a key goes down; the message data is an FXEvent instance.
`SEL_KEYRELEASE`:	sent when a key goes up; the message data is an FXEvent instance.
`SEL_LEFTBUTTONPRESS`:	sent when the left mouse button goes down; the message data is an FXEvent instance.
`SEL_LEFTBUTTONRELEASE`:	sent when the left mouse button goes up; the message data is an FXEvent instance.
`SEL_RIGHTBUTTONPRESS`:	sent when the left mouse button goes down; the message data is an FXEvent instance.
`SEL_RIGHTBUTTONRELEASE`:	sent when the left mouse button goes up; the message data is an FXEvent instance.
`SEL_SELECTED`:	sent when a cell is selected; the message data is an FXTablePos instance indicating the position of the selected cell.
`SEL_DESELECTED`:	sent when a cell is deselected; the message data is an FXTablePos instance indicating the position of the deselected cell.
`SEL_CHANGED`:	sent when the current cell changes; the message data is an FXTablePos instance indicating the current cell.
`SEL_CLICKED`:	sent when a cell is single-clicked; the message data is an FXTablePos instance indicating the current cell.
`SEL_DOUBLECLICKED`:	sent when a cell is double-clicked; the message data is an FXTablePos instance indicating the current cell.
`SEL_TRIPLECLICKED`:	sent when a cell is triple-clicked; the message data is an FXTablePos instance indicating the current cell.
`SEL_DELETED`:	sent when a range of cells is about to be removed; the message data is an FXTableRange instance indicating the cells to be removed.
`SEL_INSERTED`:	sent when a range of cells has been inserted; the message data is an FXTableRange instance indicating the cells inserted.

`TABLE_COL_SIZABLE`:	Columns are resizable
`TABLE_ROW_SIZABLE`:	Rows are resizable
`TABLE_NO_COLSELECT`:	Disallow column selections
`TABLE_NO_ROWSELECT`:	Disallow row selections

`ID_HORZ_GRID`:	x
`ID_VERT_GRID`:	x
`ID_DELETE_COLUMN`:	x
`ID_DELETE_ROW`:	x
`ID_INSERT_COLUMN`:	x
`ID_INSERT_ROW`:	x
`ID_SELECT_COLUMN_INDEX`:	x
`ID_SELECT_ROW_INDEX`:	x
`ID_SELECT_COLUMN`:	x
`ID_SELECT_ROW`:	x
`ID_SELECT_CELL`:	x
`ID_SELECT_ALL`:	x
`ID_DESELECT_ALL`:	x
`ID_MOVE_LEFT`:	x
`ID_MOVE_RIGHT`:	x
`ID_MOVE_UP`:	x
`ID_MOVE_DOWN`:	x
`ID_MOVE_HOME`:	x
`ID_MOVE_END`:	x
`ID_MOVE_TOP`:	x
`ID_MOVE_BOTTOM`:	x
`ID_MOVE_PAGEDOWN`:	x
`ID_MOVE_PAGEUP`:	x
`ID_MARK`:	x
`ID_EXTEND`:	x
`ID_CUT_SEL`:	x
`ID_COPY_SEL`:	x
`ID_PASTE_SEL`:	x
`ID_DELETE_SEL`:	x

Events

Table options

Message identifiers

Methods

Included Modules

Attributes

Public Class methods

Parameters:

Public Instance methods

Parameters:

Parameters: