1 /*
   2  * Copyright (c) 2011, 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 sun.lwawt;
  27 
  28 import java.awt.*;
  29 
  30 import sun.awt.CausedFocusEvent;
  31 import sun.java2d.SurfaceData;
  32 
  33 // TODO Is it worth to generify this interface, like that:
  34 //
  35 // public interface PlatformWindow<WindowType extends Window>
  36 //
  37 // ?
  38 
  39 public interface PlatformWindow {
  40 
  41     /*
  42      * Delegate initialization (create native window and all the
  43      * related resources).
  44      */
  45     public void initialize(Window target, LWWindowPeer peer, PlatformWindow owner);
  46 
  47     /*
  48      * Delegate shutdown (dispose native window and all the
  49      * related resources).
  50      */
  51     public void dispose();
  52 
  53     /*
  54      * Shows or hides the window.
  55      */
  56     public void setVisible(boolean visible);
  57 
  58     /*
  59      * Sets the window title
  60      */
  61     public void setTitle(String title);
  62 
  63     /*
  64      * Sets the window bounds. Called when user changes window bounds
  65      * with setSize/setLocation/setBounds/reshape methods.
  66      */
  67     public void setBounds(int x, int y, int w, int h);
  68 
  69     /*
  70      * Returns the graphics device where the window is.
  71      */
  72     public GraphicsDevice getGraphicsDevice();
  73 
  74     /*
  75      * Returns the location of the window.
  76      */
  77     public Point getLocationOnScreen();
  78 
  79     /*
  80      * Returns the window insets.
  81      */
  82     public Insets getInsets();
  83 
  84     /*
  85      * Returns the metrics for a given font.
  86      */
  87     public FontMetrics getFontMetrics(Font f);
  88 
  89     /*
  90      * Get the SurfaceData for the window.
  91      */
  92     public SurfaceData getScreenSurface();
  93 
  94     /*
  95      * Revalidates the window's current SurfaceData and returns
  96      * the newly created one.
  97      */
  98     public SurfaceData replaceSurfaceData();
  99 
 100     /*
 101      * Creates a new image to serve as a back buffer.
 102      */
 103     public Image createBackBuffer();
 104 
 105     /*
 106      * Move the given part of the back buffer to the front buffer.
 107      */
 108     public void flip(int x1, int y1, int x2, int y2,
 109                      BufferCapabilities.FlipContents flipAction);
 110 
 111     public void setModalBlocked(boolean blocked);
 112 
 113     public void toFront();
 114 
 115     public void toBack();
 116 
 117     public void setMenuBar(MenuBar mb);
 118 
 119     public void setAlwaysOnTop(boolean value);
 120 
 121     public PlatformWindow getTopmostPlatformWindowUnderMouse();
 122 
 123     public void updateFocusableWindowState();
 124 
 125     public boolean rejectFocusRequest(CausedFocusEvent.Cause cause);
 126 
 127     public boolean requestWindowFocus();
 128 
 129     /*
 130      * Returns true only when called on a frame/dialog when it's natively focused.
 131      */
 132     public boolean isActive();
 133 
 134     public void setResizable(boolean resizable);
 135 
 136     /**
 137      * Applies the minimum and maximum size to the platform window.
 138      */
 139     public void setSizeConstraints(int minW, int minH, int maxW, int maxH);
 140 
 141     /**
 142      * Transforms the given Graphics object according to the native
 143      * implementation traits (insets, etc.).
 144      */
 145     public Graphics transformGraphics(Graphics g);
 146 
 147     /*
 148      * Installs the images for particular window.
 149      */
 150     public void updateIconImages();
 151 
 152     public void setOpacity(float opacity);
 153 
 154     public void setOpaque(boolean isOpaque);
 155 
 156     public void enterFullScreenMode();
 157 
 158     public void exitFullScreenMode();
 159 
 160     public void setWindowState(int windowState);
 161 
 162     public long getLayerPtr();
 163 
 164     public LWWindowPeer getPeer();
 165 }