public class ColumnFactory extends Object
TableColumnExt
s.
TODO JW: explain types of configuration - initial from tableModel, initial from table context, user triggered at runtime.
JXTable
delegates all TableColumn
creation and
configuration to a ColumnFactory
. Enhanced column
configuration should be implemented in a custom factory subclass. The example
beautifies the column titles to always start with a capital letter:
MyColumnFactory extends ColumnFactory {
//@Override
public void configureTableColumn(TableModel model,
TableColumnExt columnExt) {
super.configureTableColumn(model, columnExt);
String title = columnExt.getTitle();
title = title.substring(0,1).toUpperCase() + title.substring(1).toLowerCase();
columnExt.setTitle(title);
}
};
By default a single instance is shared across all tables of an application.
This instance can be replaced by a custom implementation, preferably "early"
in the application's lifetime.
ColumnFactory.setInstance(new MyColumnFactory());
Alternatively, any instance of JXTable
can be configured
individually with its own ColumnFactory
.
JXTable table = new JXTable();
table.setColumnFactory(new MyColumnFactory());
table.setModel(myTableModel);
JXTable.setColumnFactory(ColumnFactory)
Modifier and Type | Field and Description |
---|---|
private static ColumnFactory |
columnFactory
the shared instance.
|
private int |
packMargin
the default margin to use in pack.
|
Constructor and Description |
---|
ColumnFactory() |
Modifier and Type | Method and Description |
---|---|
protected int |
calcHeaderWidth(JXTable table,
TableColumnExt columnExt)
Measures and returns the preferred width of the header.
|
protected int |
calcPrototypeWidth(JXTable table,
TableColumnExt columnExt)
Measures and returns the preferred width of the rendering component
configured with the prototype value, if any.
|
void |
configureColumnWidths(JXTable table,
TableColumnExt columnExt)
Configures column initial widths properties from
JXTable . |
void |
configureTableColumn(TableModel model,
TableColumnExt columnExt)
Configure column properties from TableModel.
|
TableColumnExt |
createAndConfigureTableColumn(TableModel model,
int modelIndex)
Creates and configures a TableColumnExt.
|
TableColumnExt |
createTableColumn(int modelIndex)
Creates a table column with modelIndex.
|
protected TableCellRenderer |
getCellRenderer(JXTable table,
TableColumnExt columnExt)
Returns the cell renderer to use for measuring.
|
int |
getDefaultPackMargin()
Returns the default pack margin.
|
protected TableCellRenderer |
getHeaderRenderer(JXTable table,
TableColumnExt columnExt)
Looks up and returns the renderer used for the column's header.
|
static ColumnFactory |
getInstance()
Returns the shared default factory.
|
int |
getPreferredScrollableViewportWidth(JXTable table)
Calculates and returns the preferred scrollable viewport
width of the given table.
|
protected int |
getRowCount(JXTable table)
Returns the number of table view rows accessible during row-related
config.
|
void |
packColumn(JXTable table,
TableColumnExt columnExt,
int margin,
int max)
Configures the column's
preferredWidth to fit the content. |
void |
setDefaultPackMargin(int margin)
Sets the default pack margin.
|
static void |
setInstance(ColumnFactory factory)
Sets the shared default factory.
|
private static ColumnFactory columnFactory
private int packMargin
public ColumnFactory()
public static ColumnFactory getInstance()
ColumnFactory
setInstance(ColumnFactory)
public static void setInstance(ColumnFactory factory)
JXTable
if none has been set individually.factory
- the default column factory.getInstance()
,
JXTable.getColumnFactory()
public TableColumnExt createAndConfigureTableColumn(TableModel model, int modelIndex)
JXTable
calls
this method for each column in the TableModel
.model
- the TableModel to read configuration properties frommodelIndex
- column index in model coordinatesNPE
- if model == nullIllegalStateException
- if the modelIndex is invalid
(in coordinate space of the tablemodel)createTableColumn(int)
,
configureTableColumn(TableModel, TableColumnExt)
,
JXTable.createDefaultColumnsFromModel()
public TableColumnExt createTableColumn(int modelIndex)
The factory's column creation is passed through this method, so subclasses can override to return custom column types.
modelIndex
- column index in model coordinatesmodelIndex
createAndConfigureTableColumn(TableModel, int)
public void configureTableColumn(TableModel model, TableColumnExt columnExt)
headerValue
property from the
model's columnName
.
The factory's initial column configuration is passed through this method, so subclasses can override to customize.
model
- the TableModel to read configuration properties fromcolumnExt
- the TableColumnExt to configure.NullPointerException
- if model or column == nullIllegalStateException
- if column does not have valid modelIndex
(in coordinate space of the tablemodel)createAndConfigureTableColumn(TableModel, int)
public void configureColumnWidths(JXTable table, TableColumnExt columnExt)
JXTable
.
This implementation sets the column's
preferredWidth
with the strategy:
TODO JW - how to handle default settings which are different from standard 75?
table
- the context the column will live in.columnExt
- the Tablecolumn to configure.JXTable.getPreferredScrollableViewportSize()
public int getPreferredScrollableViewportWidth(JXTable table)
This implementation sums the pref widths of the first visibleColumnCount contained visible tableColumns. If the table contains less columns, the standard preferred width per column is added to the result.
table
- the table containing the columnsprotected int calcHeaderWidth(JXTable table, TableColumnExt columnExt)
table
- the component the renderer lives incolumnExt
- the TableColumn to configureprotected int calcPrototypeWidth(JXTable table, TableColumnExt columnExt)
table
- the component the renderer lives incolumnExt
- the TableColumn to configureprotected TableCellRenderer getCellRenderer(JXTable table, TableColumnExt columnExt)
table
- the table which provides the renderercolumnExt
- the TableColumn to configureprotected TableCellRenderer getHeaderRenderer(JXTable table, TableColumnExt columnExt)
table
- the table which contains the columncolumnExt
- the column to lookup the header renderer forpublic void packColumn(JXTable table, TableColumnExt columnExt, int margin, int max)
preferredWidth
to fit the content.
It respects the table context, a margin to add and a maximum width. This
is typically called in response to a user gesture to adjust the column's
width to the "widest" cell content of a column.
This implementation loops through all rows of the given column and measures the renderers pref width (it's a potential performance sink). Subclasses can override to implement a different strategy.
Note: though 2 * margin is added as spacing, this does not imply a left/right symmetry - it's up to the table to place the renderer and/or the renderer/highlighter to configure a border.
PENDING: support pack for hidden column? This implementation can't handle it! For now, added doc and fail-fast.
table
- the context the column will live in.columnExt
- the column to configure.margin
- the extra spacing to add twice, if -1 uses this factories
defaultmax
- an upper limit to preferredWidth, -1 is interpreted as no
limitIllegalStateException
- if column is not visiblesetDefaultPackMargin(int)
,
JXTable.packTable(int)
,
JXTable.packColumn(int, int)
protected int getRowCount(JXTable table)
Subclasses can override to reduce the number (for performance) or support
restrictions due to lazy loading, f.i. Implementors must guarantee that
view row access with 0 <= row < getRowCount(JXTable)
succeeds.
table
- the table to accesspublic int getDefaultPackMargin()
setDefaultPackMargin(int)
public void setDefaultPackMargin(int margin)
Note: this is not really a margin in the sense of symmetrically adding white space to the left/right of a cell's content. It's simply an amount of space which is added twice to the measured widths in packColumn.
margin
- the default marging to use in packColumn.getDefaultPackMargin()
,
packColumn(JXTable, TableColumnExt, int, int)
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses