interface org.aswing.table.TableColumnModel
| Implementors | ||||
 | DefaultTableColumnModel |
| ||
Defines the requirements for a table column model object suitable for
use with JTable.
@author paling
Instance Fields
function addColumn(aColumn:TableColumn): Void
Appends aColumn to the end of the
tableColumns array.
This method posts a columnAdded
event to its listeners.
@see #removeColumn
| aColumn | the |
function addColumnModelListener(x:TableColumnModelListener): Void
Adds a listener for table column model events.
| x | a |
function getColumn(columnIndex:Int): TableColumn
Returns the TableColumn object for the column at
columnIndex.
| columnIndex | the index of the desired column |
| returns | the |
function getColumnCount(): Int
Returns the number of columns in the model.
| returns | the number of columns in the model |
function getColumnIndex(columnIdentifier:Dynamic): Int
Returns the index of the first column in the table
whose identifier is equal to identifier,
when compared using equals.
@see #getColumn
| columnIdentifier | the identifier object |
| returns | the index of the first table column
whose identifier is equal to |
function getColumnIndexAtX(xPosition:Int): Int
Returns the index of the column that lies on the
horizontal point, xPosition;
or -1 if it lies outside the any of the column's bounds.
In keeping with Swing's separable model architecture, a
TableColumnModel does not know how the table columns actually appear on
screen. The visual presentation of the columns is the responsibility
of the view/controller object using this model (typically JTable). The
view/controller need not display the columns sequentially from left to
right. For example, columns could be displayed from right to left to
accomodate a locale preference or some columns might be hidden at the
request of the user. Because the model does not know how the columns
are laid out on screen, the given xPosition should not be
considered to be a coordinate in 2D graphics space. Instead, it should
be considered to be a width from the start of the first column in the
model. If the column index for a given X coordinate in 2D space is
required, JTable.columnAtPoint can be used instead.
@see javax.swing.JTable#columnAtPoint
| returns | the index of the column; or -1 if no column is found |
function getColumnMargin(): Int
Returns the width between the cells in each column.
| returns | the margin, in pixels, between the cells |
function getColumnSelectionAllowed(): Bool
Returns true if columns may be selected. @see #setColumnSelectionAllowed
| returns | true if columns may be selected |
function getColumns(): Array<Dynamic>
Returns an Array of all the columns in the model.
| returns | an |
function getSelectedColumnCount(): Int
Returns the number of selected columns.
| returns | the number of selected columns; or 0 if no columns are selected |
function getSelectedColumns(): Array<Dynamic>
Returns an array of indicies of all selected columns.
| returns | an array of integers containing the indicies of all selected columns; or an empty array if nothing is selected |
function getSelectionModel(): ListSelectionModel
Returns the current selection model.
@see #setSelectionModel
| returns | a |
function getTotalColumnWidth(): Int
Returns the total width of all the columns.
| returns | the total computed width of all columns |
function moveColumn(columnIndex:Int, newIndex:Int): Void
Moves the column and its header at columnIndex to
newIndex. The old column at columnIndex
will now be found at newIndex. The column that used
to be at newIndex is shifted left or right
to make room. This will not move any columns if
columnIndex equals newIndex. This method
posts a columnMoved event to its listeners.
| columnIndex | the index of column to be moved |
| newIndex | index of the column's new location |
function removeColumn(column:TableColumn): Void
Deletes the TableColumn column from the
tableColumns array. This method will do nothing if
column is not in the table's column list.
This method posts a columnRemoved
event to its listeners.
@see #addColumn
| column | the |
function removeColumnModelListener(x:TableColumnModelListener): Void
Removes a listener for table column model events.
| x | a |
function setColumnMargin(newMargin:Int): Void
Sets the TableColumn's column margin to
newMargin. This method posts
a columnMarginChanged event to its listeners.
@see #getColumnMargin
| newMargin | the width, in pixels, of the new column margins |
function setColumnSelectionAllowed(flag:Bool): Void
Sets whether the columns in this model may be selected. @see #getColumnSelectionAllowed
| flag | true if columns may be selected; otherwise false |
function setSelectionModel(newModel:ListSelectionModel): Void
Sets the selection model.
@see #getSelectionModel
| newModel | a |