javax.swing.table

Interface TableColumnModel

Known Implementing Classes:: DefaultTableColumnModel

public interface TableColumnModel

The interface used by JTable to access the columns in the table view.

Method Summary
`void`	`addColumn(TableColumn column)` Adds a column to the model.
`void`	`addColumnModelListener(TableColumnModelListener listener)` Registers a listener with the model, so that it will receive `TableColumnModelEvent` notifications.
`TableColumn`	`getColumn(int columnIndex)` Returns the `TableColumn` at the specified index.
`int`	`getColumnCount()` Returns the number of columns in the model.
`int`	`getColumnIndex(Object identifier)` Returns the index of the `TableColumn` with the given identifier.
`int`	`getColumnIndexAtX(int xPosition)` Returns the index of the column that contains the specified x-coordinate, assuming that: column zero begins at position zero; all columns appear in order; individual column widths are taken into account, but the column margin is ignored. If no column contains the specified position, this method returns `-1`.
`int`	`getColumnMargin()` Returns the column margin.
`boolean`	`getColumnSelectionAllowed()` Returns `true` if column selection is allowed, and `false` if column selection is not allowed.
`Enumeration`	`getColumns()` Returns an enumeration of the columns in the model.
`int`	`getSelectedColumnCount()` Returns the number of selected columns in the model.
`int[]`	`getSelectedColumns()` getSelectedColumns
`ListSelectionModel`	`getSelectionModel()` Returns the selection model used to track table column selections.
`int`	`getTotalColumnWidth()` Returns total width of all the columns in the model, ignoring the column margin (see `getColumnMargin()`).
`void`	`moveColumn(int columnIndex, int newIndex)` Moves a column.
`void`	`removeColumn(TableColumn column)` Removes a column from the model.
`void`	`removeColumnModelListener(TableColumnModelListener listener)` Deregisters a listener, so that it will no longer receive `TableColumnModelEvent` notifications.
`void`	`setColumnMargin(int margin)` Sets the column margin and sends a `ChangeEvent` to all registered `TableColumnModelListener`s registered with the model.
`void`	`setColumnSelectionAllowed(boolean allowed)` Sets the flag that indicates whether or not column selection is allowed.
`void`	`setSelectionModel(ListSelectionModel model)` Sets the selection model that will be used to keep track of the selected columns.

addColumn

public void addColumn(TableColumn column)

Adds a column to the model.
Parameters:
column - the new column (null not permitted).
Throws:
IllegalArgumentException - if column is null.

addColumnModelListener

public void addColumnModelListener(TableColumnModelListener listener)

Registers a listener with the model, so that it will receive TableColumnModelEvent notifications.
Parameters:
listener - the listener (null ignored).

getColumn

public TableColumn getColumn(int columnIndex)

Returns the TableColumn at the specified index.
Parameters:
columnIndex - the column index.
Returns:
The table column.

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.
Returns:
The column count.

getColumnIndex

public int getColumnIndex(Object identifier)

Returns the index of the TableColumn with the given identifier.
Parameters:
identifier - the identifier (null not permitted).
Returns:
The index of the TableColumn with the given identifier.
Throws:
IllegalArgumentException - if identifier is null or there is no column with that identifier.

getColumnIndexAtX

public int getColumnIndexAtX(int xPosition)

Returns the index of the column that contains the specified x-coordinate, assuming that:
column zero begins at position zero;
all columns appear in order;
individual column widths are taken into account, but the column margin is ignored.
If no column contains the specified position, this method returns -1.
Parameters:
xPosition - the x-position.
Returns:
The column index, or -1.

getColumnMargin

public int getColumnMargin()

Returns the column margin.
Returns:
The column margin.
See Also:
setColumnMargin(int)

getColumnSelectionAllowed

public boolean getColumnSelectionAllowed()

Returns true if column selection is allowed, and false if column selection is not allowed.
Returns:
A boolean.
See Also:
setColumnSelectionAllowed(boolean)

getColumns

public Enumeration getColumns()

Returns an enumeration of the columns in the model.
Returns:
An enumeration of the columns in the model.

getSelectedColumnCount

public int getSelectedColumnCount()

Returns the number of selected columns in the model.
Returns:
The selected column count.
See Also:
getSelectionModel()

getSelectedColumns

public int[] getSelectedColumns()

getSelectedColumns
Returns:
Selected columns

getSelectionModel

public ListSelectionModel getSelectionModel()

Returns the selection model used to track table column selections.
Returns:
The selection model.
See Also:
setSelectionModel(ListSelectionModel)

getTotalColumnWidth

public int getTotalColumnWidth()

Returns total width of all the columns in the model, ignoring the column margin (see getColumnMargin()).
Returns:
The total width of all the columns.

moveColumn

public void moveColumn(int columnIndex,
                       int newIndex)

Moves a column.
Parameters:
columnIndex - Index of column to move
newIndex - New index of column

removeColumn

public void removeColumn(TableColumn column)

Removes a column from the model. If column is not defined in the model, this method does nothing.
Parameters:
column - TableColumn

removeColumnModelListener

public void removeColumnModelListener(TableColumnModelListener listener)

Deregisters a listener, so that it will no longer receive TableColumnModelEvent notifications.
Parameters:
listener - the listener.

setColumnMargin

public void setColumnMargin(int margin)

Sets the column margin and sends a ChangeEvent to all registered TableColumnModelListeners registered with the model.
Parameters:
margin - the column margin.
See Also:
getColumnMargin()

setColumnSelectionAllowed

public void setColumnSelectionAllowed(boolean allowed)

Sets the flag that indicates whether or not column selection is allowed.
Parameters:
allowed - the new flag value.
See Also:
getColumnSelectionAllowed()

setSelectionModel

public void setSelectionModel(ListSelectionModel model)

Sets the selection model that will be used to keep track of the selected columns.
Parameters:
model - the selection model (null not permitted).
Throws:
IllegalArgumentException - if model is null.

TableColumnModel.java -- Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr