AppletStub (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.applet
interface AppletStub

public interface AppletStub

When an applet is first created, an applet stub is attached to it using the applet's setStub method. This stub serves as the interface between the applet and the browser environment or applet viewer environment in which the application is running.

Method Summary
`void`	`appletResize(int width, int height)` Called when the applet wants to be resized.
`AppletContext`	`getAppletContext()` Returns the applet's context.
`URL`	`getCodeBase()` Gets the base URL.
`URL`	`getDocumentBase()` Gets the URL of the document in which the applet is embedded.
`String`	`getParameter(String name)` Returns the value of the named parameter in the HTML tag.
`boolean`	`isActive()` Determines if the applet is active.

Method Detail

appletResize

public void appletResize(int width,
                         int height)

Called when the applet wants to be resized.

Parameters:: width - the new requested width for the applet.; height - the new requested height for the applet.

getAppletContext

public AppletContext getAppletContext()

Returns the applet's context.

Returns:: the applet's context.

getCodeBase

public URL getCodeBase()

Gets the base URL. This is the URL of the directory which contains the applet.

Returns:: the base {@link java.net.URL} of the directory which contains the applet.

getDocumentBase

public URL getDocumentBase()

Gets the URL of the document in which the applet is embedded. For example, suppose an applet is contained within the document:

    http://java.sun.com/products/jdk/1.2/index.html

The document base is:

    http://java.sun.com/products/jdk/1.2/index.html

Returns:: the {@link java.net.URL} of the document that contains the applet.

getParameter

public String getParameter(String name)

Returns the value of the named parameter in the HTML tag. For example, if an applet is specified as

 <applet code="Clock" width=50 height=50>
 <param name=Color value="blue">
 </applet>

then a call to getParameter("Color") returns the value "blue".

Parameters:: name - a parameter name.
Returns:: the value of the named parameter, or null if not set.

isActive

public boolean isActive()

Determines if the applet is active. An applet is active just before its start method is called. It becomes inactive just before its stop method is called.

Returns:: true if the applet is active; false otherwise.