com.github.hypfvieh.util.fx

Class TableViewCopyAndPaste<S>

java.lang.Object

com.github.hypfvieh.util.fx.TableViewCopyAndPaste<S>

Type Parameters:

S - type of the given TableView

public class TableViewCopyAndPaste<S>
extends Object

Utility to enable copy and paste features on table views.
Uses two Maps with formatters to map String to underlying object or map Object to String.

Every formatter in the map will be used for the column index it is specified for.
Column indices starts with 0.

For converting an object to String for copying:
The provided lambda function will receive the value of of the observerable field from the table row/column if the value is not null.
It is expected to return a string representation of the given value, if null is returned, null will be converted to String, so use empty String if cell should be empty.
If no formatter for the given cell can be found in the copyColumnFormatters Map, object.toString() is used.

Converting from String to Object:
The provided lambda function will receive the String value from the clipboard for the column, it may be incompatible with the expected format, so please check carefully if you are able to convert the value. If not return null.
It is possible that not every formatter is called if the received String does not contain as many columns as expected by the table.
Pasting will only fill as much rows as rows are present from the starting from current selected row.
Additional rows only be added if a itemFactory is provided during construction (used to create new empty lines).

The copy/paste format is tab-separated (\t) columns, lines are expected to end with line-break (\n).

Version:

1.0.6 - 2019-10-01

Author:

hypfvieh

Method Summary

Modifier and Type	Method and Description
TableViewCopyAndPaste<S>	addCopyColumnFormatter(int _colNo, Function<Object,String> _formatFunc) Add a formatter for copying cells to clipboard.
TableViewCopyAndPaste<S>	addPasteColumnFormatter(int _colNo, Function<String,Object> _formatFunc) Add a formatter for pasting clipboard values to table.
static <S> TableViewCopyAndPaste<S>	create(Class<S> _tblViewGenericClass) Create a new utility instance.
void	install(javafx.scene.control.TableView<S> _tableView) Install the created copy and paste listener on the given table.
TableViewCopyAndPaste<S>	setAllowPasteAtTheEnd(boolean _allowPasteAtTheEnd) Enable/disable pasting results at the end of the table if no selection has been applied.
TableViewCopyAndPaste<S>	setEnablePaste(boolean _enablePaste) Enable/disable paste support on table.
TableViewCopyAndPaste<S>	setItemFactory(Supplier<S> _itemFactory) Configure ItemFactory for creating new lines.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <S> TableViewCopyAndPaste<S> create(Class<S> _tblViewGenericClass)

Create a new utility instance.

Type Parameters:

S - type of table view content

Parameters:

_tblViewGenericClass - class used in the TableView

Returns:

this

setItemFactory

public TableViewCopyAndPaste<S> setItemFactory(Supplier<S> _itemFactory)

Configure ItemFactory for creating new lines. Use null to disable.

Parameters:

_itemFactory - itemfactory to use

Returns:

this for chaining

setEnablePaste

public TableViewCopyAndPaste<S> setEnablePaste(boolean _enablePaste)

Enable/disable paste support on table.

Parameters:

_enablePaste - true to enable paste feature, false to disable

Returns:

this for chaining

setAllowPasteAtTheEnd

public TableViewCopyAndPaste<S> setAllowPasteAtTheEnd(boolean _allowPasteAtTheEnd)

Enable/disable pasting results at the end of the table if no selection has been applied.

Parameters:

_allowPasteAtTheEnd - true to add pasted content to table ending if no selection. Only used if paste is enabled.

Returns:

this for chaining

addCopyColumnFormatter

public TableViewCopyAndPaste<S> addCopyColumnFormatter(int _colNo,
                                                       Function<Object,String> _formatFunc)

Add a formatter for copying cells to clipboard.

Parameters:

_colNo - column index (0-based)

_formatFunc - formatting lambda

Returns:

this for chaining

addPasteColumnFormatter

public TableViewCopyAndPaste<S> addPasteColumnFormatter(int _colNo,
                                                        Function<String,Object> _formatFunc)

Add a formatter for pasting clipboard values to table.

Parameters:

_colNo - column index (0-based)

_formatFunc - formatting lambda

Returns:

this for chaining

install

public void install(javafx.scene.control.TableView<S> _tableView)

Install the created copy and paste listener on the given table.

Parameters:

_tableView - TableView, never null