com.dlsc.flexgantt.swing.treetable
Interface ITreeTableHeaderMenuProvider

All Known Implementing Classes:

DefaultTreeTableHeaderMenuProvider

public interface ITreeTableHeaderMenuProvider

A menu provider is a convenient way of adding a context sensitive popup menu to the TreeTableHeader. 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 column where the event occured.

Since:

1.0

Author:

Dirk Lemmermann

See Also:

TreeTableHeader.setMenuProvider(ITreeTableHeaderMenuProvider)

Method Summary

javax.swing.JPopupMenu

getPopupMenu(TreeTableHeader header, java.awt.event.MouseEvent e, TreeTableColumn column) Returns a popup menu for the given tree table header.

Method Detail

getPopupMenu

javax.swing.JPopupMenu getPopupMenu(TreeTableHeader header,
                                    java.awt.event.MouseEvent e,
                                    TreeTableColumn column)

Returns a popup menu for the given tree table header.

Parameters:

header - the header for which to return a popup menu

e - the mouse event that triggered the popup menu

column - the column where the event occured

Returns:

a popup menu that can be used in the context specified by the given parameters

Since:

1.0

See Also:

TreeTableHeader.setMenuProvider(ITreeTableHeaderMenuProvider)