Changeset 5884 in josm for trunk/src

Timestamp:

2013-04-19T01:31:16+02:00 (11 years ago)

Author:

Don-vip

Message:

see #4429 - Get popup menu from PopupMenuLauncher + fix javadoc

File:

• trunk/src/org/openstreetmap/josm/gui/widgets/PopupMenuLauncher.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/widgets/PopupMenuLauncher.java

@@ -7 +7 @@
 import javax.swing.JPopupMenu;
 
+/**
+ * Utility class that helps to display popup menus on mouse events.
+ * @since 2688
+ */
 public class PopupMenuLauncher extends MouseAdapter {
-    private JPopupMenu menu;
+    private final JPopupMenu menu;
 
+    /**
+     * Creates a new {@link PopupMenuLauncher} with no defined menu. 
+     * It is then needed to override the {@link #launch} method.
+     * @see #launch(MouseEvent)
+     */
     public PopupMenuLauncher() {
-        menu = null;
+        this(null);
     }
+
+    /**
+     * Creates a new {@link PopupMenuLauncher} with the given menu.
+     * @param menu The popup menu to display
+     */
     public PopupMenuLauncher(JPopupMenu menu) {
         this.menu = menu;
@@ -38 +52 @@
     }
 
+    /**
+     * Launches the popup menu according to the given mouse event.
+     * This method needs to be overriden if the default constructor has been called.
+     * @param evt A mouse event
+     */
     public void launch(MouseEvent evt) {
         if (menu != null) {
-            menu.show(evt.getComponent(), evt.getX(),evt.getY());
+            menu.show(evt.getComponent(), evt.getX(), evt.getY());
         }
     }
+
+    /**
+     * @return the popup menu if defined, {@code null} otherwise.
+     * @since 5884
+     */
+    public final JPopupMenu getMenu() {
+        return menu;
+    }
 }