FileDocCategorySizeDatePackage
AppletContext.javaAPI DocJava SE 5 API7014Fri Aug 26 14:56:42 BST 2005java.applet

AppletContext

public interface AppletContext
This interface corresponds to an applet's environment: the document containing the applet and the other applets in the same document.

The methods in this interface can be used by an applet to obtain information about its environment.

author
Arthur van Hoff
version
1.31, 05/05/04
since
JDK1.0

Fields Summary
Constructors Summary
Methods Summary
public java.applet.AppletgetApplet(java.lang.String name)
Finds and returns the applet in the document represented by this applet context with the given name. The name can be set in the HTML tag by setting the name attribute.

param
name an applet name.
return
the applet with the given name, or null if not found.

public java.util.EnumerationgetApplets()
Finds all the applets in the document represented by this applet context.

return
an enumeration of all applets in the document represented by this applet context.

public java.applet.AudioClipgetAudioClip(java.net.URL url)
Creates an audio clip.

param
url an absolute URL giving the location of the audio clip.
return
the audio clip at the specified URL.

public java.awt.ImagegetImage(java.net.URL url)
Returns an Image object that can then be painted on the screen. The url argument that is passed as an argument must specify an absolute URL.

This method always returns immediately, whether or not the image exists. When the applet attempts to draw the image on the screen, the data will be loaded. The graphics primitives that draw the image will incrementally paint on the screen.

param
url an absolute URL giving the location of the image.
return
the image at the specified URL.
see
java.awt.Image

public java.io.InputStreamgetStream(java.lang.String key)
Returns the stream to which specified key is associated within this applet context. Returns null if the applet context contains no stream for this key.

For security reasons, mapping of streams and keys exists for each codebase. In other words, applet from one codebase cannot access the streams created by an applet from a different codebase

return
the stream to which this applet context maps the key
param
key key whose associated stream is to be returned.
since
JDK1.4

public java.util.IteratorgetStreamKeys()
Finds all the keys of the streams in this applet context.

For security reasons, mapping of streams and keys exists for each codebase. In other words, applet from one codebase cannot access the streams created by an applet from a different codebase

return
an Iterator of all the names of the streams in this applet context.
since
JDK1.4

public voidsetStream(java.lang.String key, java.io.InputStream stream)
Associates the specified stream with the specified key in this applet context. If the applet context previously contained a mapping for this key, the old value is replaced.

For security reasons, mapping of streams and keys exists for each codebase. In other words, applet from one codebase cannot access the streams created by an applet from a different codebase

param
key key with which the specified value is to be associated.
param
stream stream to be associated with the specified key. If this parameter is null, the specified key is removed in this applet context.
throws
IOException if the stream size exceeds a certain size limit. Size limit is decided by the implementor of this interface.
since
JDK1.4

public voidshowDocument(java.net.URL url)
Replaces the Web page currently being viewed with the given URL. This method may be ignored by applet contexts that are not browsers.

param
url an absolute URL giving the location of the document.

public voidshowDocument(java.net.URL url, java.lang.String target)
Requests that the browser or applet viewer show the Web page indicated by the url argument. The target argument indicates in which HTML frame the document is to be displayed. The target argument is interpreted as follows:

Target ArgumentDescription
"_self" Show in the window and frame that contain the applet.
"_parent"Show in the applet's parent frame. If the applet's frame has no parent frame, acts the same as "_self".
"_top" Show in the top-level frame of the applet's window. If the applet's frame is the top-level frame, acts the same as "_self".
"_blank" Show in a new, unnamed top-level window.
nameShow in the frame or window named name. If a target named name does not already exist, a new top-level window with the specified name is created, and the document is shown there.

An applet viewer or browser is free to ignore showDocument.

param
url an absolute URL giving the location of the document.
param
target a String indicating where to display the page.

public voidshowStatus(java.lang.String status)
Requests that the argument string be displayed in the "status window". Many browsers and applet viewers provide such a window, where the application can inform users of its current state.

param
status a string to display in the status window.