MenuSelectionManager.java 13.8 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/* MenuSelectionManager.java --
   Copyright (C) 2002, 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing;

import java.awt.Component;
import java.awt.Dimension;
import java.awt.Point;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Vector;

import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.event.EventListenerList;

/**
 * This class manages current menu selectection. It provides
 * methods to clear and set current selected menu path.
 * It also fires StateChange event to its registered
 * listeners whenever selected path of the current menu hierarchy
 * changes.
 *
 */
public class MenuSelectionManager
{
  /** ChangeEvent fired when selected path changes*/
  protected ChangeEvent changeEvent = new ChangeEvent(this);

  /** List of listeners for this MenuSelectionManager */
  protected EventListenerList listenerList = new EventListenerList();

  /** Default manager for the current menu hierarchy*/
  private static final MenuSelectionManager manager = new MenuSelectionManager();

  /** Path to the currently selected menu */
  private Vector selectedPath = new Vector();

  /**
   * Fires StateChange event to registered listeners
   */
  protected void fireStateChanged()
  {
    ChangeListener[] listeners = getChangeListeners();

    for (int i = 0; i < listeners.length; i++)
      listeners[i].stateChanged(changeEvent);
  }

  /**
   * Adds ChangeListener to this MenuSelectionManager
   *
   * @param listener ChangeListener to add
   */
  public void addChangeListener(ChangeListener listener)
  {
    listenerList.add(ChangeListener.class, listener);
  }

  /**
   * Removes ChangeListener from the list of registered listeners
   * for this MenuSelectionManager.
   *
   * @param listener ChangeListner to remove
   */
  public void removeChangeListener(ChangeListener listener)
  {
    listenerList.remove(ChangeListener.class, listener);
  }

  /**
   * Returns list of registered listeners with MenuSelectionManager
   *
   * @since 1.4
   */
  public ChangeListener[] getChangeListeners()
  {
    return (ChangeListener[]) listenerList.getListeners(ChangeListener.class);
  }

  /**
   * Unselects all the menu elements on the selection path
   */
  public void clearSelectedPath()
  {
    // Send events from the bottom most item in the menu - hierarchy to the
    // top most
    for (int i = selectedPath.size() - 1; i >= 0; i--)
      ((MenuElement) selectedPath.get(i)).menuSelectionChanged(false);

    // clear selected path
    selectedPath.clear();

130
    // notify all listeners that the selected path was changed
Tom Tromey committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
    fireStateChanged();
  }

  /**
   * This method returns menu element on the selected path that contains
   * given source point. If no menu element on the selected path contains this
   * point, then null is returned.
   *
   * @param source Component relative to which sourcePoint is given
   * @param sourcePoint point for which we want to find menu element that contains it
   *
   * @return Returns menu element that contains given source point and belongs
   * to the currently selected path. Null is return if no such menu element found.
   */
  public Component componentForPoint(Component source, Point sourcePoint)
  {
    // Convert sourcePoint to screen coordinates.
    Point sourcePointOnScreen = sourcePoint;
149

150 151
    if (source.isShowing())
      SwingUtilities.convertPointToScreen(sourcePointOnScreen, source);
Tom Tromey committed
152 153 154 155

    Point compPointOnScreen;
    Component resultComp = null;

156 157
    // For each menu element on the selected path, express its location
    // in terms of screen coordinates and check if there is any
Tom Tromey committed
158 159 160
    // menu element on the selected path that contains given source point.
    for (int i = 0; i < selectedPath.size(); i++)
      {
161 162 163 164 165 166 167 168 169 170 171 172 173
        Component comp = ((Component) selectedPath.get(i));
        Dimension size = comp.getSize();

        // convert location of this menu item to screen coordinates
        compPointOnScreen = comp.getLocationOnScreen();

        if (compPointOnScreen.x <= sourcePointOnScreen.x
            && sourcePointOnScreen.x < compPointOnScreen.x + size.width
            && compPointOnScreen.y <= sourcePointOnScreen.y
            && sourcePointOnScreen.y < compPointOnScreen.y + size.height)
          {
            Point p = sourcePointOnScreen;

174 175
        if (comp.isShowing())
          SwingUtilities.convertPointFromScreen(p, comp);
176 177 178 179

            resultComp = SwingUtilities.getDeepestComponentAt(comp, p.x, p.y);
            break;
          }
Tom Tromey committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
      }
    return resultComp;
  }

