Module org.tentackle.fx

Package org.tentackle.fx.table

Class DefaultTableConfiguration<S>

java.lang.Object

org.tentackle.fx.table.DefaultTableConfiguration<S>

Type Parameters:

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

All Implemented Interfaces:

TableConfiguration<S>

public class DefaultTableConfiguration<S>
extends Object
implements TableConfiguration<S>

Default implementation of a table configuration.

Author:

harald

Nested Class Summary

Nested classes/interfaces inherited from interface org.tentackle.fx.table.TableConfiguration

TableConfiguration.BINDING, TableConfiguration.EDITMODE

Constructor Summary

Constructors

Constructor	Description
DefaultTableConfiguration(Class<S> objectClass, String name)	Creates a configuration.
DefaultTableConfiguration(S template, String name)	Creates a configuration.

Method Summary

Modifier and Type	Method	Description
TableColumnConfiguration<S,?>	addColumn(String name, String displayedName)	Adds a column via binding path.
void	addColumnConfiguration(TableColumnConfiguration<S,?> columnConfiguration)	Adds a column configuration.
void	configure(FxTableView<S> table)	Configures the table.
void	configure(FxTreeTableView<S> treeTable)	Configures the treetable.
protected TableColumnConfiguration<S,?>	createTableColumnConfiguration(String name, String displayedName)	Creates a column configuration.
javafx.scene.control.TreeItem<S>	createTreeItem(S object)	Creates a tree item for a treetable.
String	getBaseBundleName()	Gets the optional resource bundle name. Used for BundleMonkey navigation only.
FxTableBinder<S>	getBinder()	Gets the table binder. Don't mix up the table's binder with the FxController's binder! The table binder is responsible to bind the cells to the model, whereas the controller binder binds the data list to the table. As a consequence, binding properties such as the DomainContext, if necessary for cell editors, must be applied to the table binder!
TableConfiguration.BINDING	getBindingType()	Gets the type of binding.
TableColumnConfiguration<S,?>	getColumnConfiguration(String name)	Gets a column configuration by its name.
TableColumnConfiguration<S,?>	getColumnConfiguration(javafx.scene.control.TableColumn<S,?> column)	Gets a column configuration by its table column.
TableColumnConfiguration<S,?>	getColumnConfiguration(javafx.scene.control.TreeTableColumn<S,?> column)	Gets a column configuration by its treetable column.
Collection<TableColumnConfiguration<S,?>>	getColumnConfigurations()	Gets the configurations of the columns.
TableConfiguration.EDITMODE	getEditMode()	Returns the edit mode.
String	getName()	Gets the name of the table. The name is also used as a key to the table preferences.
Class<S>	getObjectClass()	Gets the row object class.
<T> TableCellType<T>	getTableCellType(Class<T> type)	Gets the cell type according to the item type.
S	getTemplate()	Gets the template.
boolean	isSortingIncluded()	Returns whether the preferences include the column sorting.
boolean	isViewSizeIncluded()	Returns whether the preferences include the view size.
void	loadPreferences(FxTableView<S> table, String suffix, boolean system)	Loads the column sizes, visibility, view size and sorting from the preferences.
void	loadPreferences(FxTreeTableView<S> treeTable, String suffix, boolean system)	Loads the column sizes, visibility, view size and sorting from the preferences.
TableColumnConfiguration<S,?>	removeColumn(String name)	Removes a column via binding path.
void	savePreferences(FxTableView<S> table, String suffix, boolean system)	Saves the column sizes, visibility, view size and sorting to the preferences.
void	savePreferences(FxTreeTableView<S> treeTable, String suffix, boolean system)	Saves the column sizes, visibility, view size and sorting to the preferences.
void	setBaseBundleName(String bundleName)	Sets the optional resource bundle name.
void	setBindingType(TableConfiguration.BINDING bindingType)	Sets the type of binding.
void	setEditMode(TableConfiguration.EDITMODE editMode)	Sets the edit mode.
void	setSortingIncluded(boolean sortingIncluded)	Sets whether the preferences include the column sorting.
void	setViewSizeIncluded(boolean viewSizeIncluded)	Sets whether the preferences include the view size.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultTableConfiguration

public DefaultTableConfiguration(S template,
 String name)

Creates a configuration.

Parameters:

template - a template object

name - the table's name, null if basename from effective class of template

DefaultTableConfiguration

public DefaultTableConfiguration(Class<S> objectClass,
 String name)

Creates a configuration.

Parameters:

