|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.swing.table.DefaultTableColumnModel
public class DefaultTableColumnModel
The standard column-handler for a JTable.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
JTable| Field Summary | |
|---|---|
protected ChangeEvent |
changeEvent
Change event (only one needed) |
protected int |
columnMargin
Width margin between each column |
protected boolean |
columnSelectionAllowed
Column selection allowed in this column model |
protected EventListenerList |
listenerList
List of TableColumnModelListener |
protected ListSelectionModel |
selectionModel
Model for keeping track of column selections |
protected Vector<TableColumn> |
tableColumns
Array of TableColumn objects in this model |
protected int |
totalColumnWidth
A local cache of the combined width of all columns |
| Constructor Summary | |
|---|---|
DefaultTableColumnModel()
Creates a default table column model. |
|
| Method Summary | ||
|---|---|---|
void |
addColumn(TableColumn aColumn)
Appends aColumn to the end of the
tableColumns array. |
|
void |
addColumnModelListener(TableColumnModelListener x)
Adds a listener for table column model events. |
|
protected ListSelectionModel |
createSelectionModel()
Creates a new default list selection model. |
|
protected void |
fireColumnAdded(TableColumnModelEvent e)
Notifies all listeners that have registered interest for notification on this event type. |
|
protected void |
fireColumnMarginChanged()
Notifies all listeners that have registered interest for notification on this event type. |
|
protected void |
fireColumnMoved(TableColumnModelEvent e)
Notifies all listeners that have registered interest for notification on this event type. |
|
protected void |
fireColumnRemoved(TableColumnModelEvent e)
Notifies all listeners that have registered interest for notification on this event type. |
|
protected void |
fireColumnSelectionChanged(ListSelectionEvent e)
Notifies all listeners that have registered interest for notification on this event type. |
|
TableColumn |
getColumn(int columnIndex)
Returns the TableColumn object for the column
at columnIndex. |
|
int |
getColumnCount()
Returns the number of columns in the tableColumns array. |
|
int |
getColumnIndex(Object identifier)
Returns the index of the first column in the tableColumns
array whose identifier is equal to identifier,
when compared using equals. |
|
int |
getColumnIndexAtX(int x)
Returns the index of the column that lies at position x,
or -1 if no column covers this point. |
|
int |
getColumnMargin()
Returns the width margin for TableColumn. |
|
TableColumnModelListener[] |
getColumnModelListeners()
Returns an array of all the column model listeners registered on this model. |
|
Enumeration<TableColumn> |
getColumns()
Returns an Enumeration of all the columns in the model. |
|
boolean |
getColumnSelectionAllowed()
Returns true if column selection is allowed, otherwise false. |
|
|
getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners
upon this model. |
|
int |
getSelectedColumnCount()
Returns the number of columns selected. |
|
int[] |
getSelectedColumns()
Returns an array of selected columns. |
|
ListSelectionModel |
getSelectionModel()
Returns the ListSelectionModel that is used to
maintain column selection state. |
|
int |
getTotalColumnWidth()
Returns the total combined width of all columns. |
|
void |
moveColumn(int columnIndex,
int newIndex)
Moves the column and heading at columnIndex to
newIndex. |
|
void |
propertyChange(PropertyChangeEvent evt)
Property Change Listener change method. |
|
protected void |
recalcWidthCache()
Recalculates the total combined width of all columns. |
|
void |
removeColumn(TableColumn column)
Deletes the column from the
tableColumns array. |
|
void |
removeColumnModelListener(TableColumnModelListener x)
Removes a listener for table column model events. |
|
void |
setColumnMargin(int newMargin)
Sets the column margin to newMargin. |
|
void |
setColumnSelectionAllowed(boolean flag)
Sets whether column selection is allowed. |
|
void |
setSelectionModel(ListSelectionModel newModel)
Sets the selection model for this TableColumnModel
to newModel
and registers for listener notifications from the new selection
model. |
|
void |
valueChanged(ListSelectionEvent e)
A ListSelectionListener that forwards
ListSelectionEvents when there is a column
selection change. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Vector<TableColumn> tableColumns
protected ListSelectionModel selectionModel
protected int columnMargin
protected EventListenerList listenerList
protected transient ChangeEvent changeEvent
protected boolean columnSelectionAllowed
protected int totalColumnWidth
| Constructor Detail |
|---|
public DefaultTableColumnModel()
| Method Detail |
|---|
public void addColumn(TableColumn aColumn)
aColumn to the end of the
tableColumns array.
This method also posts the columnAdded
event to its listeners.
addColumn in interface TableColumnModelaColumn - the TableColumn to be added
IllegalArgumentException - if aColumn is
nullremoveColumn(javax.swing.table.TableColumn)public void removeColumn(TableColumn column)
column from the
tableColumns array. This method will do nothing if
column is not in the table's columns list.
tile is called
to resize both the header and table views.
This method also posts a columnRemoved
event to its listeners.
removeColumn in interface TableColumnModelcolumn - the TableColumn to be removedaddColumn(javax.swing.table.TableColumn)
public void moveColumn(int columnIndex,
int newIndex)
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 a columnMoved event to its listeners.
moveColumn in interface TableColumnModelcolumnIndex - the index of column to be movednewIndex - new index to move the column
IllegalArgumentException - if column or
newIndex
are not in the valid rangepublic void setColumnMargin(int newMargin)
newMargin. This method
also posts a columnMarginChanged event to its
listeners.
setColumnMargin in interface TableColumnModelnewMargin - the new margin width, in pixelsgetColumnMargin(),
getTotalColumnWidth()public int getColumnCount()
tableColumns array.
getColumnCount in interface TableColumnModeltableColumns arraygetColumns()public Enumeration<TableColumn> getColumns()
Enumeration of all the columns in the model.
getColumns in interface TableColumnModelEnumeration of the columns in the modelpublic int getColumnIndex(Object identifier)
tableColumns
array whose identifier is equal to identifier,
when compared using equals.
getColumnIndex in interface TableColumnModelidentifier - the identifier object
tableColumns array whose identifier
is equal to identifier
IllegalArgumentException - if identifier
is null, or if no
TableColumn has this
identifiergetColumn(int)public TableColumn getColumn(int columnIndex)
TableColumn object for the column
at columnIndex.
getColumn in interface TableColumnModelcolumnIndex - the index of the column desired
TableColumn object for the column
at columnIndexpublic int getColumnMargin()
TableColumn.
The default columnMargin is 1.
getColumnMargin in interface TableColumnModelTableColumnsetColumnMargin(int)public int getColumnIndexAtX(int x)
x,
or -1 if no column covers this point.
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.
getColumnIndexAtX in interface TableColumnModelx - the horizontal location of interest
JTable.columnAtPoint(java.awt.Point)public int getTotalColumnWidth()
getTotalColumnWidth in interface TableColumnModeltotalColumnWidth propertypublic void setSelectionModel(ListSelectionModel newModel)
TableColumnModel
to newModel
and registers for listener notifications from the new selection
model. If newModel is null,
an exception is thrown.
setSelectionModel in interface TableColumnModelnewModel - the new selection model
IllegalArgumentException - if newModel
is nullgetSelectionModel()public ListSelectionModel getSelectionModel()
ListSelectionModel that is used to
maintain column selection state.
getSelectionModel in interface TableColumnModelnull if row selection is not allowed.setSelectionModel(javax.swing.ListSelectionModel)public void setColumnSelectionAllowed(boolean flag)
setColumnSelectionAllowed in interface TableColumnModelflag - true if column selection will be allowed, false otherwiseTableColumnModel.getColumnSelectionAllowed()public boolean getColumnSelectionAllowed()
getColumnSelectionAllowed in interface TableColumnModelcolumnSelectionAllowed propertyTableColumnModel.setColumnSelectionAllowed(boolean)public int[] getSelectedColumns()
selectionModel
is null, returns an empty array.
getSelectedColumns in interface TableColumnModelselectionModel is
nullpublic int getSelectedColumnCount()
getSelectedColumnCount in interface TableColumnModelpublic void addColumnModelListener(TableColumnModelListener x)
addColumnModelListener in interface TableColumnModelx - a TableColumnModelListener objectpublic void removeColumnModelListener(TableColumnModelListener x)
removeColumnModelListener in interface TableColumnModelx - a TableColumnModelListener objectpublic TableColumnModelListener[] getColumnModelListeners()
ColumnModelListeners
or an empty
array if no column model listeners are currently registeredaddColumnModelListener(javax.swing.event.TableColumnModelListener),
removeColumnModelListener(javax.swing.event.TableColumnModelListener)protected void fireColumnAdded(TableColumnModelEvent e)
e - the event receivedEventListenerListprotected void fireColumnRemoved(TableColumnModelEvent e)
e - the event receivedEventListenerListprotected void fireColumnMoved(TableColumnModelEvent e)
e - the event receivedEventListenerListprotected void fireColumnSelectionChanged(ListSelectionEvent e)
e - the event receivedEventListenerListprotected void fireColumnMarginChanged()
EventListenerListpublic <T extends EventListener> T[] getListeners(Class<T> listenerType)
FooListeners
upon this model.
FooListeners are registered using the
addFooListener method.
You can specify the listenerType argument
with a class literal,
such as
FooListener.class.
For example, you can query a
DefaultTableColumnModel m
for its column model listeners with the following code:
ColumnModelListener[] cmls = (ColumnModelListener[])(m.getListeners(ColumnModelListener.class));If no such listeners exist, this method returns an empty array.
listenerType - the type of listeners requested; this parameter
should specify an interface that descends from
java.util.EventListener
FooListeners on this model,
or an empty array if no such
listeners have been added
ClassCastException - if listenerType
doesn't specify a class or interface that implements
java.util.EventListenergetColumnModelListeners()public void propertyChange(PropertyChangeEvent evt)
propertyChange in interface PropertyChangeListenerevt - PropertyChangeEventpublic void valueChanged(ListSelectionEvent e)
ListSelectionListener that forwards
ListSelectionEvents when there is a column
selection change.
valueChanged in interface ListSelectionListenere - the change eventprotected ListSelectionModel createSelectionModel()
protected void recalcWidthCache()
totalColumnWidth property.
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.