Source for java.applet.AppletStub

   1: /* AppletStub.java -- low level interface to the browser
   2:    Copyright (C) 1999, 2002, 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., 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: 
  39: package java.applet;
  40: 
  41: import java.net.URL;
  42: 
  43: /**
  44:  * This interface is the low level interface between the applet and the
  45:  * browser.
  46:  *
  47:  * @author Aaron M. Renn (arenn@urbanophile.com)
  48:  * @see Applet#setStub(AppletStub)
  49:  * @since 1.0
  50:  * @status updated to 1.4
  51:  */
  52: public interface AppletStub
  53: {
  54:   /**
  55:    * Tests whether or not this applet is currently active. An applet is active
  56:    * just before the browser invokes start(), and becomes inactive just
  57:    * before the browser invokes stop().
  58:    *
  59:    * @return <code>true</code> if this applet is active
  60:    */
  61:   boolean isActive();
  62: 
  63:   /**
  64:    * Returns the basename URL of the document this applet is embedded in. This
  65:    * is everything up to the final '/'.
  66:    *
  67:    * @return the URL of the document this applet is embedded in
  68:    * @see #getCodeBase()
  69:    */
  70:   URL getDocumentBase();
  71: 
  72:   /**
  73:    * Returns the URL of the code base for this applet.
  74:    *
  75:    * @return the URL of the code base for this applet
  76:    */
  77:   URL getCodeBase();
  78: 
  79:   /**
  80:    * Returns the value of the specified parameter that was specified in
  81:    * the <code>&lt;APPLET&gt;</code> tag for this applet.
  82:    *
  83:    * @param name the parameter name
  84:    * @return the parameter value, or null if the parameter does not exist
  85:    * @throws NullPointerException if name is null
  86:    */
  87:   String getParameter(String name);
  88: 
  89:   /**
  90:    * Returns the applet context for this applet.
  91:    *
  92:    * @return the applet context for this applet
  93:    */
  94:   AppletContext getAppletContext();
  95: 
  96:   /**
  97:    * Requests that the applet window for this applet be resized.
  98:    *
  99:    * @param width the new width in pixels
 100:    * @param height the new height in pixels
 101:    */
 102:   void appletResize(int width, int height);
 103: } // interface AppletStub