Class DefaultTableColumnConfiguration<S,T>

java.lang.Object

org.tentackle.fx.table.DefaultTableColumnConfiguration<S,T>

Type Parameters:

S - type of the objects contained within the table's item list

T - type of the content in all cells in this column

All Implemented Interfaces:

TableColumnConfiguration<S,T>

Direct Known Subclasses:

RdcTableColumnConfiguration

public class DefaultTableColumnConfiguration<S,T>
extends Object
implements TableColumnConfiguration<S,T>

Default configuration for a table column.
The setters follow a fluent API style, i.e., they return the current instance.

Author:

harald

Constructor Summary

Constructors

Constructor	Description
DefaultTableColumnConfiguration(DefaultTableConfiguration<S> tableConfiguration, String name, String displayedName)	Create a column config.

Method Summary

Modifier and Type	Method	Description
protected javafx.scene.control.TableCell<S,T>	createTableCell(javafx.scene.control.TableColumn<S,T> column)	Creates a table cell. The method reference can directly be used as a cell factory.
protected javafx.beans.value.ObservableValue<T>	createTableCellValue(javafx.scene.control.TableColumn.CellDataFeatures<S,T> cdf)	Creates the cell value for a given row object.
protected javafx.util.Callback<javafx.scene.control.TableColumn.CellDataFeatures<S,T>, javafx.beans.value.ObservableValue<T>>	createTableCellValueFactory()	Creates the cell value factory.
protected FxTableColumn<S,T>	createTableColumn()	Creates the table column.
protected javafx.scene.control.TreeTableCell<S,T>	createTreeTableCell(javafx.scene.control.TreeTableColumn<S,T> column)	Creates a treetable cell. The method reference can directly be used as a cell factory.
protected javafx.util.Callback<javafx.scene.control.TreeTableColumn<S,T>, javafx.scene.control.TreeTableCell<S,T>>	createTreeTableCellFactory()	Creates the treetable cell factory.
protected javafx.beans.value.ObservableValue<T>	createTreeTableCellValue(javafx.scene.control.TreeTableColumn.CellDataFeatures<S,T> cdf)	Creates the treetable cell value for a given row object.
protected javafx.util.Callback<javafx.scene.control.TreeTableColumn.CellDataFeatures<S,T>, javafx.beans.value.ObservableValue<T>>	createTreeTableCellValueFactory()	Creates the tree table cell value factory.
protected FxTreeTableColumn<S,T>	createTreeTableColumn()	Creates the tree table column.
javafx.geometry.Pos	getAlignment()	Defines the alignment of the column.
FxTableBinding<S,T>	getBinding()	Gets the binding for this column.
Boolean	getCaseConversion()	Gets the case conversion.
TableCellType<T>	getCellType()	Gets the specific table cell type.
DateTimeFormatter	getDateTimeFormatter()	Gets the date or time formatter.
String	getDisplayedName()	Gets the column name displayed in the column header.
Boolean	getEditable()	Returns whether the column is editable.
FxComponent	getEditor()	Gets the editor component.
Boolean	getFilterable()	Returns whether the column provides a filter UI in its header.
Type	getGenericType()	Gets the generic type.
String	getInvalidChars()	Gets invalid characters.
Integer	getMaxColumns()	Gets the maximum columns for text cell editors.
String	getName()	Gets the column name. This is usually the binding path. The name is also used as a key to the table preferences.
DecimalFormat	getNumberFormat()	Gets the number format.
String	getPattern()	Defines the format for numeric or date/time-types. If null is returned, a default format will be used according to the column class.
Integer	getScale()	Gets the scale for fractional numeric cell editors.
Boolean	getSummable()	Returns whether the column is summable.
protected javafx.util.Callback<javafx.scene.control.TableColumn<S,T>, javafx.scene.control.TableCell<S,T>>	getTableCellFactory()	Gets the cell factory.
FxTableColumn<S,T>	getTableColumn()	Gets or creates the table column. Used if configuration applies to a TableView.
DefaultTableConfiguration<S>	getTableConfiguration()	Gets the table configuration.
FxTreeTableColumn<S,T>	getTreeTableColumn()	Gets or creates the tree table column. Used if configuration applies to a TreeTableView.
Class<T>	getType()	Determines the class for a given column.
String	getValidChars()	Gets allowed characters.
Boolean	isAutoSelect()	Gets the autoselect flag.
Boolean	isBlankZero()	Defines the blankzero attribute of the column.
boolean	isEditable()	Returns whether the column is editable.
boolean	isSummable()	Determines whether the column is summable.
Boolean	isUnsigned()	Returns whether a numeric field is unsigned or signed.
TableColumnConfiguration<S,T>	setAlignment(javafx.geometry.Pos alignment)	Sets the alignment within the cell.
TableColumnConfiguration<S,T>	setAutoSelect(Boolean autoSelect)	Sets the autoselect feature.
TableColumnConfiguration<S,T>	setBinding(FxTableBinding<S,T> binding)	Sets the binding.
TableColumnConfiguration<S,T>	setBlankZero(Boolean blankZero)	Sets whether to blank out numeric zero values.
TableColumnConfiguration<S,T>	setCaseConversion(Boolean caseConversion)	Sets the case conversion.
TableColumnConfiguration<S,T>	setCellType(TableCellType<T> cellType)	Sets the specific table cell type.
TableColumnConfiguration<S,T>	setDisplayedName(String displayedName)	Sets the column name displayed in the column header.
TableColumnConfiguration<S,T>	setEditable(Boolean editable)	Sets whether the column is editable.
TableColumnConfiguration<S,T>	setEditor(FxComponent editor)	Sets the editor component.
TableColumnConfiguration<S,T>	setFilterable(Boolean filterable)	Sets whether the column provides a filter UI in its header.
void	setGenericType(Type genericType)	Sets the generic type.
TableColumnConfiguration<S,T>	setInvalidChars(String invalidChars)	Sets invalid characters.
TableColumnConfiguration<S,T>	setMaxColumns(Integer maxColumns)	Sets the max columns.
TableColumnConfiguration<S,T>	setPattern(String pattern)	Sets the formatting string.
TableColumnConfiguration<S,T>	setScale(Integer scale)	Sets the numeric scale.
TableColumnConfiguration<S,T>	setSummable(Boolean summable)	Sets whether the column is summable.
void	setType(Class<T> type)	Sets the column type.
TableColumnConfiguration<S,T>	setUnsigned(Boolean unsigned)	Sets whether a numeric field is unsigned or signed.
TableColumnConfiguration<S,T>	setValidChars(String validChars)	Sets allowed characters.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface TableColumnConfiguration