  /**
   * Returns shared instance of MenuSelection Manager
   *
   * @return default Manager
   */
  public static MenuSelectionManager defaultManager()
  {
    return manager;
  }

  /**
   * Returns path representing current menu selection
   *
   * @return Current selection path
   */
  public MenuElement[] getSelectedPath()
  {
    MenuElement[] path = new MenuElement[selectedPath.size()];

    for (int i = 0; i < path.length; i++)
      path[i] = (MenuElement) selectedPath.get(i);

    return path;
  }

  /**
   * Returns true if specified component is part of current menu
   * heirarchy and false otherwise
   *
   * @param c Component for which to check
   * @return True if specified component is part of current menu
   */
  public boolean isComponentPartOfCurrentMenu(Component c)
  {
    MenuElement[] subElements;
219 220
    boolean ret = false;
    for (int i = 0; i < selectedPath.size(); i++)
Tom Tromey committed
221
      {
222 223 224 225 226 227 228 229 230 231 232 233 234
        // Check first element.
        MenuElement first = (MenuElement) selectedPath.get(i);
        if (SwingUtilities.isDescendingFrom(c, first.getComponent()))
          {
            ret = true;
            break;
          }
        else
          {
            // Check sub elements.
            subElements = first.getSubElements();
            for (int j = 0; j < subElements.length; j++)
              {
235
                MenuElement me = subElements[j];
236 237 238 239 240 241 242 243
                if (me != null
                    && (SwingUtilities.isDescendingFrom(c, me.getComponent())))
                  {
                    ret = true;
                    break;
                  }
              }
          }
Tom Tromey committed
244 245
      }

246
      return ret;
Tom Tromey committed
247 248 249
  }

  /**
250 251 252 253
   * Processes key events on behalf of the MenuElements. MenuElement
   * instances should always forward their key events to this method and
   * get their {@link MenuElement#processKeyEvent(KeyEvent, MenuElement[],
   * MenuSelectionManager)} eventually called back.
Tom Tromey committed
254
   *
255
   * @param e the key event
Tom Tromey committed
256 257 258
   */
  public void processKeyEvent(KeyEvent e)
  {
259 260
    MenuElement[] selection = (MenuElement[])
                    selectedPath.toArray(new MenuElement[selectedPath.size()]);
261 262 263
    if (selection.length == 0)
      return;

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    MenuElement[] path;
    for (int index = selection.length - 1; index >= 0; index--)
      {
        MenuElement el = selection[index];
        // This method's main purpose is to forward key events to the
        // relevant menu items, so that they can act in response to their
        // mnemonics beeing typed. So we also need to forward the key event
        // to all the subelements of the currently selected menu elements
        // in the path.
        MenuElement[] subEls = el.getSubElements();
        path = null;
        for (int subIndex = 0; subIndex < subEls.length; subIndex++)
          {
            MenuElement sub = subEls[subIndex];
            // Skip elements that are not showing or not enabled.
            if (sub == null || ! sub.getComponent().isShowing()
                || ! sub.getComponent().isEnabled())
              {
                continue;
              }

            if (path == null)
              {
                path = new MenuElement[index + 2];
                System.arraycopy(selection, 0, path, 0, index + 1);
              }
            path[index + 1] = sub;
            sub.processKeyEvent(e, path, this);
            if (e.isConsumed())
              break;
          }
        if (e.isConsumed())
          break;
      }

    // Dispatch to first element in selection if it hasn't been consumed.
    if (! e.isConsumed())
      {
        path = new MenuElement[1];
        path[0] = selection[0];
        path[0].processKeyEvent(e, path, this);
      }
Tom Tromey committed
306 307 308 309 310 311 312 313 314 315 316 317
  }

