1/*
2 * Copyright (c) 2011, 2012, 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
26package com.apple.eawt.event;
27
28import javax.swing.*;
29
30/**
31 * Registration utility class to add {@link GestureListener}s to Swing components.
32 *
33 * This class manages the relationship between {@link JComponent}s and the {@link GestureListener}s
34 * attached to them. It's design is similar to the Java SE 6u10 {@link com.sun.awt.AWTUtilities}
35 * class which adds additional functionality to AWT Windows, without adding new API to the
36 * {@link java.awt.Window} class.
37 *
38 * To add a {@link GestureListener} to a top-level Swing window, use the {@link JRootPane} of the
39 * top-level window type.
40 *
41 * @see GestureAdapter
42 * @see JFrame#getRootPane()
43 * @see com.sun.awt.AWTUtilities
44 *
45 * @since Java for Mac OS X 10.5 Update 7, Java for Mac OS X 10.6 Update 2
46 */
47public final class GestureUtilities {
48    GestureUtilities() {
49        // package private
50    }
51
52    /**
53     * Attaches a {@link GestureListener} to the specified {@link JComponent}.
54     * @param component to attach the {@link GestureListener} to
55     * @param listener to be notified when a gesture occurs
56     */
57    public static void addGestureListenerTo(final JComponent component, final GestureListener listener) {
58        if (component == null || listener == null) throw new NullPointerException();
59        GestureHandler.addGestureListenerTo(component, listener);
60    }
61
62    /**
63     * Removes a {@link GestureListener} from the specified {@link JComponent}
64     * @param component to remove the {@link GestureListener} from
65     * @param listener to be removed
66     */
67    public static void removeGestureListenerFrom(final JComponent component, final GestureListener listener) {
68        if (component == null || listener == null) throw new NullPointerException();
69        GestureHandler.removeGestureListenerFrom(component, listener);
70    }
71}
72