getEffectiveCellType, getGraphic, getText, isFilterable

Constructor Details

DefaultTableColumnConfiguration

public DefaultTableColumnConfiguration(DefaultTableConfiguration<S> tableConfiguration,
 String name,
 String displayedName)

Create a column config.

Parameters:

tableConfiguration - the table config

name - the column's binding path

displayedName - the displayed column name

Method Details

toString

public String toString()

Overrides:

toString in class Object

getTableConfiguration

public DefaultTableConfiguration<S> getTableConfiguration()

Description copied from interface: TableColumnConfiguration

Gets the table configuration.

Specified by:

getTableConfiguration in interface TableColumnConfiguration<S,T>

Returns:

the table configuration

getName

public String getName()

Description copied from interface: TableColumnConfiguration

Gets the column name.
This is usually the binding path.
The name is also used as a key to the table preferences.

Specified by:

getName in interface TableColumnConfiguration<S,T>

Returns:

the name of the column

getDisplayedName

public String getDisplayedName()

Description copied from interface: TableColumnConfiguration

Gets the column name displayed in the column header.

Specified by:

getDisplayedName in interface TableColumnConfiguration<S,T>

Returns:

the display name of the column

setDisplayedName

public TableColumnConfiguration<S,T> setDisplayedName(String displayedName)

Description copied from interface: TableColumnConfiguration

Sets the column name displayed in the column header.

Specified by:

setDisplayedName in interface TableColumnConfiguration<S,T>

Parameters:

displayedName - the display name of the column

Returns:

this configuration

setType

public void setType(Class<T> type)

Description copied from interface: TableColumnConfiguration

Sets the column type.

Specified by:

setType in interface TableColumnConfiguration<S,T>

Parameters:

type - the type

getType

public Class<T> getType()

Description copied from interface: TableColumnConfiguration

Determines the class for a given column.

Specified by:

getType in interface TableColumnConfiguration<S,T>

Returns:

the column class

setGenericType

public void setGenericType(Type genericType)

Description copied from interface: TableColumnConfiguration

Sets the generic type.

Specified by:

setGenericType in interface TableColumnConfiguration<S,T>

Parameters:

genericType - the generic type

getGenericType

public Type getGenericType()

Description copied from interface: TableColumnConfiguration

Gets the generic type.

Specified by:

getGenericType in interface TableColumnConfiguration<S,T>

Returns:

the generic type

getCellType

public TableCellType<T> getCellType()

Description copied from interface: TableColumnConfiguration

Gets the specific table cell type.

Specified by:

getCellType in interface TableColumnConfiguration<S,T>

Returns:

the cell type, null to determine from the column type

See Also:

• TableColumnConfiguration.getName()

setCellType

public TableColumnConfiguration<S,T> setCellType(TableCellType<T> cellType)

Description copied from interface: TableColumnConfiguration

Sets the specific table cell type.

Specified by:

setCellType in interface TableColumnConfiguration<S,T>

Parameters:

cellType - the cell type, null to determine from the column type

Returns:

this configuration

setPattern

public TableColumnConfiguration<S,T> setPattern(String pattern)

Description copied from interface: TableColumnConfiguration

Sets the formatting string.

Specified by:

setPattern in interface TableColumnConfiguration<S,T>

Parameters:

pattern - the format pattern

Returns:

this configuration

getPattern

public String getPattern()

Description copied from interface: TableColumnConfiguration

Defines the format for numeric or date/time-types.
If null is returned, a default format will be used according to the column class.

Specified by:

getPattern in interface TableColumnConfiguration<S,T>

Returns:

the format pattern or null if default

getNumberFormat

public DecimalFormat getNumberFormat()

Description copied from interface: TableColumnConfiguration

Gets the number format.

Specified by:

getNumberFormat in interface TableColumnConfiguration<S,T>

Returns:

the number format, null if default

getDateTimeFormatter

public DateTimeFormatter getDateTimeFormatter()

Description copied from interface: TableColumnConfiguration

Gets the date or time formatter.

Specified by:

getDateTimeFormatter in interface TableColumnConfiguration<S,T>

Returns:

the formatter, null if default

setAlignment

public TableColumnConfiguration<S,T> setAlignment(javafx.geometry.Pos alignment)

Description copied from interface: TableColumnConfiguration

Sets the alignment within the cell.

Specified by:

setAlignment in interface TableColumnConfiguration<S,T>

Parameters:

alignment - the alignment

Returns:

this configuration

getAlignment

public javafx.geometry.Pos getAlignment()

Description copied from interface: TableColumnConfiguration

Defines the alignment of the column.

Specified by:

getAlignment in interface TableColumnConfiguration<S,T>

Returns:

the alignment or null if default

setBlankZero

public TableColumnConfiguration<S,T> setBlankZero(Boolean blankZero)

Description copied from interface: TableColumnConfiguration

Sets whether to blank out numeric zero values.

Specified by:

setBlankZero in interface TableColumnConfiguration<S,T>

Parameters:

blankZero - true if blank zeros, false if not, null to use default from the editor

Returns:

this configuration

isBlankZero

public Boolean isBlankZero()

Description copied from interface: TableColumnConfiguration

Defines the blankzero attribute of the column.

Specified by:

isBlankZero in interface TableColumnConfiguration<S,T>

Returns:

true if blank zeros, false if not, null to use default from the editor

isUnsigned

public Boolean isUnsigned()

Description copied from interface: TableColumnConfiguration

Returns whether a numeric field is unsigned or signed.

Specified by:

isUnsigned in interface TableColumnConfiguration<S,T>

Returns:

true if unsigned, null to use default from the editor

setUnsigned

public TableColumnConfiguration<S,T> setUnsigned(Boolean unsigned)

Description copied from interface: TableColumnConfiguration

Sets whether a numeric field is unsigned or signed.

Specified by:

setUnsigned in interface TableColumnConfiguration<S,T>

Parameters:

unsigned - true if unsigned, null to use default from the editor

Returns:

this configuration

getValidChars

public String getValidChars()

Description copied from interface: TableColumnConfiguration

Gets allowed characters.

Specified by:

getValidChars in interface TableColumnConfiguration<S,T>

Returns:

the valid characters, null to use default from the editor

setValidChars

public TableColumnConfiguration<S,T> setValidChars(String validChars)

Description copied from interface: TableColumnConfiguration

Sets allowed characters.

Specified by:

setValidChars in interface TableColumnConfiguration<S,T>

Parameters:

validChars - the valid characters, null to use default from the editor

Returns:

this configuration

getInvalidChars

public String getInvalidChars()

Description copied from interface: TableColumnConfiguration

Gets invalid characters.

Specified by:

getInvalidChars in interface TableColumnConfiguration<S,T>

Returns:

the invalid characters, null to use default from the editor

setInvalidChars

public TableColumnConfiguration<S,T> setInvalidChars(String invalidChars)

Description copied from interface: TableColumnConfiguration

Sets invalid characters.

Specified by:

setInvalidChars in interface TableColumnConfiguration<S,T>

Parameters:

invalidChars - the invalid characters, null to use default from the editor

