diff options
Diffstat (limited to 'libjava/java/applet/AppletStub.java')
| -rw-r--r-- | libjava/java/applet/AppletStub.java | 97 |
1 files changed, 50 insertions, 47 deletions
diff --git a/libjava/java/applet/AppletStub.java b/libjava/java/applet/AppletStub.java index 5ec428a..7694cc8 100644 --- a/libjava/java/applet/AppletStub.java +++ b/libjava/java/applet/AppletStub.java @@ -1,23 +1,23 @@ -/* AppletStub.java -- Low level interface to the browser. - Copyright (C) 1999 Free Software Foundation, Inc. - +/* AppletStub.java -- low level interface to the browser + Copyright (C) 1999, 2002 Free Software Foundation, Inc. + This file is part of GNU Classpath. - + GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. - + GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. - + Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole @@ -40,60 +40,63 @@ package java.applet; import java.net.URL; /** - * This interface is the low level interface between the applet and the - * browser. - * - * @author Aaron M. Renn (arenn@urbanophile.com) - */ + * This interface is the low level interface between the applet and the + * browser. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + * @see Applet#setStub(AppletStub) + * @since 1.0 + * @status updated to 1.4 + */ public interface AppletStub { /** - * Returns the URL of the document this applet is embedded in. - * - * @return The URL of the document this applet is embedded in. - */ + * Tests whether or not this applet is currently active. An applet is active + * just before the browser invokes start(), and becomes inactive just + * before the browser invokes stop(). + * + * @return <code>true</code> if this applet is active + */ + boolean isActive(); + + /** + * Returns the basename URL of the document this applet is embedded in. This + * is everything up to the final '/'. + * + * @return the URL of the document this applet is embedded in + * @see #getCodeBase() + */ URL getDocumentBase(); /** - * Returns the URL of the code base for this applet. - * - * @return The URL of the code base for this applet. - */ + * Returns the URL of the code base for this applet. + * + * @return the URL of the code base for this applet + */ URL getCodeBase(); /** - * Returns the value of the specified parameter that was specified in - * the <APPLET> tag for this applet. - * - * @param name The parameter name. - * - * @param value The parameter value, or <code>null</code> if the parameter - * does not exist. - */ + * Returns the value of the specified parameter that was specified in + * the <code><APPLET></code> tag for this applet. + * + * @param name the parameter name + * @return the parameter value, or null if the parameter does not exist + * @throws NullPointerException if name is null + */ String getParameter(String name); /** - * Returns the applet context for this applet. - * - * @return The applet context for this applet. - */ + * Returns the applet context for this applet. + * + * @return the applet context for this applet + */ AppletContext getAppletContext(); /** - * Tests whether or not this applet is currently active. - * - * @return <code>true</code> if this applet is active, <code>false</code> - * otherwise. - */ - boolean isActive(); - - /** - * Requests that the applet window for this applet be resized. - * - * @param width The new width in pixels. - * @param height The new height in pixels. - */ + * Requests that the applet window for this applet be resized. + * + * @param width the new width in pixels + * @param height the new height in pixels + */ void appletResize(int width, int height); - } // interface AppletStub - |