Package java.applet

Previous

Java API

Index

Next

Interface AppletContext

public  interface  java.applet.AppletContext
{
        // Methods
    public abstract Applet getApplet(String  name);	
    public abstract Enumeration getApplets();	
    public abstract AudioClip getAudioClip(URL  url);	
    public abstract Image getImage(URL  url);	
    public abstract void showDocument(URL  url);	
    public abstract void 	
        showDocument(URL  url, String  target);
    public abstract void showStatus(String  status);	
}

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.

Methods

getApplet

public abstract Applet getApplet(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.

Return Value:

Returns the applet with the given name, or null if not found.

Parameter	Description
name	an applet name

getApplets

public abstract Enumeration getApplets() 

Finds all the applets in the document represented by this applet context.

Return Value:

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

getAudioClip

public abstract AudioClip getAudioClip(URL  url) 

Creates an audio clip.

Return Value:

Returns the audio clip at the specified URL.

Parameter	Description
url	an absolute URL giving the location of the audio clip

getImage

public abstract Image getImage(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.

Return Value:

Returns the image at the specified URL.

Parameter	Description
url	an absolute URL giving the location of the image.

showDocument

public abstract void showDocument(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.

Parameter	Description
url	an absolute URL giving the location of the document

showDocument

public abstract void  showDocument(URL  url, String  target) 

Requests that the browser or applet viewer show the Web page indicated by the url argument. The target argument indicates where to display the frame. The target argument is interpreted as follows:

"_self"	show in the current frame
"_parent"	show in the parent frame
"_top"	show in the top-most frame
"_blank"	show in a new unnamed top-level window
name	show in a new top-level window named name

An applet viewer or browser is free to ignore.

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

showStatus

public abstract void showStatus(String  status) 

Requests that the argument string be displayed in the "status window." Many browsers and applet viewers provide such a "status window" where the application can inform users of its current state.

Parameter	Description
status	a string to display in the status window