objectClass - the object class

name - the table's name, null if basename from effective class of template

Method Details

getTemplate

public S getTemplate()

Gets the template.

Returns:

the template, null if only class given

toString

public String toString()

Overrides:

toString in class Object

addColumn

public TableColumnConfiguration<S,?> addColumn(String name,
 String displayedName)

Description copied from interface: TableConfiguration

Adds a column via binding path.

Specified by:

addColumn in interface TableConfiguration<S>

Parameters:

name - the column's binding path

displayedName - the displayed column name

Returns:

the created column configuration

removeColumn

public TableColumnConfiguration<S,?> removeColumn(String name)

Description copied from interface: TableConfiguration

Removes a column via binding path.

Specified by:

removeColumn in interface TableConfiguration<S>

Parameters:

name - the column's binding path

Returns:

the old column configuration, null if no such column

addColumnConfiguration

public void addColumnConfiguration(TableColumnConfiguration<S,?> columnConfiguration)

Description copied from interface: TableConfiguration

Adds a column configuration.

Specified by:

addColumnConfiguration in interface TableConfiguration<S>

Parameters:

columnConfiguration - the config

getColumnConfigurations

public Collection<TableColumnConfiguration<S,?>> getColumnConfigurations()

Description copied from interface: TableConfiguration

Gets the configurations of the columns.

Specified by:

getColumnConfigurations in interface TableConfiguration<S>

Returns:

the column configurations

getColumnConfiguration

public TableColumnConfiguration<S,?> getColumnConfiguration(String name)

Description copied from interface: TableConfiguration

Gets a column configuration by its name.

Specified by:

getColumnConfiguration in interface TableConfiguration<S>

Parameters:

name - the name

Returns:

the config, null if no such name and displayed name

getColumnConfiguration

public TableColumnConfiguration<S,?> getColumnConfiguration(javafx.scene.control.TableColumn<S,?> column)

Description copied from interface: TableConfiguration

Gets a column configuration by its table column.

Specified by:

getColumnConfiguration in interface TableConfiguration<S>

Parameters:

column - the table column

Returns:

the config, null if no such column

getColumnConfiguration

public TableColumnConfiguration<S,?> getColumnConfiguration(javafx.scene.control.TreeTableColumn<S,?> column)

Description copied from interface: TableConfiguration

Gets a column configuration by its treetable column.

Specified by:

getColumnConfiguration in interface TableConfiguration<S>

Parameters:

column - the treetable column

Returns:

the config, null if no such column

getName

public String getName()

Description copied from interface: TableConfiguration

Gets the name of the table.
The name is also used as a key to the table preferences.

Specified by:

getName in interface TableConfiguration<S>

Returns:

the name, never null

isSortingIncluded

public boolean isSortingIncluded()

Description copied from interface: TableConfiguration

Returns whether the preferences include the column sorting.

Specified by:

isSortingIncluded in interface TableConfiguration<S>

Returns:

true if sorting is restored from the preferences (default is false)

setSortingIncluded

public void setSortingIncluded(boolean sortingIncluded)

Description copied from interface: TableConfiguration

Sets whether the preferences include the column sorting.

Specified by:

setSortingIncluded in interface TableConfiguration<S>

Parameters:

sortingIncluded - true if sorting is restored from the preferences (default is false)

isViewSizeIncluded

public boolean isViewSizeIncluded()

Description copied from interface: TableConfiguration

Returns whether the preferences include the view size.

Specified by:

isViewSizeIncluded in interface TableConfiguration<S>

Returns:

true if the preferred size is restored from the preferences (default is true)

setViewSizeIncluded

public void setViewSizeIncluded(boolean viewSizeIncluded)

Description copied from interface: TableConfiguration

Sets whether the preferences include the view size.

Specified by:

setViewSizeIncluded in interface TableConfiguration<S>

Parameters:

viewSizeIncluded - true if the preferred size is restored from the preferences (default is true)

savePreferences

public void savePreferences(FxTableView<S> table,
 String suffix,
 boolean system)

Description copied from interface: TableConfiguration

Saves the column sizes, visibility, view size and sorting to the preferences.

Specified by:

savePreferences in interface TableConfiguration<S>

Parameters:

table - the table

suffix - the configuration suffix, null if none

system - true if save to system prefs, else user prefs

loadPreferences

public void loadPreferences(FxTableView<S> table,
 String suffix,
 boolean system)

Description copied from interface: TableConfiguration

Loads the column sizes, visibility, view size and sorting from the preferences.