  /**
   * Forwards given mouse event to all of the source subcomponents.
   *
   * @param event Mouse event
   */
  public void processMouseEvent(MouseEvent event)
  {
    Component source = ((Component) event.getSource());

    // In the case of drag event, event.getSource() returns component
318 319 320
    // where drag event originated. However menu element processing this
    // event should be the one over which mouse is currently located,
    // which is not necessary the source of the drag event.
Tom Tromey committed
321 322 323 324 325 326 327 328 329 330 331 332
    Component mouseOverMenuComp;

    // find over which menu element the mouse is currently located
    if (event.getID() == MouseEvent.MOUSE_DRAGGED
        || event.getID() == MouseEvent.MOUSE_RELEASED)
      mouseOverMenuComp = componentForPoint(source, event.getPoint());
    else
      mouseOverMenuComp = source;

    // Process this event only if mouse is located over some menu element
    if (mouseOverMenuComp != null && (mouseOverMenuComp instanceof MenuElement))
      {
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
        MenuElement[] path = getPath(mouseOverMenuComp);
        ((MenuElement) mouseOverMenuComp).processMouseEvent(event, path,
                                                            manager);

        // FIXME: Java specification says that mouse events should be
        // forwarded to subcomponents. The code below does it, but
        // menu's work fine without it. This code is commented for now.

        /*
        MenuElement[] subComponents = ((MenuElement) mouseOverMenuComp)
                                      .getSubElements();

        for (int i = 0; i < subComponents.length; i++)
         {
              subComponents[i].processMouseEvent(event, path, manager);
         }
        */
Tom Tromey committed
350 351 352
      }
    else
      {
353 354
        if (event.getID() == MouseEvent.MOUSE_RELEASED)
          clearSelectedPath();
Tom Tromey committed
355 356 357 358 359 360 361 362 363 364 365 366
      }
  }

  /**
   * Sets menu selection to the specified path
   *
   * @param path new selection path
   */
  public void setSelectedPath(MenuElement[] path)
  {
    if (path == null)
      {
367 368
        clearSelectedPath();
        return;
Tom Tromey committed
369 370
      }

371 372 373
    int minSize = path.length; // size of the smaller path.
    int currentSize = selectedPath.size();
    int firstDiff = 0;
Tom Tromey committed
374

375 376
    // Search first item that is different in the current and new path.
    for (int i = 0; i < minSize; i++)
Tom Tromey committed
377
      {
378 379 380 381
        if (i < currentSize && (MenuElement) selectedPath.get(i) == path[i])
          firstDiff++;
        else
          break;
Tom Tromey committed
382 383
      }

384 385
    // Remove items from selection and send notification.
    for (int i = currentSize - 1; i >= firstDiff; i--)
Tom Tromey committed
386
      {
387 388 389
        MenuElement el = (MenuElement) selectedPath.get(i);
        selectedPath.remove(i);
        el.menuSelectionChanged(false);
Tom Tromey committed
390 391
      }

392 393
    // Add new items to selection and send notification.
    for (int i = firstDiff; i < minSize; i++)
Tom Tromey committed
394
      {
395 396 397 398 399
        if (path[i] != null)
          {
            selectedPath.add(path[i]);
            path[i].menuSelectionChanged(true);
          }
Tom Tromey committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
      }

    fireStateChanged();
  }

  /**
   * Returns path to the specified component
   *
   * @param c component for which to find path for
   *
   * @return path to the specified component
   */
  private MenuElement[] getPath(Component c)
  {
    // FIXME: There is the same method in BasicMenuItemUI. However I
415
    // cannot use it here instead of this method, since I cannot assume that
Tom Tromey committed
416
    // all the menu elements on the selected path are JMenuItem or JMenu.
417 418
    // For now I've just duplicated it here. Please
    // fix me or delete me if another better approach will be found, and
Tom Tromey committed
419 420 421
    // this method will not be necessary.
    ArrayList path = new ArrayList();

422 423
    // if given component is JMenu, we also need to include
    // it's popup menu in the path
Tom Tromey committed
424 425 426 427
    if (c instanceof JMenu)
      path.add(((JMenu) c).getPopupMenu());
    while (c instanceof MenuElement)
      {
428
        path.add(0, (MenuElement) c);
Tom Tromey committed
429

430 431 432 433
        if (c instanceof JPopupMenu)
          c = ((JPopupMenu) c).getInvoker();
        else
          c = c.getParent();
Tom Tromey committed
434 435 436 437 438 439 440
      }

    MenuElement[] pathArray = new MenuElement[path.size()];
    path.toArray(pathArray);
    return pathArray;
  }
}