net.sf.cuf.ui.table

Class TableContextMenu

java.lang.Object

java.awt.event.MouseAdapter

net.sf.cuf.ui.table.TableContextMenu

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener, AncestorListener

public class TableContextMenu
extends MouseAdapter
implements AncestorListener

Context menu for a table with pluggable actions. The context menu has to be bound to the table separately. Any JTable can be used although there are additional functionalities for SortingTables. The supported actions can be freely defined as ContextMenuActions. There are several predefined actions available which are used as the default actions for the context menu.

Author:

Hendrik Wördehoff, sd&m AG

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_MENU_IN_HEADER Activate the context menu in the table header.
static int	CONTEXT_MENU_IN_TABLE Activate the context menu in the table body.
static int	CONTEXT_MENU_IN_TABLE_AND_PARENT Activate the context menu in the whole table and its surrounding viewport (== CONTEXT_MENU_IN_TABLE | CONTEXT_MENU_IN_HEADER | CONTEXT_MENU_IN_VIEWPORT).
static int	CONTEXT_MENU_IN_TABLE_HEADER Activate the context menu in the table header only (== CONTEXT_MENU_IN_HEADER).
static int	CONTEXT_MENU_IN_VIEWPORT Activate the context menu in the JViewport around the table (e.g.
static int	CONTEXT_MENU_IN_WHOLE_TABLE Activate the context menu in the table header and the table body (== CONTEXT_MENU_IN_TABLE | CONTEXT_MENU_IN_HEADER).
static ContextMenuAction	SEPARATOR Separator entry for the context menu.

Constructor Summary

Constructors

Constructor and Description
TableContextMenu(JTable pTable) Constructor to install this context menu in a table.
TableContextMenu(JTable pTable, int pMode) Constructor to install this context menu in a table.
TableContextMenu(JTable pTable, int pMode, ContextMenuAction[] pActions) Constructor to install this context menu in a table.

Method Summary

Methods

Modifier and Type	Method and Description
void	ancestorAdded(AncestorEvent pEvent) Check if the parent of our table has changed.
void	ancestorMoved(AncestorEvent pEvent) We are not interested in this event.
void	ancestorRemoved(AncestorEvent pEvent) Check if the parent of our table has changed.
void	dispose() Disconnect the context menu from its table.
int	getMode() Return the mode as a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and CONTEXT_MENU_IN_VIEWPORT.
void	mousePressed(MouseEvent pEvent) React on mouse pressed events.
void	mouseReleased(MouseEvent pEvent) React on mouse released events.
void	setMode(int pMode) Set the mode as a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and CONTEXT_MENU_IN_VIEWPORT.

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_MENU_IN_TABLE

public static final int CONTEXT_MENU_IN_TABLE

Activate the context menu in the table body.

See Also:

Constant Field Values

CONTEXT_MENU_IN_HEADER

public static final int CONTEXT_MENU_IN_HEADER

Activate the context menu in the table header.

See Also:

Constant Field Values

CONTEXT_MENU_IN_VIEWPORT

public static final int CONTEXT_MENU_IN_VIEWPORT

Activate the context menu in the JViewport around the table (e.g. from a JScrollPane).

See Also:

Constant Field Values

CONTEXT_MENU_IN_TABLE_HEADER

public static final int CONTEXT_MENU_IN_TABLE_HEADER

Activate the context menu in the table header only (== CONTEXT_MENU_IN_HEADER). This constant is only provided for convenience.

See Also:

Constant Field Values

CONTEXT_MENU_IN_WHOLE_TABLE

public static final int CONTEXT_MENU_IN_WHOLE_TABLE

Activate the context menu in the table header and the table body (== CONTEXT_MENU_IN_TABLE | CONTEXT_MENU_IN_HEADER). This constant is only provided for convenience.

See Also:

Constant Field Values

CONTEXT_MENU_IN_TABLE_AND_PARENT

public static final int CONTEXT_MENU_IN_TABLE_AND_PARENT

Activate the context menu in the whole table and its surrounding viewport (== CONTEXT_MENU_IN_TABLE | CONTEXT_MENU_IN_HEADER | CONTEXT_MENU_IN_VIEWPORT). This constant is only provided for convenience.

See Also:

Constant Field Values

SEPARATOR

public static final ContextMenuAction SEPARATOR

Separator entry for the context menu.

Constructor Detail

TableContextMenu

public TableContextMenu(JTable pTable)

Constructor to install this context menu in a table. The mode is assumed to be == CONTEXT_MENU_IN_TABLE | CONTEXT_MENU_IN_HEADER | CONTEXT_MENU_IN_VIEWPORT. The actions are assumed to be the default actions.

Parameters:

pTable - table this context menu works on (must not be null)

TableContextMenu

public TableContextMenu(JTable pTable,
                int pMode)

Constructor to install this context menu in a table. The actions are assumed to be the default actions.

Parameters:

pTable - table this context menu works on (must not be null)

pMode - a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and/or CONTEXT_MENU_IN_VIEWPORT

TableContextMenu

public TableContextMenu(JTable pTable,
                int pMode,
                ContextMenuAction[] pActions)

Constructor to install this context menu in a table.

Parameters:

pTable - table this context menu works on (must not be null)

pMode - a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and/or CONTEXT_MENU_IN_VIEWPORT

pActions - actions to include in the context menu (must not be null)

Method Detail

dispose

public void dispose()

Disconnect the context menu from its table. Use this method if you need to get rid of this context menu instance.

getMode

public int getMode()

Return the mode as a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and CONTEXT_MENU_IN_VIEWPORT.

Returns:

current mode

setMode

public void setMode(int pMode)

Set the mode as a bitflag consisting of CONTEXT_MENU_IN_TABLE, CONTEXT_MENU_IN_HEADER and CONTEXT_MENU_IN_VIEWPORT.

Parameters:

pMode - new mode

mousePressed

public void mousePressed(MouseEvent pEvent)

React on mouse pressed events. This may be a popup trigger in certain Look&Feels.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

mouseReleased

public void mouseReleased(MouseEvent pEvent)

React on mouse released events. This may be a popup trigger in certain Look&Feels.

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class MouseAdapter

ancestorAdded

public void ancestorAdded(AncestorEvent pEvent)

Check if the parent of our table has changed.

Specified by:

ancestorAdded in interface AncestorListener

ancestorRemoved

public void ancestorRemoved(AncestorEvent pEvent)

Check if the parent of our table has changed.

Specified by:

ancestorRemoved in interface AncestorListener

ancestorMoved

public void ancestorMoved(AncestorEvent pEvent)

We are not interested in this event.

Specified by:

ancestorMoved in interface AncestorListener