Specified by:

loadPreferences in interface TableConfiguration<S>

Parameters:

table - the table

suffix - the configuration suffix, null if none

system - true if load from system prefs only, else user prefs first

savePreferences

public void savePreferences(FxTreeTableView<S> treeTable,
 String suffix,
 boolean system)

Description copied from interface: TableConfiguration

Saves the column sizes, visibility, view size and sorting to the preferences.

Specified by:

savePreferences in interface TableConfiguration<S>

Parameters:

treeTable - the treetable

suffix - the configuration suffix, null if none

system - true if save to system prefs, else user prefs

loadPreferences

public void loadPreferences(FxTreeTableView<S> treeTable,
 String suffix,
 boolean system)

Description copied from interface: TableConfiguration

Loads the column sizes, visibility, view size and sorting from the preferences.

Specified by:

loadPreferences in interface TableConfiguration<S>

Parameters:

treeTable - the table

suffix - the configuration suffix, null if none

system - true if load from system prefs only, else user prefs first

getEditMode

public TableConfiguration.EDITMODE getEditMode()

Description copied from interface: TableConfiguration

Returns the edit mode.

Specified by:

getEditMode in interface TableConfiguration<S>

Returns:

the edit mode, never null, default is NO

setEditMode

public void setEditMode(TableConfiguration.EDITMODE editMode)

Description copied from interface: TableConfiguration

Sets the edit mode.

Specified by:

setEditMode in interface TableConfiguration<S>

Parameters:

editMode - the edit mode, null is equivalent to NO

getBaseBundleName

public String getBaseBundleName()

Description copied from interface: TableConfiguration

Gets the optional resource bundle name.
Used for BundleMonkey navigation only.

Specified by:

getBaseBundleName in interface TableConfiguration<S>

Returns:

the bundle name, null if unknown

setBaseBundleName

public void setBaseBundleName(String bundleName)

Description copied from interface: TableConfiguration

Sets the optional resource bundle name.

Specified by:

setBaseBundleName in interface TableConfiguration<S>

Parameters:

bundleName - the bundle name, null if none

configure

public void configure(FxTableView<S> table)

Description copied from interface: TableConfiguration

Configures the table.

Specified by:

configure in interface TableConfiguration<S>

Parameters:

table - the table view

configure

public void configure(FxTreeTableView<S> treeTable)

Description copied from interface: TableConfiguration

Configures the treetable.

Specified by:

configure in interface TableConfiguration<S>

Parameters:

treeTable - the treetable view

getObjectClass

public Class<S> getObjectClass()

Description copied from interface: TableConfiguration

Gets the row object class.

Specified by:

getObjectClass in interface TableConfiguration<S>

Returns:

the row object class

getBindingType

public TableConfiguration.BINDING getBindingType()

Description copied from interface: TableConfiguration

Gets the type of binding.

Specified by:

getBindingType in interface TableConfiguration<S>

Returns:

the binding type

setBindingType

public void setBindingType(TableConfiguration.BINDING bindingType)

Description copied from interface: TableConfiguration

Sets the type of binding.

Specified by:

setBindingType in interface TableConfiguration<S>

Parameters:

bindingType - the binding type

getBinder

public FxTableBinder<S> getBinder()

Description copied from interface: TableConfiguration

Gets the table binder.
Don't mix up the table's binder with the FxController's binder! The table binder is responsible to bind the cells to the model, whereas the controller binder binds the data list to the table.
As a consequence, binding properties such as the DomainContext, if necessary for cell editors, must be applied to the table binder!

Specified by:

getBinder in interface TableConfiguration<S>

Returns:

the binder

getTableCellType

public <T> TableCellType<T> getTableCellType(Class<T> type)

Description copied from interface: TableConfiguration

Gets the cell type according to the item type.

Specified by:

getTableCellType in interface TableConfiguration<S>

Type Parameters:

T - the item type

Parameters:

type - the item class

Returns:

the cell type, never null

createTreeItem

public javafx.scene.control.TreeItem<S> createTreeItem(S object)

Description copied from interface: TableConfiguration

Creates a tree item for a treetable.

Specified by:

createTreeItem in interface TableConfiguration<S>

Parameters:

object - the object to wrap

Returns:

the tree item

createTableColumnConfiguration

protected TableColumnConfiguration<S,?> createTableColumnConfiguration(String name,
 String displayedName)

Creates a column configuration.

Parameters:

name - the column's binding path

displayedName - the displayed column name

Returns:

the created column configuration