org.tentackle.fx.rdc.table

Class TablePopup<S>

java.lang.Object

org.tentackle.fx.rdc.table.TablePopup<S>

Type Parameters:

S - the table element type

public class TablePopup<S>
extends Object

Table popup.
Provides a context menu with several handy features such as export to excel, save and load table settings, etc...

Author:

harald

Constructor Summary

Constructors

Constructor and Description
TablePopup(FxTableView<S> table, String preferencesSuffix, boolean noViewSize, String title) Creates a table popup.

Method Summary

Modifier and Type	Method and Description
void	autoWidth() Resizes all columns to fit their content.
javafx.scene.control.ContextMenu	createContextMenu() Creates the context menu.
String	getPreferencesSuffix() Gets the table preferences suffix.
FxTableView<S>	getTable() Gets the table.
String	getTitle() Gets the printed title.
boolean	isColumnMenuEnabled() Returns whether the column menu is enabled.
void	loadPreferences() Loads the table preferences. System- or user scope is determined from PersistedPreferencesFactory.
void	loadPreferences(boolean system) Loads the table preferences.
void	print() Prints the table.
void	savePreferences() Saves the table preferences. System- or user scope is determined from PersistedPreferencesFactory.
void	savePreferences(boolean system) Saves the table preferences.
void	setColumnMenuEnabled(boolean columnMenuEnabled) Enables or disables the column menu. The column menu allows to set the visibility of columns.
void	toSpreadsheet(boolean onlySelected) Opens a dialog to export a table to an Excel sheet.
void	toXml(boolean onlySelected) Opens a dialog to export a table to an Excel sheet.

Methods inherited from class java.lang.Object

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

Constructor Detail

TablePopup

public TablePopup(FxTableView<S> table,
                  String preferencesSuffix,
                  boolean noViewSize,
                  String title)

Creates a table popup.

Parameters:

table - the table

preferencesSuffix - the preferences suffix to load/save table preferences

noViewSize - true if don't set the table view's size

title - the title of the printed table

Method Detail

getTable

public FxTableView<S> getTable()

Gets the table.

Returns:

the table

getTitle

public String getTitle()

Gets the printed title.

Returns:

the title

getPreferencesSuffix

public String getPreferencesSuffix()

Gets the table preferences suffix.

Returns:

the suffix

isColumnMenuEnabled

public boolean isColumnMenuEnabled()

Returns whether the column menu is enabled.

Returns:

true if column menu is enabled

setColumnMenuEnabled

public void setColumnMenuEnabled(boolean columnMenuEnabled)

Enables or disables the column menu.
The column menu allows to set the visibility of columns.

Parameters:

columnMenuEnabled - true to enable column menu (default)

createContextMenu

public javafx.scene.control.ContextMenu createContextMenu()

Creates the context menu.

Returns:

the context menu

autoWidth

public void autoWidth()

Resizes all columns to fit their content.

print

public void print()

Prints the table.

toSpreadsheet

public void toSpreadsheet(boolean onlySelected)

Opens a dialog to export a table to an Excel sheet.

Parameters:

onlySelected - true if export only selected rows

toXml

public void toXml(boolean onlySelected)

Opens a dialog to export a table to an Excel sheet.

Parameters:

onlySelected - true if export only selected rows

savePreferences

public void savePreferences(boolean system)

Saves the table preferences.

Parameters:

system - true if system scope, else user

savePreferences

public void savePreferences()

Saves the table preferences.
System- or user scope is determined from PersistedPreferencesFactory.

loadPreferences

public void loadPreferences(boolean system)

Loads the table preferences.

Parameters:

system - true if from system scope only, else try user first

loadPreferences

public void loadPreferences()

Loads the table preferences.
System- or user scope is determined from PersistedPreferencesFactory.