com.dlsc.flexgantt.swing.treetable
Interface ITreeTableMenuProvider

All Known Implementing Classes:
DefaultTreeTableMenuProvider

public interface ITreeTableMenuProvider

A menu provider is a convenient way of adding a context sensitive popup menu to the TreeTable. When using this provider instead of using JComponent.setComponentPopupMenu(JPopupMenu) the information that is usually required by the popup menu gets already delivered to the provider. This information contains the location of the mouse event that triggered the popup and the tree path to the row where the popup got requested.

Since:
1.0
Author:
Dirk Lemmermann
See Also:
TreeTable.setMenuProvider(ITreeTableMenuProvider)

Method Summary
 javax.swing.JPopupMenu getPopupMenu(TreeTable table, java.awt.event.MouseEvent e, javax.swing.tree.TreePath treePath, TreeTableColumn column)
          Returns a popup menu for the given tree table.
 

Method Detail

getPopupMenu

javax.swing.JPopupMenu getPopupMenu(TreeTable table,
                                    java.awt.event.MouseEvent e,
                                    javax.swing.tree.TreePath treePath,
                                    TreeTableColumn column)
Returns a popup menu for the given tree table.

Parameters:
table - the tree table that requests the popup menu
e - the mouse event that triggered the popup menu request
treePath - the tree path that points to the row where the request occured (can be NULL)
column - the column in which the popup mouse event occured
Returns:
a popup menu that can be used in the context specified by the given parameters
Since:
1.0
See Also:
TreeTable.setMenuProvider(ITreeTableMenuProvider)