Class ComponentAdapter
- java.lang.Object
-
- org.jdesktop.swingx.decorator.ComponentAdapter
-
- Direct Known Subclasses:
JXList.ListAdapter
,JXTable.TableAdapter
,JXTree.TreeAdapter
public abstract class ComponentAdapter extends java.lang.Object
Abstract base class for all component data adapter classes. AComponentAdapter
allows aFilter
,Sorter
, orHighlighter
to interact with atarget
component through a common API. It has two aspects:- interact with the view state for a given data element. The row/cloumn fields and the parameterless methods service this aspect. The coordinates are in view coordinate system. Typical clients of this service are HighlightPredicates and Highlighters.
- interact with the data of the component. The methods for this are those taking row/column indices as parameters. The coordinates are in model coordinate system. Typical clients of this service are Filters.
The adapter is responsible for mapping column coordinates. All input column indices are in model coordinates with exactly two exceptions:HighlightPredicate feverWarning = new HighlightPredicate() { int temperatureColumn = 10; public boolean isHighlighted(Component component, ComponentAdapter adapter) { return hasFever(adapter.getValue(temperatureColumn)); } private boolean hasFever(Object value) { if (!value instanceof Number) return false; return ((Number) value).intValue() > 37; } }; Highlighter hl = new ColorHighlighter(feverWarning, Color.RED, null);
-
column
in column view coordinates - the mapping method
viewToModel(int)
in view coordinates
-
row
in row view coordinates - the getter for the filtered value
getFilteredValueAt(int, int)
takes the row in view coordinates. - the getter for the filtered string representation
getFilteredStringAt(int, int)
takes the row in view coordinates.
PENDING JW: anything to gain by generics here?
PENDING JW: formally document that row/column coordinates must be valid in all methods taking model coordinates, that is 0<= row < getRowCount().
- See Also:
HighlightPredicate
,Highlighter
,Filter
-
-
Field Summary
Fields Modifier and Type Field Description int
column
current column in view coordinates.static java.lang.Object
DEFAULT_COLUMN_IDENTIFIER
int
row
current row in view coordinates.protected javax.swing.JComponent
target
-
Constructor Summary
Constructors Constructor Description ComponentAdapter(javax.swing.JComponent component)
Constructs a ComponentAdapter, setting the specified component as the target component.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
getColumnCount()
Returns the number of columns in the target's data model.java.lang.Object
getColumnIdentifierAt(int columnIndex)
Returns logical identifier of the column at columnIndex in model coordinates.int
getColumnIndex(java.lang.Object identifier)
Returns the column index in model coordinates for the logical identifier.java.lang.String
getColumnName(int columnIndex)
Returns the column's display name (= headerValue) of the column at columnIndex in model coordinates.javax.swing.JComponent
getComponent()
Returns the component which is this adapter's target.int
getDepth()
Returns the depth of this row in the hierarchy where the root is 0.java.lang.String
getFilteredStringAt(int row, int column)
Returns the String representation of the filtered value of the cell identified by the row in view coordinate and the column in model coordinates.abstract java.lang.Object
getFilteredValueAt(int row, int column)
Returns the filtered value of the cell identified by the row in view coordinate and the column in model coordinates.int
getRowCount()
Returns the number of rows in the target's data model.java.lang.String
getString()
Returns the String representation of the value of the cell identified by this adapter.java.lang.String
getString(int modelColumnIndex)
Returns the String representation of the value of the cell identified by the current adapter row and the given column index in model coordinates.java.lang.String
getStringAt(int row, int column)
Returns the String representation of the value of the cell identified by the row specified row and column in model coordinates.java.lang.Object
getValue()
Returns the value of the cell identified by this adapter.java.lang.Object
getValue(int modelColumnIndex)
Returns the value of the cell identified by the current adapter row and the given column index in model coordinates.abstract java.lang.Object
getValueAt(int row, int column)
Returns the value of the target component's cell identified by the specified row and column in model coordinates.abstract boolean
hasFocus()
Returns true if the cell identified by this adapter currently has focus.abstract boolean
isCellEditable(int row, int column)
Determines whether this cell is editable.abstract boolean
isEditable()
Returnstrue
if the cell identified by this adapter is editable,false
otherwise.boolean
isExpanded()
Returns true if the cell identified by this adapter is currently expanded.boolean
isHierarchical()
Returns true if the cell identified by this adapter displays the hierarchical node.boolean
isLeaf()
Returns true if the cell identified by this adapter is a leaf node.abstract boolean
isSelected()
Returns true if the cell identified by this adapter is currently selected.boolean
isTestable(int column)
Returns true if the column should be included in testing.int
modelToView(int columnIndex)
For target components that support multiple columns in their model, along with column reordering in the view, this method transforms the specified columnIndex from model coordinates to view coordinates.void
refresh()
Updates the target component on screen.abstract void
setValueAt(java.lang.Object aValue, int row, int column)
Sets the value of the target component's cell identified by the specified row and column in model coordinates.int
viewToModel(int columnIndex)
For target components that support multiple columns in their model, along with column reordering in the view, this method transforms the specified columnIndex from view coordinates to model coordinates.
-
-
-
Method Detail
-
getComponent
public javax.swing.JComponent getComponent()
Returns the component which is this adapter's target.- Returns:
- the component which is this adapter's target.
-
getColumnName
public java.lang.String getColumnName(int columnIndex)
Returns the column's display name (= headerValue) of the column at columnIndex in model coordinates. Used f.i. in SearchPanel to fill the field with the column name.Note: it's up to the implementation to decide for which columns it returns a name - most will do so for the subset with isTestable = true. This implementation delegates to getColumnIdentifierAt and returns it's toString or null.
- Parameters:
columnIndex
- in model coordinates- Returns:
- column name or null if not found
-
getColumnIdentifierAt
public java.lang.Object getColumnIdentifierAt(int columnIndex)
Returns logical identifier of the column at columnIndex in model coordinates. Note: it's up to the implementation to decide for which columns it returns an identifier - most will do so for the subset with isTestable = true.This implementation returns DEFAULT_COLUMN_IDENTIFIER. PENDING JW: This method replaces the old getColumnIdentifier(int) which returned a String which is overly restrictive. The only way to gently replace this method was to add this with a different name - which makes this name suboptimal. Probably should rename again once the old has died out ;-)
- Parameters:
columnIndex
- in model coordinates, must be valid.- Returns:
- the identifier of the column at columnIndex or null if it has none.
- Throws:
java.lang.ArrayIndexOutOfBoundsException
- if columnIndex < 0 or columnIndex >= getColumnCount().- See Also:
getColumnIndex(Object)
-
getColumnIndex
public int getColumnIndex(java.lang.Object identifier)
Returns the column index in model coordinates for the logical identifier.This implementation returns 0 if the identifier is the same as the one known identifier returned from getColumnIdentifierAt(0), or -1 otherwise. So subclasses with one column and a customizable identifier need not override. Subclasses which support multiple columns must override this as well to keep the contract as in (assuming that the lookup succeeded):
Object id = getColumnIdentifierAt(index); assertEquals(index, getColumnIndex(index); // and the reverse int column = getColumnIndex(identifier); assertEquals(identifier, getColumnIdentifierAt(column));
- Parameters:
identifier
- the column's identifier, must not be null- Returns:
- the index of the column identified by identifier in model coordinates or -1 if no column with the given identifier is found.
- Throws:
java.lang.NullPointerException
- if identifier is null.- See Also:
getColumnIdentifierAt(int)
-
getColumnCount
public int getColumnCount()
Returns the number of columns in the target's data model.- Returns:
- the number of columns in the target's data model.
-
getRowCount
public int getRowCount()
Returns the number of rows in the target's data model.- Returns:
- the number of rows in the target's data model.
-
getValueAt
public abstract java.lang.Object getValueAt(int row, int column)
Returns the value of the target component's cell identified by the specified row and column in model coordinates.- Parameters:
row
- in model coordinatescolumn
- in model coordinates- Returns:
- the value of the target component's cell identified by the specified row and column
-
setValueAt
public abstract void setValueAt(java.lang.Object aValue, int row, int column)
Sets the value of the target component's cell identified by the specified row and column in model coordinates.- Parameters:
aValue
- the value to setrow
- in model coordinatescolumn
- in model coordinates
-
isCellEditable
public abstract boolean isCellEditable(int row, int column)
Determines whether this cell is editable.- Parameters:
row
- the row to query in model coordinatescolumn
- the column to query in model coordinates- Returns:
true
if the cell is editable,false
otherwise
-
isTestable
public boolean isTestable(int column)
Returns true if the column should be included in testing.Here: returns true if visible (that is modelToView gives a valid view column coordinate).
- Parameters:
column
- the column index in model coordinates- Returns:
- true if the column should be included in testing
-
getString
public java.lang.String getString()
Returns the String representation of the value of the cell identified by this adapter. That is, for the at position (adapter.row, adapter.column) in view coordinates.NOTE: this implementation assumes that view coordinates == model coordinates, that is simply calls getValueAt(this.row, this.column). It is up to subclasses to override appropriately is they support model/view coordinate transformation.
This implementation messages the StringValue.TO_STRING with the getValue, subclasses should re-implement and use the api appropriate for the target component type.
- Returns:
- the String representation of value of the cell identified by this adapter
- See Also:
getValueAt(int, int)
,getFilteredValueAt(int, int)
,getValue(int)
-
getString
public java.lang.String getString(int modelColumnIndex)
Returns the String representation of the value of the cell identified by the current adapter row and the given column index in model coordinates.- Parameters:
modelColumnIndex
- the column index in model coordinates- Returns:
- the String representation of the value of the cell identified by this adapter
- See Also:
getFilteredStringAt(int, int)
,getString()
-
getFilteredStringAt
public java.lang.String getFilteredStringAt(int row, int column)
Returns the String representation of the filtered value of the cell identified by the row in view coordinate and the column in model coordinates.Note: the asymetry of the coordinates is intentional - clients like Highlighters are interested in view values but might need to access non-visible columns for testing. While it is possible to access row coordinates different from the current (that is this.row) it is not safe to do so for row > this.row because the adapter doesn't allow to query the count of visible rows.
This implementation messages the StringValue.TO_STRING with the filteredValue, subclasses should re-implement and use the api appropriate for the target component type.
PENDING JW: what about null cell values? StringValue has a contract to return a empty string then, would that be okay here as well?
- Parameters:
row
- the row of the cell in view coordinatescolumn
- the column of the cell in model coordinates.- Returns:
- the String representation of the filtered value of the cell identified by the row in view coordinate and the column in model coordiantes
-
getStringAt
public java.lang.String getStringAt(int row, int column)
Returns the String representation of the value of the cell identified by the row specified row and column in model coordinates.This implementation messages the StringValue.TO_STRING with the valueAt, subclasses should re-implement and use the api appropriate for the target component type.
- Parameters:
row
- in model coordinatescolumn
- in model coordinates- Returns:
- the value of the target component's cell identified by the specified row and column
-
getValue
public java.lang.Object getValue()
Returns the value of the cell identified by this adapter. That is, for the at position (adapter.row, adapter.column) in view coordinates.NOTE: this implementation assumes that view coordinates == model coordinates, that is simply calls getValueAt(this.row, this.column). It is up to subclasses to override appropriately is they support model/view coordinate transformation.
- Returns:
- the value of the cell identified by this adapter
- See Also:
getValueAt(int, int)
,getFilteredValueAt(int, int)
,getValue(int)
-
getValue
public java.lang.Object getValue(int modelColumnIndex)
Returns the value of the cell identified by the current adapter row and the given column index in model coordinates.- Parameters:
modelColumnIndex
- the column index in model coordinates- Returns:
- the value of the cell identified by this adapter
- See Also:
getValueAt(int, int)
,getFilteredValueAt(int, int)
,getValue(int)
-
getFilteredValueAt
public abstract java.lang.Object getFilteredValueAt(int row, int column)
Returns the filtered value of the cell identified by the row in view coordinate and the column in model coordinates. Note: the asymetry of the coordinates is intentional - clients like Highlighters are interested in view values but might need to access non-visible columns for testing. While it is possible to access row coordinates different from the current (that is this.row) it is not safe to do so for row > this.row because the adapter doesn't allow to query the count of visible rows.- Parameters:
row
- the row of the cell in view coordinatescolumn
- the column of the cell in model coordinates.- Returns:
- the filtered value of the cell identified by the row in view coordinate and the column in model coordiantes
-
hasFocus
public abstract boolean hasFocus()
Returns true if the cell identified by this adapter currently has focus. Otherwise, it returns false.- Returns:
- true if the cell identified by this adapter currently has focus; Otherwise, return false
-
isSelected
public abstract boolean isSelected()
Returns true if the cell identified by this adapter is currently selected. Otherwise, it returns false.- Returns:
- true if the cell identified by this adapter is currently selected; Otherwise, return false
-
isEditable
public abstract boolean isEditable()
Returnstrue
if the cell identified by this adapter is editable,false
otherwise.- Returns:
true
if the cell is editable,false
otherwise
-
isExpanded
public boolean isExpanded()
Returns true if the cell identified by this adapter is currently expanded. Otherwise, it returns false. For components that do not support hierarchical data, this method always returns true because the cells in such components can never be collapsed.- Returns:
- true if the cell identified by this adapter is currently expanded; Otherwise, return false
-
isLeaf
public boolean isLeaf()
Returns true if the cell identified by this adapter is a leaf node. Otherwise, it returns false. For components that do not support hierarchical data, this method always returns true because the cells in such components can never have children.- Returns:
- true if the cell identified by this adapter is a leaf node; Otherwise, return false
-
isHierarchical
public boolean isHierarchical()
Returns true if the cell identified by this adapter displays the hierarchical node. Otherwise, it returns false. For components that do not support hierarchical data, this method always returns false because the cells in such components can never have children.- Returns:
- true if the cell identified by this adapter displays the hierarchical node; Otherwise, return false
-
getDepth
public int getDepth()
Returns the depth of this row in the hierarchy where the root is 0. For components that do not contain hierarchical data, this method returns 1.- Returns:
- the depth for this adapter
-
modelToView
public int modelToView(int columnIndex)
For target components that support multiple columns in their model, along with column reordering in the view, this method transforms the specified columnIndex from model coordinates to view coordinates. For all other types of target components, this method returns the columnIndex unchanged.- Parameters:
columnIndex
- index of a column in model coordinates- Returns:
- index of the specified column in view coordinates
-
viewToModel
public int viewToModel(int columnIndex)
For target components that support multiple columns in their model, along with column reordering in the view, this method transforms the specified columnIndex from view coordinates to model coordinates. For all other types of target components, this method returns the columnIndex unchanged.- Parameters:
columnIndex
- index of a column in view coordinates- Returns:
- index of the specified column in model coordinates
-
refresh
public void refresh()
Updates the target component on screen. This implementation revalidates and repaints.
-
-