Returns:

this configuration

setAutoSelect

public TableColumnConfiguration<S,T> setAutoSelect(Boolean autoSelect)

Description copied from interface: TableColumnConfiguration

Sets the autoselect feature.

Specified by:

setAutoSelect in interface TableColumnConfiguration<S,T>

Parameters:

autoSelect - true if autoselect, false if not, null to use default from the editor

Returns:

this configuration

isAutoSelect

public Boolean isAutoSelect()

Description copied from interface: TableColumnConfiguration

Gets the autoselect flag.

Specified by:

isAutoSelect in interface TableColumnConfiguration<S,T>

Returns:

true if autoselect, false if not, null to use default from the editor

setMaxColumns

public TableColumnConfiguration<S,T> setMaxColumns(Integer maxColumns)

Description copied from interface: TableColumnConfiguration

Sets the max columns.

Specified by:

setMaxColumns in interface TableColumnConfiguration<S,T>

Parameters:

maxColumns - the max columns, null if not defined

Returns:

this configuration

getMaxColumns

public Integer getMaxColumns()

Description copied from interface: TableColumnConfiguration

Gets the maximum columns for text cell editors.

Specified by:

getMaxColumns in interface TableColumnConfiguration<S,T>

Returns:

the max columns, null if not defined

setScale

public TableColumnConfiguration<S,T> setScale(Integer scale)

Description copied from interface: TableColumnConfiguration

Sets the numeric scale.

Specified by:

setScale in interface TableColumnConfiguration<S,T>

Parameters:

scale - the scale, null if not defined

Returns:

this configuration

getScale

public Integer getScale()

Description copied from interface: TableColumnConfiguration

Gets the scale for fractional numeric cell editors.

Specified by:

getScale in interface TableColumnConfiguration<S,T>

Returns:

the scale, null if not defined

setCaseConversion

public TableColumnConfiguration<S,T> setCaseConversion(Boolean caseConversion)

Description copied from interface: TableColumnConfiguration

Sets the case conversion.

Specified by:

setCaseConversion in interface TableColumnConfiguration<S,T>

Parameters:

caseConversion - true = convert to uppercase, false = lowercase, null = no conversion (default)

Returns:

this configuration

getCaseConversion

public Boolean getCaseConversion()

Description copied from interface: TableColumnConfiguration

Gets the case conversion.

Specified by:

getCaseConversion in interface TableColumnConfiguration<S,T>

Returns:

true = convert to uppercase, false = lowercase, null = no conversion (default)

isSummable

public boolean isSummable()

Description copied from interface: TableColumnConfiguration

Determines whether the column is summable.

Specified by:

isSummable in interface TableColumnConfiguration<S,T>

Returns:

true if the column is summable

setSummable

public TableColumnConfiguration<S,T> setSummable(Boolean summable)

Description copied from interface: TableColumnConfiguration

Sets whether the column is summable.

Specified by:

setSummable in interface TableColumnConfiguration<S,T>

Parameters:

summable - Boolean.TRUE if summable, Boolean.FALSE if not, NULL to derive from type

Returns:

this configuration

getSummable

public Boolean getSummable()

Description copied from interface: TableColumnConfiguration

Returns whether the column is summable.

Specified by:

getSummable in interface TableColumnConfiguration<S,T>

Returns:

Boolean.TRUE if summable, Boolean.FALSE if not, NULL to derive from type

setFilterable

public TableColumnConfiguration<S,T> setFilterable(Boolean filterable)

Description copied from interface: TableColumnConfiguration

Sets whether the column provides a filter UI in its header.

Specified by:

setFilterable in interface TableColumnConfiguration<S,T>

Parameters:

filterable - Boolean.FALSE to suppress the filter for this column, else null or Boolean.TRUE

Returns:

this configuration

getFilterable

public Boolean getFilterable()

Description copied from interface: TableColumnConfiguration

Returns whether the column provides a filter UI in its header.

Specified by:

getFilterable in interface TableColumnConfiguration<S,T>

Returns:

Boolean.FALSE if the filter is suppressed for this column, else null or Boolean.TRUE

isEditable

public boolean isEditable()

Description copied from interface: TableColumnConfiguration

Returns whether the column is editable.

Specified by:

isEditable in interface TableColumnConfiguration<S,T>

Returns:

true if editable, the default is false

getEditable

public Boolean getEditable()

Description copied from interface: TableColumnConfiguration

Returns whether the column is editable.

Specified by:

getEditable in interface TableColumnConfiguration<S,T>

Returns:

Boolean.TRUE if editable, Boolean.FALSE if not, NULL if depends on table configuration

