org.tentackle.swing

Class FormTableUtilityPopup

java.lang.Object

org.tentackle.swing.FormTableUtilityPopup

All Implemented Interfaces:

KeyListener, MouseListener, EventListener

public class FormTableUtilityPopup
extends Object
implements MouseListener, KeyListener

FormTable utility popup.
A popup menu to allow a FormTable to be printed, converted to Excel or Xml, find an item in the table, set/get the preferences, size, columns, etc... The popup-Menu will be triggered by pressing the right-mouse button (using isPopupTrigger()) somewhere in the header of the table (by default).

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
static String	POPUP_AUTOWIDTH autowidth
static String	POPUP_COLUMN component name in popup for the column item
static String	POPUP_COLUMN_DESELECTALL component name in popup for
static String	POPUP_COLUMN_MENU component name in popup for the column submenu
static String	POPUP_COLUMN_SELECTALL component name in popup for select all columns item
static String	POPUP_EXPORT_EXCEL component name in popup for
static String	POPUP_EXPORT_EXCEL_SELECTED component name in popup for
static String	POPUP_EXPORT_XML component name in popup for
static String	POPUP_EXPORT_XML_SELECTED component name in popup for
static String	POPUP_LOAD_DEFAULTS component name in popup for
static String	POPUP_LOAD_SYSTEM_PREFS component name in popup for
static String	POPUP_LOAD_USER_PREFS component name in popup for
static String	POPUP_MENU component name in popup for the menu
static String	POPUP_PRINT component name in popup for
static String	POPUP_SAVE_SYSTEM_PREFS component name in popup for
static String	POPUP_SAVE_USER_PREFS component name in popup for
static String	POPUP_SEARCH component name in popup for

Constructor Summary

Constructors

Constructor and Description
FormTableUtilityPopup()

Method Summary

Modifier and Type	Method and Description
void	addKeyListener() Adds the default key listener for KeyEvent.VK_F3.
void	addKeyListenerForKey(int keyCode) Adds a key listener for a given keycode.
JPopupMenu	createPopupMenu() Creates the popup-menu.
String	getIntro() Gets the intro text.
FormTable<?>	getTable() Gets the table.
String	getTitle() Gets the title.
boolean	isColumnMenuEnabled() Returns whether the column menu is enabled.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	removeKeyListener() Removes the key listener.
void	restoreSettings(boolean system) Restores the tables default settings from the Preferences.
void	saveSettings(boolean system) Saves the table settings to the Preferences.
boolean	search(String searchText, boolean caseSensitive) Searches for a text starting at the current cell.
void	setColumnMenuEnabled(boolean columnMenuEnabled) Enables or disables the column menu. The column menu allows to set the visibility of columns.
void	setIntro(String intro) Sets the intro-text. The intro will be printed on the first page and shown in toExcel sheets.
void	setTable(FormTable<?> table) Sets the table.
void	setTitle(String title) Sets the title. The title will be printed pn each page and shown in toExcel sheets.
void	showExcelDialog(boolean onlySelected) Opens a dialog to export a table to an Excel sheet.
void	showPrintDialog() Prints the table.
void	showSearchDialog() Opens a dialog to search in a table starting at the current cell.
void	showXmlDialog(boolean onlySelected) Opens a dialog to export a table to an XML file.
void	toExcel(File file, boolean onlySelected) Converts the table to an Excel spreadsheet.
void	toXml(File file, boolean onlySelected) Exports a table to an XML file.

Methods inherited from class java.lang.Object

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

Field Detail

POPUP_MENU

public static final String POPUP_MENU

component name in popup for the menu

See Also:

Constant Field Values

POPUP_COLUMN_MENU

public static final String POPUP_COLUMN_MENU

component name in popup for the column submenu

See Also:

Constant Field Values

POPUP_COLUMN

public static final String POPUP_COLUMN

component name in popup for the column item

See Also:

Constant Field Values

POPUP_COLUMN_SELECTALL

public static final String POPUP_COLUMN_SELECTALL

component name in popup for select all columns item

See Also:

Constant Field Values

POPUP_COLUMN_DESELECTALL

public static final String POPUP_COLUMN_DESELECTALL

component name in popup for

See Also:

Constant Field Values

POPUP_SEARCH

public static final String POPUP_SEARCH

component name in popup for

See Also:

Constant Field Values

POPUP_PRINT

public static final String POPUP_PRINT

