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; 27 28 import java.awt.Component; 29 import java.awt.Window; 30 31 import javax.swing.RootPaneContainer; 32 33 import com.apple.eawt.event.GestureUtilities; 34 import sun.lwawt.macosx.CPlatformWindow; 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 Window}s and the {@link FullScreenListener}s 40 * attached to them. It's design is similar to the Java SE 6u10 {@code 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 * 49 * @since Java for Mac OS X 10.7 Update 1 50 */ 51 public final class FullScreenUtilities { 52 FullScreenUtilities() { 53 // package private 54 } 55 56 /** 57 * Marks a {@link Window} as able to animate into or out of full screen mode. 58 * 59 * Only top-level {@link Window}s which are {@link RootPaneContainer}s are able to be animated into and out of full screen mode. 60 * The {@link Window} must be marked as full screen-able before the native peer is created with {@link Component#addNotify()}. 61 * 62 * @param window 63 * @param canFullScreen 64 * @throws IllegalArgumentException if window is not a {@link RootPaneContainer} 65 */ 66 public static void setWindowCanFullScreen(final Window window, final boolean canFullScreen) { 67 if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't mark a non-RootPaneContainer as full screen-able"); 68 final RootPaneContainer rpc = (RootPaneContainer)window; 69 rpc.getRootPane().putClientProperty(CPlatformWindow.WINDOW_FULLSCREENABLE, Boolean.valueOf(canFullScreen)); 70 } 71 72 /** 73 * Attaches a {@link FullScreenListener} to the specified top-level {@link Window}. 74 * @param window to attach the {@link FullScreenListener} to 75 * @param listener to be notified when a full screen event occurs 76 * @throws IllegalArgumentException if window is not a {@link RootPaneContainer} 77 */ 78 public static void addFullScreenListenerTo(final Window window, final FullScreenListener listener) { 79 if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't attach FullScreenListener to a non-RootPaneContainer"); 80 if (listener == null) throw new NullPointerException(); 81 FullScreenHandler.addFullScreenListenerTo((RootPaneContainer)window, listener); 82 } 83 84 /** 85 * Removes a {@link FullScreenListener} from the specified top-level {@link Window}. 86 * @param window to remove the {@link FullScreenListener} from 87 * @param listener to be removed 88 * @throws IllegalArgumentException if window is not a {@link RootPaneContainer} 89 */ 90 public static void removeFullScreenListenerFrom(final Window window, final FullScreenListener listener) { 91 if (!(window instanceof RootPaneContainer)) throw new IllegalArgumentException("Can't remove FullScreenListener from non-RootPaneContainer"); 92 if (listener == null) throw new NullPointerException(); 93 FullScreenHandler.removeFullScreenListenerFrom((RootPaneContainer)window, listener); 94 } 95 }