java.applet

Interface AppletContext

public interface AppletContext

This interface allows an applet access to the browser to retrieve additional data files and display documents. It also allows the applet to find out other applets in the same document.

Since:
1.0

Method Summary

Applet
getApplet(String name)
Returns the applet in the document for this object that has the specified name.
Enumeration
getApplets()
Returns a list of all the applets in the document for this object.
AudioClip
getAudioClip(URL url)
Returns an audio clip from the specified URL.
Image
getImage(URL url)
Returns an image from the specified URL.
InputStream
getStream(String key)
Return the stream associated with a given key in this applet context, or null if nothing is associated.
Iterator
getStreamKeys()
Iterate over all keys that have associated streams.
void
setStream(String key, InputStream stream)
Associate a stream to a key for this applet context, possibly replacing the old value.
void
showDocument(URL url)
Displays the web page pointed to by the specified URL in the window for this object.
void
showDocument(URL url, String target)
Displays the web page pointed to be the sepcified URL in the window with the specified name.
void
showStatus(String message)
Displays the specified message in the status window if that window exists.

Method Details

getApplet

public Applet getApplet(String name)
Returns the applet in the document for this object that has the specified name.

Parameters:
name - the applet name

Returns:
the requested applet, or null if not found


getApplets

public Enumeration getApplets()
Returns a list of all the applets in the document for this object.

Returns:
a list of all the applets


getAudioClip

public AudioClip getAudioClip(URL url)
Returns an audio clip from the specified URL.

Parameters:
url - the URL of the audio clip

Returns:
the retrieved audio clip

Throws:
NullPointerException - if url is null


getImage

public Image getImage(URL url)
Returns an image from the specified URL. Note that the image is not actually retrieved until the applet attempts to display it, so this method returns immediately.

Parameters:
url - the absolute URL of the image

Returns:
the retrieved image

Throws:
NullPointerException - if url is null


getStream

public InputStream getStream(String key)
Return the stream associated with a given key in this applet context, or null if nothing is associated. Stream associations are local to the applet context, for security purposes.

Parameters:
key - the key to look up

Returns:
the associated stream, or null

Since:
1.4


getStreamKeys

public Iterator getStreamKeys()
Iterate over all keys that have associated streams. Stream associated are local to the applet context, for security purposes.

Returns:
an iterator over the association keys

Since:
1.4


setStream

public void setStream(String key,
                      InputStream stream)
            throws IOException
Associate a stream to a key for this applet context, possibly replacing the old value. Stream associations are local to the applet context, for security purposes.

Parameters:
key - the key to associate with
stream - the stream value to tie to the key, or null to remove

Throws:
IOException - if the stream is too large

Since:
1.4


showDocument

public void showDocument(URL url)
Displays the web page pointed to by the specified URL in the window for this object. This page replaces the document that is currently there.

Parameters:
url - the URL of the web page to load; unspecified on an error


showDocument

public void showDocument(URL url,
                         String target)
Displays the web page pointed to be the sepcified URL in the window with the specified name. The standard names "_top", "_blank", "_parent", and "_self" are allowed. An applet viewer may disregard this request.

Parameters:
url - the URL of the web page to load
target - the target window


showStatus

public void showStatus(String message)
Displays the specified message in the status window if that window exists.

Parameters:
message - the status message, may be null


AppletContext.java -- access the applet's runtime environment Copyright (C) 1999, 2002, 2004 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.