component name in popup for

See Also:

Constant Field Values

POPUP_EXPORT_EXCEL

public static final String POPUP_EXPORT_EXCEL

component name in popup for

See Also:

Constant Field Values

POPUP_EXPORT_EXCEL_SELECTED

public static final String POPUP_EXPORT_EXCEL_SELECTED

component name in popup for

See Also:

Constant Field Values

POPUP_EXPORT_XML

public static final String POPUP_EXPORT_XML

component name in popup for

See Also:

Constant Field Values

POPUP_EXPORT_XML_SELECTED

public static final String POPUP_EXPORT_XML_SELECTED

component name in popup for

See Also:

Constant Field Values

POPUP_SAVE_SYSTEM_PREFS

public static final String POPUP_SAVE_SYSTEM_PREFS

component name in popup for

See Also:

Constant Field Values

POPUP_LOAD_SYSTEM_PREFS

public static final String POPUP_LOAD_SYSTEM_PREFS

component name in popup for

See Also:

Constant Field Values

POPUP_SAVE_USER_PREFS

public static final String POPUP_SAVE_USER_PREFS

component name in popup for

See Also:

Constant Field Values

POPUP_LOAD_USER_PREFS

public static final String POPUP_LOAD_USER_PREFS

component name in popup for

See Also:

Constant Field Values

POPUP_LOAD_DEFAULTS

public static final String POPUP_LOAD_DEFAULTS

component name in popup for

See Also:

Constant Field Values

POPUP_AUTOWIDTH

public static final String POPUP_AUTOWIDTH

autowidth

See Also:

Constant Field Values

Constructor Detail

FormTableUtilityPopup

public FormTableUtilityPopup()

Method Detail

setTable

public void setTable(FormTable<?> table)

Sets the table.

Parameters:

table - the table, null to clear

getTable

public FormTable<?> getTable()

Gets the table.

Returns:

the table

setTitle

public void setTitle(String title)

Sets the title.
The title will be printed pn each page and shown in toExcel sheets.

Parameters:

title - the title, null if default from window

getTitle

public String getTitle()

Gets the title.

Returns:

the title, null if default from window

setIntro

public void setIntro(String intro)

Sets the intro-text.
The intro will be printed on the first page and shown in toExcel sheets.

Parameters:

intro - the intro, null = none

getIntro

public String getIntro()

Gets the intro text.

Returns:

the intro, null = none

createPopupMenu

public JPopupMenu createPopupMenu()

Creates the popup-menu.

Returns:

the popup menu

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)

saveSettings

public void saveSettings(boolean system)

Saves the table settings to the Preferences.

Parameters:

system - is true if save to systemRoot, else userRoot

restoreSettings

public void restoreSettings(boolean system)

Restores the tables default settings from the Preferences.

Parameters:

system - is true if load ONLY from systemRoot, else try userRoot first (should be default)

search

public boolean search(String searchText,
                      boolean caseSensitive)

Searches for a text starting at the current cell.

Parameters:

searchText - the search text

caseSensitive - true if case sensitive

Returns:

true if found

showSearchDialog

public void showSearchDialog()

Opens a dialog to search in a table starting at the current cell.

showPrintDialog

public void showPrintDialog()

Prints the table.

toExcel

public void toExcel(File file,
                    boolean onlySelected)
             throws IOException

Converts the table to an Excel spreadsheet.

Parameters:

file - the output file

onlySelected - true if export only selected rows

Throws:

IOException - if export failed

showExcelDialog

public void showExcelDialog(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(File file,
                  boolean onlySelected)
           throws IOException,
                  TransformerConfigurationException,
                  SAXException

Exports a table to an XML file.

Parameters:

file - the output file

onlySelected - true if export only selected rows

Throws:

IOException - if file could not be opened

TransformerConfigurationException - if no transformer could be created

SAXException - if xml document creation failed

showXmlDialog

public void showXmlDialog(boolean onlySelected)

Opens a dialog to export a table to an XML file.

Parameters:

onlySelected - true if export only selected rows

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

addKeyListenerForKey

public void addKeyListenerForKey(int keyCode)

Adds a key listener for a given keycode.

Parameters:

keyCode - the keycode

addKeyListener

public void addKeyListener()

Adds the default key listener for KeyEvent.VK_F3. Pressing this key will start the search dialog or continue the search.

removeKeyListener

public void removeKeyListener()

Removes the key listener.

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener