libjava/gnu/java/awt/EmbeddedWindow.java

   1 /* EmbeddedWindow.java --
   2    Copyright (C) 2003, 2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package gnu.java.awt;
  40
  41 import gnu.java.awt.peer.EmbeddedWindowPeer;
  42 import gnu.java.security.action.SetAccessibleAction;
  43
  44 import java.awt.Component;
  45 import java.awt.Frame;
  46 import java.awt.Toolkit;
  47 import java.lang.reflect.Field;
  48 import java.security.AccessController;
  49
  50 /**
  51  * Represents an AWT window that can be embedded into another
  52  * application.
  53  *
  54  * @author Michael Koch (konqueror@gmx.de)
  55  */
  56 public class EmbeddedWindow extends Frame
  57 {
  58   private long handle;
  59
  60   /**
  61    * Creates a window to be embedded into another application.  The
  62    * window will only be embedded after its setHandle method has been
  63    * called.
  64    */
  65   public EmbeddedWindow ()
  66   {
  67     super();
  68     this.handle = 0;
  69   }
  70
  71   /**
  72    * Creates a window to be embedded into another application.
  73    *
  74    * @param handle the native handle to the screen area where the AWT
  75    * window should be embedded
  76    */
  77   public EmbeddedWindow (long handle)
  78   {
  79     super();
  80     this.handle = handle;
  81   }
  82
  83   /**
  84    * Creates the native peer for this embedded window.
  85    */
  86   public void addNotify()
  87   {
  88     Toolkit tk = getToolkit();
  89
  90     if (! (tk instanceof EmbeddedWindowSupport))
  91       throw new UnsupportedOperationException
  92         ("Embedded windows are not supported by the current peers: "
  93          + tk.getClass());
  94
  95     // Circumvent the package-privateness of the AWT internal
  96     // java.awt.Component.peer member variable.
  97     try
  98       {
  99         Field peerField = Component.class.getDeclaredField("peer");
 100         AccessController.doPrivileged(new SetAccessibleAction(peerField));
 101         peerField.set(this, ((EmbeddedWindowSupport) tk).createEmbeddedWindow (this));
 102       }
 103     catch (IllegalAccessException e)
 104       {
 105         // This should never happen.
 106       }
 107     catch (NoSuchFieldException e)
 108       {
 109         // This should never happen.
 110       }
 111
 112     super.addNotify();
 113   }
 114
 115   /**
 116    * If the native peer for this embedded window has been created,
 117    * then setHandle will embed the window.  If not, setHandle tells
 118    * us where to embed ourselves when our peer is created.
 119    *
 120    * @param handle the native handle to the screen area where the AWT
 121    * window should be embedded
 122    */
 123   public void setHandle(long handle)
 124   {
 125     if (this.handle != 0)
 126       throw new RuntimeException ("EmbeddedWindow is already embedded");
 127
 128     this.handle = handle;
 129     if (getPeer() != null)
 130       ((EmbeddedWindowPeer) getPeer()).embed (this.handle);
 131   }
 132
 133   /**
 134    * Gets the native handle of the screen area where the window will
 135    * be embedded.
 136    *
 137    * @return The native handle that was passed to the constructor.
 138    */
 139   public long getHandle()
 140   {
 141     return handle;
 142   }
 143 }