Source for gnu.java.awt.peer.swing.SwingFramePeer

   1: /* SwingFramePeer.java -- An abstract Swing based peer for AWT frames
   2:    Copyright (C)  2006  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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: package gnu.java.awt.peer.swing;
  39: 
  40: import java.awt.Frame;
  41: import java.awt.Graphics;
  42: import java.awt.Insets;
  43: import java.awt.MenuBar;
  44: import java.awt.Point;
  45: import java.awt.event.MouseEvent;
  46: import java.awt.peer.ComponentPeer;
  47: import java.awt.peer.FramePeer;
  48: 
  49: /**
  50:  * An abstract base class for FramePeer implementations based on Swing.
  51:  * This class provides the ability to display and handle AWT MenuBars that
  52:  * are based on Swing.
  53:  *
  54:  * As a minimum, a subclass must implement all the remaining abstract methods
  55:  * as well as the following methods:
  56:  * <ul>
  57:  * <li>{@link ComponentPeer#getLocationOnScreen()}</li>
  58:  * <li>{@link ComponentPeer#getGraphics()}</li>
  59:  * <li>{@link ComponentPeer#createImage(int, int)}</li>
  60:  * </ul>
  61:  *
  62:  * @author Roman Kennke (kennke@aicas.com)
  63:  */
  64: public abstract class SwingFramePeer
  65:   extends SwingWindowPeer
  66:   implements FramePeer
  67: {
  68:   /**
  69:    * The menu bar to display.
  70:    */
  71:   SwingMenuBarPeer menuBar = null;
  72: 
  73:   /**
  74:    * Creates a new SwingFramePeer.
  75:    *
  76:    * @param frame the frame
  77:    */
  78:   public SwingFramePeer(Frame frame)
  79:   {
  80:     super(frame);
  81:   }
  82: 
  83:   /**
  84:    * Sets the menu bar to display in this frame.
  85:    *
  86:    * @param mb the menu bar to set
  87:    */
  88:   public void setMenuBar(MenuBar mb)
  89:   {
  90:     menuBar = (SwingMenuBarPeer) mb.getPeer();
  91:     menuBar.setFramePeer(this);
  92:     menuBar.setWidth(awtComponent.getWidth());
  93:   }
  94: 
  95:   /**
  96:    * Triggers 'heavyweight' painting of the frame. This will paint a menu bar
  97:    * if present as well as the child components of this frame.
  98:    *
  99:    * @param g the graphics context to use for painting
 100:    */
 101:   protected void peerPaintComponent(Graphics g)
 102:   {
 103:     super.peerPaintComponent(g);
 104:     if (menuBar != null)
 105:       menuBar.peerPaint(g);
 106:   }
 107: 
 108:   /**
 109:    * Sets the size and location of this frame. This resizes the menubar to fit
 110:    * within the frame.
 111:    *
 112:    * @param x the X coordinate of the screen location
 113:    * @param y the Y coordinate of the screen location
 114:    * @param w the width of the frame
 115:    * @param h the height of the frame
 116:    */
 117:   public void setBounds(int x, int y, int w, int h)
 118:   {
 119:     super.setBounds(x, y, w, h);
 120:     if (menuBar != null)
 121:       menuBar.setWidth(w);
 122:   }
 123: 
 124:   /**
 125:    * Calculates the insets of this frame peer. This fetches the insets
 126:    * from the superclass and adds the insets of the menubar if one is present.
 127:    *
 128:    * @return the insets of the frame
 129:    */
 130:   public Insets getInsets()
 131:   {
 132:     Insets insets = super.getInsets();
 133:     if (menuBar != null)
 134:       insets.top += menuBar.getHeight();
 135:     return insets;
 136:   }
 137: 
 138:   /**
 139:    * Returns the location of the menu on the screen. This is needed internally
 140:    * by the {@link SwingMenuBarPeer} in order to determine its screen location.
 141:    *
 142:    * @return the location of the menu on the screen
 143:    */
 144:   public Point getMenuLocationOnScreen()
 145:   {
 146:     Insets i = super.getInsets();
 147:     return new Point(i.top, i.left);
 148:   }
 149: 
 150:   /**
 151:    * Overridden to provide the ability to handle menus.
 152:    *
 153:    * @param ev the mouse event
 154:    */
 155:   protected void handleMouseEvent(MouseEvent ev)
 156:   {
 157:     Point p = ev.getPoint();
 158:     Insets i = super.getInsets();
 159:     if (menuBar != null)
 160:       {
 161:         int menuHeight = menuBar.getHeight();
 162:         if (p.y >= i.top && p.y <= i.top + menuHeight)
 163:           menuBar.handleMouseEvent(ev);
 164:         else
 165:           {
 166:             ev.translatePoint(0, -menuHeight);
 167:             super.handleMouseMotionEvent(ev);
 168:           }
 169:       }
 170: 
 171:     super.handleMouseEvent(ev);
 172:   }
 173: 
 174:   /**
 175:    * Overridden to provide the ability to handle menus.
 176:    *
 177:    * @param ev the mouse event
 178:    */
 179:   protected void handleMouseMotionEvent(MouseEvent ev)
 180:   {
 181:     Point p = ev.getPoint();
 182:     Insets i = super.getInsets();
 183:     if (menuBar != null)
 184:       {
 185:         int menuHeight = menuBar.getHeight();
 186:         if (p.y >= i.top && p.y <= i.top + menuHeight)
 187:           menuBar.handleMouseMotionEvent(ev);
 188:         else
 189:           {
 190:             ev.translatePoint(0, -menuHeight);
 191:             super.handleMouseMotionEvent(ev);
 192:           }
 193:       }
 194: 
 195:     super.handleMouseMotionEvent(ev);
 196:   }
 197: }