libjava/classpath/gnu/java/awt/peer/swing/SwingComponent.java

   1 /* SwingComponent.java -- An interface that defines a Swing component for peers
   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.event.FocusEvent;
  41 import java.awt.event.KeyEvent;
  42 import java.awt.event.MouseEvent;
  43
  44 import javax.swing.JComponent;
  45
  46 /**
  47  * Defines some additional methods that the Swing components must implement
  48  * in order to work with the Swing peers. This is usually achieved by
  49  * subclassing a Swing component and forwarding the method calls to some
  50  * protected JComponent method.
  51  *
  52  * @author Roman Kennke (kennke@aicas.com)
  53  */
  54 public interface SwingComponent
  55 {
  56
  57   /**
  58    * Returns the actual swing compenent.
  59    *
  60    * @return the actual swing compenent
  61    */
  62   JComponent getJComponent();
  63
  64   /**
  65    * Handles a mouse event. This is usually forwarded to
  66    * {@link Component#processMouseMotionEvent(MouseEvent)} of the swing
  67    * component.
  68    *
  69    * @param ev the mouse event
  70    */
  71   void handleMouseEvent(MouseEvent ev);
  72
  73   /**
  74    * Handles a mouse motion event. This is usually forwarded to
  75    * {@link Component#processMouseEvent(MouseEvent)} of the swing
  76    * component.
  77    *
  78    * @param ev the mouse motion event
  79    */
  80   void handleMouseMotionEvent(MouseEvent ev);
  81
  82   /**
  83    * Handles a key event. This is usually forwarded to
  84    * {@link Component#processKeyEvent(KeyEvent)} of the swing
  85    * component.
  86    *
  87    * @param ev the key event
  88    */
  89   void handleKeyEvent(KeyEvent ev);
  90
  91   /**
  92    * Handles a focus event. This is usually forwarded to
  93    * {@link Component#processFocusEvent(FocusEvent)} of the swing
  94    * component.
  95    *
  96    * @param ev the focus event
  97    */
  98   void handleFocusEvent(FocusEvent ev);
  99 }