1 |
/* AppletStub.java -- Low level interface to the browser. |
/* AppletStub.java -- low level interface to the browser |
2 |
Copyright (C) 1999 Free Software Foundation, Inc. |
Copyright (C) 1999, 2002 Free Software Foundation, Inc. |
3 |
|
|
4 |
This file is part of GNU Classpath. |
This file is part of GNU Classpath. |
5 |
|
|
6 |
GNU Classpath is free software; you can redistribute it and/or modify |
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 |
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) |
the Free Software Foundation; either version 2, or (at your option) |
9 |
any later version. |
any later version. |
10 |
|
|
11 |
GNU Classpath is distributed in the hope that it will be useful, but |
GNU Classpath is distributed in the hope that it will be useful, but |
12 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
WITHOUT ANY WARRANTY; without even the implied warranty of |
13 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 |
General Public License for more details. |
General Public License for more details. |
15 |
|
|
16 |
You should have received a copy of the GNU General Public License |
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 |
along with GNU Classpath; see the file COPYING. If not, write to the |
18 |
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
19 |
02111-1307 USA. |
02111-1307 USA. |
20 |
|
|
21 |
Linking this library statically or dynamically with other modules is |
Linking this library statically or dynamically with other modules is |
22 |
making a combined work based on this library. Thus, the terms and |
making a combined work based on this library. Thus, the terms and |
23 |
conditions of the GNU General Public License cover the whole |
conditions of the GNU General Public License cover the whole |
40 |
import java.net.URL; |
import java.net.URL; |
41 |
|
|
42 |
/** |
/** |
43 |
* This interface is the low level interface between the applet and the |
* This interface is the low level interface between the applet and the |
44 |
* browser. |
* browser. |
45 |
* |
* |
46 |
* @author Aaron M. Renn (arenn@urbanophile.com) |
* @author Aaron M. Renn (arenn@urbanophile.com) |
47 |
*/ |
* @see Applet#setStub(AppletStub) |
48 |
|
* @since 1.0 |
49 |
|
* @status updated to 1.4 |
50 |
|
*/ |
51 |
public interface AppletStub |
public interface AppletStub |
52 |
{ |
{ |
53 |
/** |
/** |
54 |
* Returns the URL of the document this applet is embedded in. |
* Tests whether or not this applet is currently active. An applet is active |
55 |
* |
* just before the browser invokes start(), and becomes inactive just |
56 |
* @return The URL of the document this applet is embedded in. |
* before the browser invokes stop(). |
57 |
*/ |
* |
58 |
|
* @return <code>true</code> if this applet is active |
59 |
|
*/ |
60 |
|
boolean isActive(); |
61 |
|
|
62 |
|
/** |
63 |
|
* Returns the basename URL of the document this applet is embedded in. This |
64 |
|
* is everything up to the final '/'. |
65 |
|
* |
66 |
|
* @return the URL of the document this applet is embedded in |
67 |
|
* @see #getCodeBase() |
68 |
|
*/ |
69 |
URL getDocumentBase(); |
URL getDocumentBase(); |
70 |
|
|
71 |
/** |
/** |
72 |
* Returns the URL of the code base for this applet. |
* Returns the URL of the code base for this applet. |
73 |
* |
* |
74 |
* @return The URL of the code base for this applet. |
* @return the URL of the code base for this applet |
75 |
*/ |
*/ |
76 |
URL getCodeBase(); |
URL getCodeBase(); |
77 |
|
|
78 |
/** |
/** |
79 |
* Returns the value of the specified parameter that was specified in |
* Returns the value of the specified parameter that was specified in |
80 |
* the <APPLET> tag for this applet. |
* the <code><APPLET></code> tag for this applet. |
81 |
* |
* |
82 |
* @param name The parameter name. |
* @param name the parameter name |
83 |
* |
* @return the parameter value, or null if the parameter does not exist |
84 |
* @param value The parameter value, or <code>null</code> if the parameter |
* @throws NullPointerException if name is null |
85 |
* does not exist. |
*/ |
|
*/ |
|
86 |
String getParameter(String name); |
String getParameter(String name); |
87 |
|
|
88 |
/** |
/** |
89 |
* Returns the applet context for this applet. |
* Returns the applet context for this applet. |
90 |
* |
* |
91 |
* @return The applet context for this applet. |
* @return the applet context for this applet |
92 |
*/ |
*/ |
93 |
AppletContext getAppletContext(); |
AppletContext getAppletContext(); |
94 |
|
|
95 |
/** |
/** |
96 |
* Tests whether or not this applet is currently active. |
* Requests that the applet window for this applet be resized. |
97 |
* |
* |
98 |
* @return <code>true</code> if this applet is active, <code>false</code> |
* @param width the new width in pixels |
99 |
* otherwise. |
* @param height the new height in pixels |
100 |
*/ |
*/ |
|
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. |
|
|
*/ |
|
101 |
void appletResize(int width, int height); |
void appletResize(int width, int height); |
|
|
|
102 |
} // interface AppletStub |
} // interface AppletStub |
|
|
|