1 /*
   2  * Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.apple.eawt.event;
  27 
  28 import javax.swing.JComponent;
  29 import javax.swing.JFrame;
  30 import javax.swing.JRootPane;
  31 
  32 /**
  33  * Registration utility class to add {@link GestureListener}s to Swing components.
  34  *
  35  * This class manages the relationship between {@link JComponent}s and the {@link GestureListener}s
  36  * attached to them. It's design is similar to the Java SE 6u10 {@code com.sun.awt.AWTUtilities}
  37  * class which adds additional functionality to AWT Windows, without adding new API to the
  38  * {@link java.awt.Window} class.
  39  *
  40  * To add a {@link GestureListener} to a top-level Swing window, use the {@link JRootPane} of the
  41  * top-level window type.
  42  *
  43  * @see GestureAdapter
  44  * @see JFrame#getRootPane()
  45  *
  46  * @since Java for Mac OS X 10.5 Update 7, Java for Mac OS X 10.6 Update 2
  47  */
  48 public final class GestureUtilities {
  49     GestureUtilities() {
  50         // package private
  51     }
  52 
  53     /**
  54      * Attaches a {@link GestureListener} to the specified {@link JComponent}.
  55      * @param component to attach the {@link GestureListener} to
  56      * @param listener to be notified when a gesture occurs
  57      */
  58     public static void addGestureListenerTo(final JComponent component, final GestureListener listener) {
  59         if (component == null || listener == null) throw new NullPointerException();
  60         GestureHandler.addGestureListenerTo(component, listener);
  61     }
  62 
  63     /**
  64      * Removes a {@link GestureListener} from the specified {@link JComponent}
  65      * @param component to remove the {@link GestureListener} from
  66      * @param listener to be removed
  67      */
  68     public static void removeGestureListenerFrom(final JComponent component, final GestureListener listener) {
  69         if (component == null || listener == null) throw new NullPointerException();
  70         GestureHandler.removeGestureListenerFrom(component, listener);
  71     }
  72 }