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 

    26 package com.apple.eawt;

    27 

    28 import java.awt.*;

    29 

    30 import javax.swing.RootPaneContainer;

    31 

    32 import sun.lwawt.macosx.*;

    33 

    34 import com.apple.eawt.event.GestureUtilities;

    35 

    36 /**

    37  * Utility class perform animated full screen actions to top-level {@link Window}s.

    38  *

    39  * This class manages the relationship between {@link Windows}s and the {@link FullScreenListener}s

    40  * attached to them. It's design is similar to the Java SE 6u10 {@link com.sun.awt.AWTUtilities}

    41  * class which adds additional functionality to AWT Windows, without adding new API to the

    42  * {@link java.awt.Window} class.

    43  *

    44  * Full screen operations can only be performed on top-level {@link Window}s that are also {@link RootPaneContainer}s.

    45  *

    46  * @see FullScreenAdapter

    47  * @see GestureUtilities

    48  * @see com.sun.awt.AWTUtilities

    49  *

    50  * @since Java for Mac OS X 10.7 Update 1

    51  */

    52 public final class FullScreenUtilities {

    53     FullScreenUtilities() {

    54         // package private

    55     }

    56 

    57     /**

    58      * Marks a {@link Window} as able to animate into or out of full screen mode.

    59      *

    60      * Only top-level {@link Window}s which are {@link RootPaneContainer}s are able to be animated into and out of full screen mode.

    61      * The {@link Window} must be marked as full screen-able before the native peer is created with {@link Component#addNotify()}.

    62      *

    63      * @param window

    64      * @param canFullScreen

    65      * @throws IllegalArgumentException if window is not a {@link RootPaneContainer}

    66      */

    67     public static void setWindowCanFullScreen(final Window window, final boolean canFullScreen) {

    68         if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't mark a non-RootPaneContainer as full screen-able");

    69         final RootPaneContainer rpc = (RootPaneContainer)window;

    70         rpc.getRootPane().putClientProperty(CPlatformWindow.WINDOW_FULLSCREENABLE, Boolean.valueOf(canFullScreen));

    71     }

    72 

    73     /**

    74      * Attaches a {@link FullScreenListener} to the specified top-level {@link Window}.

    75      * @param window to attach the {@link FullScreenListener} to

    76      * @param listener to be notified when a full screen event occurs

    77      * @throws IllegalArgumentException if window is not a {@link RootPaneContainer}

    78      */

    79     public static void addFullScreenListenerTo(final Window window, final FullScreenListener listener) {

    80         if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't attach FullScreenListener to a non-RootPaneContainer");

    81         if (listener == null) throw new NullPointerException();

    82         FullScreenHandler.addFullScreenListenerTo((RootPaneContainer)window, listener);

    83     }

    84 

    85     /**

    86      * Removes a {@link FullScreenListener} from the specified top-level {@link Window}.

    87      * @param window to remove the {@link FullScreenListener} from

    88      * @param listener to be removed

    89      * @throws IllegalArgumentException if window is not a {@link RootPaneContainer}

    90      */

    91     public static void removeFullScreenListenerFrom(final Window window, final FullScreenListener listener) {

    92         if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't remove FullScreenListener from non-RootPaneContainer");

    93         if (listener == null) throw new NullPointerException();

    94         FullScreenHandler.removeFullScreenListenerFrom((RootPaneContainer)window, listener);

    95     }

    96 }