< prev index next >
src/java.desktop/share/classes/javax/swing/table/TableColumnModel.java
Print this page
@@ -31,11 +31,11 @@
import javax.swing.*;
/**
* Defines the requirements for a table column model object suitable for
- * use with <code>JTable</code>.
+ * use with {@code JTable}.
*
* @author Alan Chung
* @author Philip Milne
* @see DefaultTableColumnModel
*/
@@ -44,53 +44,53 @@
//
// Modifying the model
//
/**
- * Appends <code>aColumn</code> to the end of the
- * <code>tableColumns</code> array.
- * This method posts a <code>columnAdded</code>
+ * Appends {@code aColumn} to the end of the
+ * {@code tableColumns} array.
+ * This method posts a {@code columnAdded}
* event to its listeners.
*
- * @param aColumn the <code>TableColumn</code> to be added
+ * @param aColumn the {@code TableColumn} to be added
* @see #removeColumn
*/
public void addColumn(TableColumn aColumn);
/**
- * Deletes the <code>TableColumn</code> <code>column</code> from the
- * <code>tableColumns</code> array. This method will do nothing if
- * <code>column</code> is not in the table's column list.
- * This method posts a <code>columnRemoved</code>
+ * Deletes the {@code TableColumn column} from the
+ * {@code tableColumns} array. This method will do nothing if
+ * {@code column} is not in the table's column list.
+ * This method posts a {@code columnRemoved}
* event to its listeners.
*
- * @param column the <code>TableColumn</code> to be removed
+ * @param column the {@code TableColumn} to be removed
* @see #addColumn
*/
public void removeColumn(TableColumn column);
/**
- * Moves the column and its header at <code>columnIndex</code> to
- * <code>newIndex</code>. The old column at <code>columnIndex</code>
- * will now be found at <code>newIndex</code>. The column that used
- * to be at <code>newIndex</code> is shifted left or right
+ * Moves the column and its header at {@code columnIndex} to
+ * {@code newIndex}. The old column at {@code columnIndex}
+ * will now be found at {@code newIndex}. The column that used
+ * to be at {@code newIndex} is shifted left or right
* to make room. This will not move any columns if
- * <code>columnIndex</code> equals <code>newIndex</code>. This method
- * posts a <code>columnMoved</code> event to its listeners.
+ * {@code columnIndex} equals {@code newIndex}. This method
+ * posts a {@code columnMoved} event to its listeners.
*
* @param columnIndex the index of column to be moved
* @param newIndex index of the column's new location
- * @exception IllegalArgumentException if <code>columnIndex</code> or
- * <code>newIndex</code>
+ * @exception IllegalArgumentException if {@code columnIndex} or
+ * {@code newIndex}
* are not in the valid range
*/
public void moveColumn(int columnIndex, int newIndex);
/**
- * Sets the <code>TableColumn</code>'s column margin to
- * <code>newMargin</code>. This method posts
- * a <code>columnMarginChanged</code> event to its listeners.
+ * Sets the {@code TableColumn}'s column margin to
+ * {@code newMargin}. This method posts
+ * a {@code columnMarginChanged} event to its listeners.
*
* @param newMargin the width, in pixels, of the new column margins
* @see #getColumnMargin
*/
public void setColumnMargin(int newMargin);
@@ -104,38 +104,38 @@
* @return the number of columns in the model
*/
public int getColumnCount();
/**
- * Returns an <code>Enumeration</code> of all the columns in the model.
- * @return an <code>Enumeration</code> of all the columns in the model
+ * Returns an {@code Enumeration} of all the columns in the model.
+ * @return an {@code Enumeration} of all the columns in the model
*/
public Enumeration<TableColumn> getColumns();
/**
* Returns the index of the first column in the table
- * whose identifier is equal to <code>identifier</code>,
- * when compared using <code>equals</code>.
+ * whose identifier is equal to {@code identifier},
+ * when compared using {@code equals}.
*
* @param columnIdentifier the identifier object
* @return the index of the first table column
- * whose identifier is equal to <code>identifier</code>
- * @exception IllegalArgumentException if <code>identifier</code>
- * is <code>null</code>, or no
- * <code>TableColumn</code> has this
- * <code>identifier</code>
+ * whose identifier is equal to {@code identifier}
+ * @exception IllegalArgumentException if {@code identifier}
+ * is {@code null}, or no
+ * {@code TableColumn} has this
+ * {@code identifier}
* @see #getColumn
*/
public int getColumnIndex(Object columnIdentifier);
/**
- * Returns the <code>TableColumn</code> object for the column at
- * <code>columnIndex</code>.
+ * Returns the {@code TableColumn} object for the column at
+ * {@code columnIndex}.
*
* @param columnIndex the index of the desired column
- * @return the <code>TableColumn</code> object for
- * the column at <code>columnIndex</code>
+ * @return the {@code TableColumn} object for
+ * the column at {@code columnIndex}
*/
public TableColumn getColumn(int columnIndex);
/**
* Returns the width between the cells in each column.
@@ -143,26 +143,26 @@
*/
public int getColumnMargin();
/**
* Returns the index of the column that lies on the
- * horizontal point, <code>xPosition</code>;
+ * horizontal point, {@code 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
* accommodate 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 <code>xPosition</code> should not be
+ * are laid out on screen, the given {@code 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, <code>JTable.columnAtPoint</code> can be used instead.
+ * required, {@code JTable.columnAtPoint} can be used instead.
*
* @param xPosition width from the start of the first column in
* the model.
*
* @return the index of the column; or -1 if no column is found
@@ -209,19 +209,19 @@
public int getSelectedColumnCount();
/**
* Sets the selection model.
*
- * @param newModel a <code>ListSelectionModel</code> object
+ * @param newModel a {@code ListSelectionModel} object
* @see #getSelectionModel
*/
public void setSelectionModel(ListSelectionModel newModel);
/**
* Returns the current selection model.
*
- * @return a <code>ListSelectionModel</code> object
+ * @return a {@code ListSelectionModel} object
* @see #setSelectionModel
*/
public ListSelectionModel getSelectionModel();
//
@@ -229,16 +229,16 @@
//
/**
* Adds a listener for table column model events.
*
- * @param x a <code>TableColumnModelListener</code> object
+ * @param x a {@code TableColumnModelListener} object
*/
public void addColumnModelListener(TableColumnModelListener x);
/**
* Removes a listener for table column model events.
*
- * @param x a <code>TableColumnModelListener</code> object
+ * @param x a {@code TableColumnModelListener} object
*/
public void removeColumnModelListener(TableColumnModelListener x);
}
< prev index next >