Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.applet
Class Applet

    java.lang.Object
      |
      +--java.awt.Component
            |
            +--java.awt.Container
                  |
                  +--java.awt.Panel
                        |
                        +--java.applet.Applet

All Implemented Interfaces:
  Accessible, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:
  JApplet

public class Applet
extends Panel

An applet is a small program that is intended not to be run on its own, but rather to be embedded inside another application.

The `Applet` class must be the superclass of any applet that is to be embedded in a Web page or viewed by the Java Applet Viewer. The `Applet` class provides a standard interface between applets and their environment.

Since:
  JDK1.0
See Also:
  Serialized Form

Inner Class Summary
`protected class` | `Applet.AccessibleApplet` This class implements accessibility support for the `Applet` class.

Inner classes inherited from class java.awt.Panel
`Panel.AccessibleAWTPanel`

Inner classes inherited from class java.awt.Container
`Container.AccessibleAWTContainer`

Inner classes inherited from class java.awt.Component
`Component.AccessibleAWTComponent`

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

Fields inherited from interface java.awt.image.ImageObserver
`ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH`

Constructor Summary
`Applet()`

Method Summary
`void` | `destroy()` Called by the browser or applet viewer to inform this applet that it is being reclaimed and that it should destroy any resources that it has allocated.
`AccessibleContext` | `getAccessibleContext()` Gets the AccessibleContext associated with this Applet.
`AppletContext` | `getAppletContext()` Determines this applet's context, which allows the applet to query and affect the environment in which it runs.
`String` | `getAppletInfo()` Returns information about this applet.
`AudioClip` | `getAudioClip(URL url)` Returns the `AudioClip` object specified by the `URL` argument.
`AudioClip` | `getAudioClip(URL url, String name)` Returns the `AudioClip` object specified by the `URL` and `name` arguments.
`URL` | `getCodeBase()` Gets the base URL.
`URL` | `getDocumentBase()` Returns an absolute URL naming the directory of the document in which the applet is embedded.
`Image` | `getImage(URL url)` Returns an `Image` object that can then be painted on the screen.
`Image` | `getImage(URL url, String name)` Returns an `Image` object that can then be painted on the screen.
`Locale` | `getLocale()` Gets the Locale for the applet, if it has been set.
`String` | `getParameter(String name)` Returns the value of the named parameter in the HTML tag.
`String[][]` | `getParameterInfo()` Returns information about the parameters than are understood by this applet.
`void` | `init()` Called by the browser or applet viewer to inform this applet that it has been loaded into the system.
`boolean` | `isActive()` Determines if this applet is active.
`static AudioClip` | `newAudioClip(URL url)` Get an audio clip from the given URL.
`void` | `play(URL url)` Plays the audio clip at the specified absolute URL.
`void` | `play(URL url, String name)` Plays the audio clip given the URL and a specifier that is relative to it.
`void` | `resize(Dimension d)` Requests that this applet be resized.
`void` | `resize(int width, int height)` Requests that this applet be resized.
`void` | `setStub(AppletStub stub)` Sets this applet's stub.
`void` | `showStatus(String msg)` Requests that the argument string be displayed in the "status window".
`void` | `start()` Called by the browser or applet viewer to inform this applet that it should start its execution.
`void` | `stop()` Called by the browser or applet viewer to inform this applet that it should stop its execution.

Methods inherited from class java.awt.Panel
`addNotify`

Methods inherited from class java.awt.Container
`add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, setLayout, update, validate, validateTree`

Methods inherited from class java.awt.Component
`action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Applet

    public Applet()

Method Detail

### setStub

    public final void setStub(AppletStub stub)

  Sets this applet's stub. This is done automatically by the system.
  Parameters:
    `stub` - the new stub.

### isActive

    public boolean isActive()

  Determines if this applet is active. An applet is marked 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.
  See Also:
    `start()`, `stop()`

### getDocumentBase

    public URL getDocumentBase()

  Returns an absolute URL naming the directory 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/

  Returns:
    the `URL` of the document that contains this applet.
  See Also:
    `getCodeBase()`

### getCodeBase

    public URL getCodeBase()

  Gets the base URL. This is the URL of the applet itself.
  Returns:
    the `URL` of this applet.
  See Also:
    `getDocumentBase()`

### getParameter

    public String getParameter(String name)

  Returns the value of the named parameter in the HTML tag. For example, if this 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"`.

  The `name` argument is case insensitive.

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

### getAppletContext

    public AppletContext getAppletContext()

  Determines this applet's context, which allows the applet to query and affect the environment in which it runs.

  This environment of an applet represents the document that contains the applet.

  Returns:
    the applet's context.

### resize

    public void resize(int width,
                       int height)

  Requests that this applet be resized.
  Overrides:
    `resize` in class `Component`
  Parameters:
    `width` - the new requested width for the applet.
    `height` - the new requested height for the applet.

### resize

    public void resize(Dimension d)

  Requests that this applet be resized.
  Overrides:
    `resize` in class `Component`
  Parameters:
    `d` - an object giving the new width and height.

### showStatus

    public void showStatus(String msg)

  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.
  Parameters:
    `msg` - a string to display in the status window.

### getImage

    public Image getImage(URL url)

  Returns an `Image` object that can then be painted on the screen. The `url` that is passed as an argument must specify an absolute URL.

  This method always returns immediately, whether or not the image exists. When this 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.

  Parameters:
    `url` - an absolute URL giving the location of the image.
  Returns:
    the image at the specified URL.
  See Also:
    `Image`

