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