001 /* AppletStub.java -- low level interface to the browser
002 Copyright (C) 1999, 2002, 2004 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.applet;
040
041 import java.net.URL;
042
043 /**
044 * This interface is the low level interface between the applet and the
045 * browser.
046 *
047 * @author Aaron M. Renn (arenn@urbanophile.com)
048 * @see Applet#setStub(AppletStub)
049 * @since 1.0
050 * @status updated to 1.4
051 */
052 public interface AppletStub
053 {
054 /**
055 * Tests whether or not this applet is currently active. An applet is active
056 * just before the browser invokes start(), and becomes inactive just
057 * before the browser invokes stop().
058 *
059 * @return <code>true</code> if this applet is active
060 */
061 boolean isActive();
062
063 /**
064 * Returns the basename URL of the document this applet is embedded in. This
065 * is everything up to the final '/'.
066 *
067 * @return the URL of the document this applet is embedded in
068 * @see #getCodeBase()
069 */
070 URL getDocumentBase();
071
072 /**
073 * Returns the URL of the code base for this applet.
074 *
075 * @return the URL of the code base for this applet
076 */
077 URL getCodeBase();
078
079 /**
080 * Returns the value of the specified parameter that was specified in
081 * the <code><APPLET></code> tag for this applet.
082 *
083 * @param name the parameter name
084 * @return the parameter value, or null if the parameter does not exist
085 * @throws NullPointerException if name is null
086 */
087 String getParameter(String name);
088
089 /**
090 * Returns the applet context for this applet.
091 *
092 * @return the applet context for this applet
093 */
094 AppletContext getAppletContext();
095
096 /**
097 * Requests that the applet window for this applet be resized.
098 *
099 * @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