setEditable

public TableColumnConfiguration<S,T> setEditable(Boolean editable)

Description copied from interface: TableColumnConfiguration

Sets whether the column is editable.

Specified by:

setEditable in interface TableColumnConfiguration<S,T>

Parameters:

editable - Boolean.TRUE if editable, Boolean.FALSE if not, NULL if depends on table configuration

Returns:

this configuration

getEditor

public FxComponent getEditor()

Description copied from interface: TableColumnConfiguration

Gets the editor component.

Specified by:

getEditor in interface TableColumnConfiguration<S,T>

Returns:

the editor; null to use default from TableCellType.getEditor()

setEditor

public TableColumnConfiguration<S,T> setEditor(FxComponent editor)

Description copied from interface: TableColumnConfiguration

Sets the editor component.

Specified by:

setEditor in interface TableColumnConfiguration<S,T>

Parameters:

editor - the editor; null to use default from TableCellType.getEditor()

Returns:

this configuration

setBinding

public TableColumnConfiguration<S,T> setBinding(FxTableBinding<S,T> binding)

Description copied from interface: TableColumnConfiguration

Sets the binding.

Specified by:

setBinding in interface TableColumnConfiguration<S,T>

Parameters:

binding - the binding

Returns:

this configuration

getBinding

public FxTableBinding<S,T> getBinding()

Description copied from interface: TableColumnConfiguration

Gets the binding for this column.

Specified by:

getBinding in interface TableColumnConfiguration<S,T>

Returns:

the binding, null if none

getTableColumn

public FxTableColumn<S,T> getTableColumn()

Description copied from interface: TableColumnConfiguration

Gets or creates the table column.
Used if configuration applies to a TableView.

Specified by:

getTableColumn in interface TableColumnConfiguration<S,T>

Returns:

the table column, never null

getTreeTableColumn

public FxTreeTableColumn<S,T> getTreeTableColumn()

Description copied from interface: TableColumnConfiguration

Gets or creates the tree table column.
Used if configuration applies to a TreeTableView.

Specified by:

getTreeTableColumn in interface TableColumnConfiguration<S,T>

Returns:

the tree table column, never null

createTableCellValue

protected javafx.beans.value.ObservableValue<T> createTableCellValue(javafx.scene.control.TableColumn.CellDataFeatures<S,T> cdf)

Creates the cell value for a given row object.

Parameters:

cdf - the cell data features

Returns:

the cell value to display

createTableCellValueFactory

protected javafx.util.Callback<javafx.scene.control.TableColumn.CellDataFeatures<S,T>, javafx.beans.value.ObservableValue<T>> createTableCellValueFactory()

Creates the cell value factory.

Returns:

the value factory

createTableCell

protected javafx.scene.control.TableCell<S,T> createTableCell(javafx.scene.control.TableColumn<S,T> column)

Creates a table cell.
The method reference can directly be used as a cell factory.

Parameters:

column - the table column

Returns:

the table cell

getTableCellFactory

protected javafx.util.Callback<javafx.scene.control.TableColumn<S,T>, javafx.scene.control.TableCell<S,T>> getTableCellFactory()

Gets the cell factory.

Returns:

the cell factory

createTableColumn

protected FxTableColumn<S,T> createTableColumn()

Creates the table column.

Returns:

the table column

createTreeTableCellValue

protected javafx.beans.value.ObservableValue<T> createTreeTableCellValue(javafx.scene.control.TreeTableColumn.CellDataFeatures<S,T> cdf)

Creates the treetable cell value for a given row object.

Parameters:

cdf - the cell data features

Returns:

the cell value to display

createTreeTableCellValueFactory

protected javafx.util.Callback<javafx.scene.control.TreeTableColumn.CellDataFeatures<S,T>, javafx.beans.value.ObservableValue<T>> createTreeTableCellValueFactory()

Creates the tree table cell value factory.

Returns:

the value factory

createTreeTableCell

protected javafx.scene.control.TreeTableCell<S,T> createTreeTableCell(javafx.scene.control.TreeTableColumn<S,T> column)

Creates a treetable cell.
The method reference can directly be used as a cell factory.

Parameters:

column - the table column

Returns:

the table cell

createTreeTableCellFactory

protected javafx.util.Callback<javafx.scene.control.TreeTableColumn<S,T>, javafx.scene.control.TreeTableCell<S,T>> createTreeTableCellFactory()

Creates the treetable cell factory.

Returns:

the cell factory

createTreeTableColumn

protected FxTreeTableColumn<S,T> createTreeTableColumn()

Creates the tree table column.

Returns:

the tree table column