### getImage

    public Image getImage(URL url,
                          String name)

  Returns an `Image` object that can then be painted on the screen. The `url` argument must specify an absolute URL. The `name` argument is a specifier that is relative to the `url` argument.

  This method always returns immediately, whether or not the image exists. When this 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.

  Parameters:
    `url` - an absolute URL giving the base location of the image.
    `name` - the location of the image, relative to the `url` argument.
  Returns:
    the image at the specified URL.
  See Also:
    `Image`

### newAudioClip

    public static final AudioClip newAudioClip(URL url)

  Get an audio clip from the given URL.
  Parameters:
    `url` - points to the audio clip
  Returns:
    the audio clip at the specified URL.
  Since:
    1.2

### getAudioClip

    public AudioClip getAudioClip(URL url)

  Returns the `AudioClip` object specified by the `URL` argument.

  This method always returns immediately, whether or not the audio clip exists. When this applet attempts to play the audio clip, the data will be loaded.

  Parameters:
    `url` - an absolute URL giving the location of the audio clip.
  Returns:
    the audio clip at the specified URL.
  See Also:
    `AudioClip`

### getAudioClip

    public AudioClip getAudioClip(URL url,
                                  String name)

  Returns the `AudioClip` object specified by the `URL` and `name` arguments.

  This method always returns immediately, whether or not the audio clip exists. When this applet attempts to play the audio clip, the data will be loaded.

  Parameters:
    `url` - an absolute URL giving the base location of the audio clip.
    `name` - the location of the audio clip, relative to the `url` argument.
  Returns:
    the audio clip at the specified URL.
  See Also:
    `AudioClip`

### getAppletInfo

    public String getAppletInfo()

  Returns information about this applet. An applet should override this method to return a `String` containing information about the author, version, and copyright of the applet.

  The implementation of this method provided by the `Applet` class returns `null`.

  Returns:
    a string containing information about the author, version, and copyright of the applet.

### getLocale

    public Locale getLocale()

  Gets the Locale for the applet, if it has been set. If no Locale has been set, then the default Locale is returned.
  Overrides:
    `getLocale` in class `Component`
  Returns:
    the Locale for the applet
  Since:
    JDK1.1

### getParameterInfo

    public String[][] getParameterInfo()

  Returns information about the parameters than are understood by this applet. An applet should override this method to return an array of `Strings` describing these parameters.

  Each element of the array should be a set of three `Strings` containing the name, the type, and a description. For example:

  >      String pinfo[][] = {
  >     	 {"fps",    "1-10",    "frames per second"},
  >     	 {"repeat", "boolean", "repeat image loop"},
  >     	 {"imgs",   "url",     "images directory"}
  >      };

  The implementation of this method provided by the `Applet` class returns `null`.

  Returns:
    an array describing the parameters this applet looks for.

### play

    public void play(URL url)

  Plays the audio clip at the specified absolute URL. Nothing happens if the audio clip cannot be found.
  Parameters:
    `url` - an absolute URL giving the location of the audio clip.

### play

    public void play(URL url,
                     String name)

  Plays the audio clip given the URL and a specifier that is relative to it. Nothing happens if the audio clip cannot be found.
  Parameters:
    `url` - an absolute URL giving the base location of the audio clip.
    `name` - the location of the audio clip, relative to the `url` argument.

### init

    public void init()

  Called by the browser or applet viewer to inform this applet that it has been loaded into the system. It is always called before the first time that the `start` method is called.

  A subclass of `Applet` should override this method if it has initialization to perform. For example, an applet with threads would use the `init` method to create the threads and the `destroy` method to kill them.

  The implementation of this method provided by the `Applet` class does nothing.

  See Also:
    `destroy()`, `start()`, `stop()`

### start

    public void start()

  Called by the browser or applet viewer to inform this applet that it should start its execution. It is called after the `init` method and each time the applet is revisited in a Web page.

  A subclass of `Applet` should override this method if it has any operation that it wants to perform each time the Web page containing it is visited. For example, an applet with animation might want to use the `start` method to resume animation, and the `stop` method to suspend the animation.

  The implementation of this method provided by the `Applet` class does nothing.

  See Also:
    `destroy()`, `init()`, `stop()`

### stop

    public void stop()

  Called by the browser or applet viewer to inform this applet that it should stop its execution. It is called when the Web page that contains this applet has been replaced by another page, and also just before the applet is to be destroyed.

  A subclass of `Applet` should override this method if it has any operation that it wants to perform each time the Web page containing it is no longer visible. For example, an applet with animation might want to use the `start` method to resume animation, and the `stop` method to suspend the animation.

  The implementation of this method provided by the `Applet` class does nothing.

  See Also:
    `destroy()`, `init()`

### destroy

    public void destroy()

  Called by the browser or applet viewer to inform this applet that it is being reclaimed and that it should destroy any resources that it has allocated. The `stop` method will always be called before `destroy`.

  A subclass of `Applet` should override this method if it has any operation that it wants to perform before it is destroyed. For example, an applet with threads would use the `init` method to create the threads and the `destroy` method to kill them.

  The implementation of this method provided by the `Applet` class does nothing.

  See Also:
    `init()`, `start()`, `stop()`

### getAccessibleContext

    public AccessibleContext getAccessibleContext()

  Gets the AccessibleContext associated with this Applet. For applets, the AccessibleContext takes the form of an AccessibleApplet. A new AccessibleApplet instance is created if necessary.
  Overrides:
    `getAccessibleContext` in class `Panel`
  Returns:
    an AccessibleApplet that serves as the AccessibleContext of this Applet

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.