All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Interface java.awt.swing.table.TableColumnModel

public interface TableColumnModel

See Also:

DefaultTableColumnModel

addColumn(TableColumn)

Appends aColumn to the end of the receiver's tableColumns array.

addColumnModelListener(TableColumnModelListener)

addColumnSelectionInterval(int, int)

Adds the columns from index0 to index0 inclusive to the current selection, if column selection and multiple selection is allowed.

clearSelection()

Deselects all selected columns if empty selection is allowed.

getColumn(int)

Returns the TableColumn object for the column at columnIndex

getColumn(Object)

Returns the TableColumn object for the column in the receiver's columns array whose identifier is equal to identifier, when compared using equals().

getColumnCount()

Returns the number of columns in the model

getColumnIndex(Object)

Returns the index of the first column in the receiver's columns array whose identifier is equal to identifier, when compared using equals().

getColumnIndexAtX(int)

Returns the index of the column that lies on the xPosition, or -1 if it lies outside the any of the column's bounds.

getColumnMargin()

Returns the width margin between each column

getColumns()

Returns an Enumeration of all the columns in the model

getColumnSelectionAllowed()

getEmptySelectionAllowed()

getMultipleSelectionAllowed()

getSelectedColumn()

getSelectedColumnCount()

getSelectedColumns()

getTotalColumnWidth()

Returns the total width of all the columns.

isColumnSelected(int)

isColumnSelected(Object)

makeSelectionEmpty()

Deselects all selected columns even if empty selection is not allowed.

moveColumn(int, int)

Moves the column and heading at columnIndex to newIndex.

removeColumn(TableColumn)

Deletes the TableColumn column from the receiver's table columns array.

removeColumnModelListener(TableColumnModelListener)

removeColumnSelectionInterval(int, int)

Deselects the columns from index0 to index0 inclusive.

selectAll()

If the TableColumnModel allows multiple selection then selects all columns.

setColumnMargin(int)

Sets the TableColumn's column margin to newMargin.

setColumnSelectionAllowed(boolean)

Sets whether the columns in this model can be selected.

setColumnSelectionInterval(int, int)

Selects the columns from index0 to index1 inclusive, if column selection is allowed.

setEmptySelectionAllowed(boolean)

Sets whether the user can select zero columns.

setMultipleSelectionAllowed(boolean)

Sets whether the user can select more than one column at a time.

public abstract void addColumn(TableColumn aColumn)

Appends aColumn to the end of the receiver's tableColumns array. This method also posts the columnAdded() event to its listeners.

Parameters:

aColumn - The TableColumn to be added

See Also:

removeColumn

public abstract void removeColumn(TableColumn column)

Deletes the TableColumn column from the receiver's table columns array. This method will do nothing if column is not in the table's columns list. This method also posts the columnRemoved() event to its listeners.

Parameters:

column - The TableColumn to be removed

See Also:

addColumn

public abstract void moveColumn(int columnIndex,
                                int newIndex)

Moves the column and heading 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 also posts the columnMoved() event to its listeners.

Parameters:

columnIndex - the index of column to be moved

newIndex - New index to move the column

Throws: IllegalArgumentException

if column or newIndex are not in the valid range

public abstract void setColumnMargin(int newMargin)

Sets the TableColumn's column margin to newMargin. This method also posts the columnMarginChanged() event to its listeners.

Parameters:

newMargin - the width margin of the column

See Also:

getColumnMargin

public abstract int getColumnCount()

Returns the number of columns in the model

public abstract Enumeration getColumns()

Returns an Enumeration of all the columns in the model

public abstract int getColumnIndex(Object columnIdentifier)

Returns the index of the first column in the receiver's columns array whose identifier is equal to identifier, when compared using equals(). Returns -1 if no column is found with the specified identifier.

Parameters:

identifier - the identifier object

Returns:

the index of the first table column in the receiver's tableColumns array whose identifier is equal to identifier, when compared using equals().

Throws: IllegalArgumentException

if identifier is null

See Also:

getColumn

public abstract TableColumn getColumn(Object columnIdentifier)

Returns the TableColumn object for the column in the receiver's columns array whose identifier is equal to identifier, when compared using equals(). Returns null if no column is found with the specified identifier.

Parameters:

identifier - the identifier object

Returns:

the TableColumn object for the column in the receiver's tableColumns array whose identifier is equal to identifier, when compared using equals()

Throws: IllegalArgumentException

if identifier is null

See Also:

getColumnIndex

public abstract TableColumn getColumn(int columnIndex)

Returns the TableColumn object for the column at columnIndex

Parameters:

columnIndex - the index of the column desired

Returns:

the TableColumn object for the column at columnIndex

public abstract int getColumnMargin()

Returns the width margin between each column

public abstract int getColumnIndexAtX(int xPosition)

Returns the index of the column that lies on the xPosition, or -1 if it lies outside the any of the column's bounds.

Returns:

the index of the column or -1 if no column is found

public abstract int getTotalColumnWidth()

Returns the total width of all the columns.

public abstract void setMultipleSelectionAllowed(boolean flag)

Sets whether the user can select more than one column at a time.

See Also:

getMultipleSelectionAllowed

public abstract boolean getMultipleSelectionAllowed()

Returns:

true if the receiver allows more than one column selected

See Also:

setMultipleSelectionAllowed

public abstract void setEmptySelectionAllowed(boolean flag)

Sets whether the user can select zero columns.

See Also:

getEmptySelectionAllowed

public abstract boolean getEmptySelectionAllowed()

Returns:

true if the receiver allows zero column selected

See Also:

setEmptySelectionAllowed

public abstract void setColumnSelectionAllowed(boolean flag)

Sets whether the columns in this model can be selected.

See Also:

getColumnSelectionAllowed

public abstract boolean getColumnSelectionAllowed()

Returns:

true if columns can be selected.

See Also:

setColumnSelectionAllowed

public abstract void selectAll()

If the TableColumnModel allows multiple selection then selects all columns.

public abstract void clearSelection()

Deselects all selected columns if empty selection is allowed. If empty selection in not allowed then it deselects all except one column.

public abstract void makeSelectionEmpty()

Deselects all selected columns even if empty selection is not allowed.

public abstract void setColumnSelectionInterval(int index0,
                                                int index1)

Selects the columns from index0 to index1 inclusive, if column selection is allowed. If multiple selection is not allowed then it only selects the column at index0.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

public abstract void addColumnSelectionInterval(int index0,
                                                int index1)

Adds the columns from index0 to index0 inclusive to the current selection, if column selection and multiple selection is allowed.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

public abstract void removeColumnSelectionInterval(int index0,
                                                   int index1)

Deselects the columns from index0 to index0 inclusive. If empty selection is not allowed then this might leave one column selected.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

public abstract int getSelectedColumn()

Returns:

the index of the last column selected or added to the selection, (lead selection) or -1 if no column is selected.

See Also:

getSelectedColumns

public abstract int[] getSelectedColumns()

Returns:

the indices of all selected columns, or an empty int array if no column is selected.

See Also:

getSelectedColumn

public abstract int getSelectedColumnCount()

Returns:

the number of selected columns. 0 if no columns are selected.

public abstract boolean isColumnSelected(int column)

Returns:

true if the column at index column is selected

Throws: IllegalArgumentException

if column is not in the valid range

public abstract boolean isColumnSelected(Object identifier)

Returns:

true if the column with identifier matching identifier is selected

public abstract void addColumnModelListener(TableColumnModelListener x)

public abstract void removeColumnModelListener(TableColumnModelListener x)

All Packages  Class Hierarchy  This Package  Previous  Next  Index