org.openstreetmap.josm.gui.widgets

Class PopupMenuLauncher

java.lang.Object

java.awt.event.MouseAdapter

org.openstreetmap.josm.gui.widgets.PopupMenuLauncher

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener

Direct Known Subclasses:

ChangesetCacheManager.MouseEventHandler, CommandStackDialog.MouseEventHandler, ConflictDialog.MouseEventHandler, LayerListDialog.PopupMenuHandler, MapPaintDialog.PopupMenuHandler, NodeListViewer.InternalPopupMenuLauncher, RelationListDialog.MouseEventHandler, SelectionListDialog.MouseEventHandler, ToggleDialog.TitleBar.MouseEventHandler, ValidatorDialog.MouseEventHandler, VersionTable.MouseListener

public class PopupMenuLauncher
extends MouseAdapter

Utility class that helps to display popup menus on mouse events.

Since:

2688

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	checkEnabled
protected JPopupMenu	menu

Constructor Summary

Constructors

Constructor and Description
PopupMenuLauncher() Creates a new PopupMenuLauncher with no defined menu.
PopupMenuLauncher(JPopupMenu menu) Creates a new PopupMenuLauncher with the given menu.
PopupMenuLauncher(JPopupMenu menu, boolean checkEnabled) Creates a new PopupMenuLauncher with the given menu.

Method Summary

Modifier and Type	Method and Description
protected void	checkFocusAndShowMenu(Component component, MouseEvent evt)
protected int	checkListSelection(JList<?> list, Point p)
protected boolean	checkSelection(Component component, Point p)
protected int	checkTableSelection(JTable table, Point p)
protected TreePath	checkTreeSelection(JTree tree, Point p)
JPopupMenu	getMenu()
protected static boolean	isDoubleClick(MouseEvent e)
void	launch(MouseEvent evt) Launches the popup menu according to the given mouse event.
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
private void	processEvent(MouseEvent e)
protected void	showMenu(MouseEvent evt)

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

menu

protected JPopupMenu menu

checkEnabled

private final boolean checkEnabled

Constructor Detail

PopupMenuLauncher

public PopupMenuLauncher()

Creates a new PopupMenuLauncher with no defined menu. It is then needed to override the launch(java.awt.event.MouseEvent) method.

See Also:

launch(MouseEvent)

PopupMenuLauncher

public PopupMenuLauncher(JPopupMenu menu)

Creates a new PopupMenuLauncher with the given menu.

Parameters:

menu - The popup menu to display

PopupMenuLauncher

public PopupMenuLauncher(JPopupMenu menu,
                         boolean checkEnabled)

Creates a new PopupMenuLauncher with the given menu.

Parameters:

menu - The popup menu to display

checkEnabled - if true, the popup menu will only be displayed if the component triggering the mouse event is enabled

Since:

5886

Method Detail

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class MouseAdapter

processEvent

private void processEvent(MouseEvent e)

launch

public void launch(MouseEvent evt)

Launches the popup menu according to the given mouse event. This method needs to be overriden if the default constructor has been called.

Parameters:

evt - A mouse event

checkSelection

protected boolean checkSelection(Component component,
                                 Point p)

checkFocusAndShowMenu

protected void checkFocusAndShowMenu(Component component,
                                     MouseEvent evt)

showMenu

protected void showMenu(MouseEvent evt)

checkListSelection

protected int checkListSelection(JList<?> list,
                                 Point p)

checkTableSelection

protected int checkTableSelection(JTable table,
                                  Point p)

checkTreeSelection

protected TreePath checkTreeSelection(JTree tree,
                                      Point p)

isDoubleClick

protected static boolean isDoubleClick(MouseEvent e)

getMenu

public final JPopupMenu getMenu()

Returns:

the popup menu if defined, null otherwise.

Since:

5884