Package docking.widgets.table
Class MappedTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- java.lang.Object
-
- docking.widgets.table.AbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
-
- docking.widgets.table.MappedTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
-
- Type Parameters:
ROW_TYPE
- The table's actual row typeEXPECTED_ROW_TYPE
- The row type expected by the givenDynamicTableColumn
COLUMN_TYPE
- The column type provided by the givenDynamicTableColumn
DATA_SOURCE
- the type of the data for each column; can be Object for columns that do not have a data source
- All Implemented Interfaces:
DynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Direct Known Subclasses:
MappedProgramLocationTableColumn
,ProgramMappedTableColumn
public class MappedTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> extends AbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
A class that is an Adapter in order to allow for the use of existingDynamicTableColumn
s when the actual row type of the table is not the same as the row type that theDynamicTableColumn
supports.
-
-
Field Summary
Fields Modifier and Type Field Description protected TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE>
mapper
protected DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
tableColumn
-
Fields inherited from class docking.widgets.table.AbstractDynamicTableColumn
FLOATING_POINT_PRECISION_SETTING, FLOATING_POINT_SETTINGS_DEFINITIONS, INTEGER_RADIX_SETTING, INTEGER_SETTINGS_DEFINITIONS, INTEGER_SIGNEDNESS_MODE_SETTING, NO_SETTINGS_DEFINITIONS
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
MappedTableColumn(TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE> mapper, DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> tableColumn)
protected
MappedTableColumn(TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE> mapper, DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> tableColumn, java.lang.String uniqueIdentifier)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class<COLUMN_TYPE>
getColumnClass()
Determines the class of object that is associated with this field (column).java.lang.String
getColumnDescription()
Returns a description of this column.java.lang.String
getColumnDisplayName(Settings settings)
Determines the column heading that will be displayed.java.lang.String
getColumnName()
Determines the unique column heading that may be used to identify a column instance.int
getColumnPreferredWidth()
Returns the preferred width for this column.GColumnRenderer<COLUMN_TYPE>
getColumnRenderer()
Returns the optional cell renderer for this column; null if no renderer is used.java.util.Comparator<COLUMN_TYPE>
getComparator()
If implemented, will return a comparator that knows how to sort values for this column.java.lang.Class<?>
getMappedColumnClass()
Returns the class of the column that this mapper wrapsint
getMaxLines(Settings settings)
Gets the maximum number of text display lines needed for any given cell with the specified settings.SettingsDefinition[]
getSettingsDefinitions()
Returns a list of settings definitions for this field.java.lang.Class<ROW_TYPE>
getSupportedRowType()
Returns the single class type of the data that this table field can use to generate columnar data.COLUMN_TYPE
getValue(ROW_TYPE rowObject, Settings settings, DATA_SOURCE data, ServiceProvider serviceProvider)
Creates an object that is appropriate for this field (table column) and for the object that is associated with this row of the table.java.lang.String
toString()
-
Methods inherited from class docking.widgets.table.AbstractDynamicTableColumn
equals, getUniqueIdentifier, hashCode
-
-
-
-
Field Detail
-
mapper
protected final TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE> mapper
-
tableColumn
protected final DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> tableColumn
-
-
Constructor Detail
-
MappedTableColumn
protected MappedTableColumn(TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE> mapper, DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> tableColumn)
-
MappedTableColumn
protected MappedTableColumn(TableRowMapper<ROW_TYPE,EXPECTED_ROW_TYPE,DATA_SOURCE> mapper, DynamicTableColumn<EXPECTED_ROW_TYPE,COLUMN_TYPE,DATA_SOURCE> tableColumn, java.lang.String uniqueIdentifier)
-
-
Method Detail
-
getMappedColumnClass
public java.lang.Class<?> getMappedColumnClass()
Returns the class of the column that this mapper wraps- Returns:
- the class of the column that this mapper wraps
-
getColumnClass
public java.lang.Class<COLUMN_TYPE> getColumnClass()
Description copied from interface:DynamicTableColumn
Determines the class of object that is associated with this field (column).- Specified by:
getColumnClass
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getColumnClass
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the column class
-
getSupportedRowType
public java.lang.Class<ROW_TYPE> getSupportedRowType()
Description copied from interface:DynamicTableColumn
Returns the single class type of the data that this table field can use to generate columnar data.- Specified by:
getSupportedRowType
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getSupportedRowType
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the single class type of the data that this table field can use to generate columnar data.
-
getColumnDisplayName
public java.lang.String getColumnDisplayName(Settings settings)
Description copied from interface:DynamicTableColumn
Determines the column heading that will be displayed.- Specified by:
getColumnDisplayName
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getColumnDisplayName
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Parameters:
settings
- the settings- Returns:
- the field name to display as the column heading.
-
getColumnDescription
public java.lang.String getColumnDescription()
Description copied from interface:DynamicTableColumn
Returns a description of this column. This may be used as a tooltip for the column header- Specified by:
getColumnDescription
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getColumnDescription
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- a description of this column. This may be used as a tooltip for the column header.
-
getColumnName
public java.lang.String getColumnName()
Description copied from interface:DynamicTableColumn
Determines the unique column heading that may be used to identify a column instance. This name must be non-changing and is used to save/restore state information.- Specified by:
getColumnName
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Specified by:
getColumnName
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the field instance name.
-
getMaxLines
public int getMaxLines(Settings settings)
Description copied from interface:DynamicTableColumn
Gets the maximum number of text display lines needed for any given cell with the specified settings.- Specified by:
getMaxLines
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getMaxLines
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Parameters:
settings
- field settings- Returns:
- maximum number of lines needed
-
getColumnRenderer
public GColumnRenderer<COLUMN_TYPE> getColumnRenderer()
Description copied from interface:DynamicTableColumn
Returns the optional cell renderer for this column; null if no renderer is used.This method allows columns to define custom rendering. The interface returned here ensures that the text used for filtering matches what the users sees (via the
GColumnRenderer.getFilterString(Object, Settings)
method).Note: some types should not make use of the aforementioned filter string. These types include the
Number
wrapper types,Date
andEnum
s. (This is because the filtering system works naturally with these types.) SeeGColumnRenderer
.- Specified by:
getColumnRenderer
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getColumnRenderer
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the renderer
-
getSettingsDefinitions
public SettingsDefinition[] getSettingsDefinitions()
Description copied from interface:DynamicTableColumn
Returns a list of settings definitions for this field.- Specified by:
getSettingsDefinitions
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getSettingsDefinitions
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- list of settings definitions for this field.
-
getColumnPreferredWidth
public int getColumnPreferredWidth()
Description copied from interface:DynamicTableColumn
Returns the preferred width for this column. Column should either return a valid positive preferred size or -1.- Specified by:
getColumnPreferredWidth
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getColumnPreferredWidth
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the preferred width for this column.
-
getComparator
public java.util.Comparator<COLUMN_TYPE> getComparator()
Description copied from interface:DynamicTableColumn
If implemented, will return a comparator that knows how to sort values for this column. Implementors should returnnull
if they do not wish to provider a comparator- Specified by:
getComparator
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Overrides:
getComparator
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Returns:
- the comparator
-
getValue
public COLUMN_TYPE getValue(ROW_TYPE rowObject, Settings settings, DATA_SOURCE data, ServiceProvider serviceProvider) throws java.lang.IllegalArgumentException
Description copied from interface:DynamicTableColumn
Creates an object that is appropriate for this field (table column) and for the object that is associated with this row of the table.- Specified by:
getValue
in interfaceDynamicTableColumn<ROW_TYPE,EXPECTED_ROW_TYPE,COLUMN_TYPE>
- Specified by:
getValue
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
- Parameters:
rowObject
- the object associated with the row in the table.settings
- field settingsdata
- the expected data object, as defined by the DATA_SOURCE typeserviceProvider
- theServiceProvider
associated with the table.- Returns:
- the object for the model to display in the table cell.
- Throws:
java.lang.IllegalArgumentException
- if the rowObject is not one supported by this class.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>
-
-