libjava/doc/java-applet.texi

   1 @deftypemethod AppletContext {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url})
   2 Returns an audio clip from the specified URL.
   3 @end deftypemethod
   4 @deftypemethod AppletContext {public Image} getImage (java.net.URL@w{ }@var{url})
   5 Returns an image from the specified URL.  Note that the image is not
   6  actually retrieved until the applet attempts to display it, so this
   7  method returns immediately.
   8 @end deftypemethod
   9 @deftypemethod AppletContext {public Applet} getApplet (java.lang.String@w{ }@var{name})
  10 Returns the applet in the document for this object that has the
  11  specified name.
  12 @end deftypemethod
  13 @deftypemethod AppletContext {public Enumeration} getApplets ()
  14 Returns a list of all the applets in the document for this object.
  15 @end deftypemethod
  16 @deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url})
  17 Displays the web page pointed to by the specified URL in the window
  18  for this object.  This page replaces the document that is currently
  19  there.
  20 @end deftypemethod
  21 @deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{target})
  22 Displays the web page pointed to be the sepcified URL in the window
  23  with the specified name.  The standard names "_top", "_blank",
  24  "_parent", and "_self" are allowed.
  25 @end deftypemethod
  26 @deftypemethod AppletContext {public void} showStatus (java.lang.String@w{ }@var{message})
  27 Displays the specified message in the status window if that window
  28  exists.
  29 @end deftypemethod
  30 @deftypemethod Applet {public URL} getDocumentBase ()
  31 Returns the URL of the document this applet is embedded in.
  32 @end deftypemethod
  33 @deftypemethod Applet {public URL} getCodeBase ()
  34 Returns the URL of the code base for this applet.
  35 @end deftypemethod
  36 @deftypemethod Applet {public String} getParameter (java.lang.String@w{ }@var{name})
  37 Returns the value of the specified parameter that was specified in
  38  the &lt;APPLET&gt; tag for this applet.
  39 @end deftypemethod
  40 @deftypemethod Applet {public AppletContext} getAppletContext ()
  41 Returns the applet context for this applet.
  42 @end deftypemethod
  43 @deftypemethod Applet {public boolean} isActive ()
  44 Tests whether or not this applet is currently active.
  45 @end deftypemethod
  46 @deftypemethod Applet {public void} resize (int@w{ }@var{width}, int@w{ }@var{height})
  47 Requests that the applet window for this applet be resized.
  48 @end deftypemethod
  49 @deftypemethod Applet {public void} resize (java.awt.Dimension@w{ }@var{dim})
  50 Requests that the applet window for this applet be resized.
  51 @end deftypemethod
  52 @deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url})
  53 Returns an audio clip from the specified URL.
  54 @end deftypemethod
  55 @deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
  56 Returns an audio clip from the specified URL and name
  57 @end deftypemethod
  58 @deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url})
  59 Loads and plays the audio clip pointed to by the specified URL.
  60 @end deftypemethod
  61 @deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
  62 Loads and plays the audio clip pointed to by the specified URL.
  63 @end deftypemethod
  64 @deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url})
  65 Returns an image from the specified URL.  Note that the image is not
  66  actually retrieved until the applet attempts to display it, so this
  67  method returns immediately.
  68 @end deftypemethod
  69 @deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
  70 Returns an image from the specified URL.  Note that the image is not
  71  actually retrieved until the applet attempts to display it, so this
  72  method returns immediately.
  73 @end deftypemethod
  74 @deftypemethod Applet {public Locale} getLocale ()
  75 Returns the locale for this applet, if it has been set.  If no applet
  76  specific locale has been set, the default locale is returned.
  77 @end deftypemethod
  78 @deftypemethod Applet {public String} getAppletInfo ()
  79 Returns a descriptive string with applet defined information.  The
  80  implementation in this class returns @code{null}.  Applets who
  81  wish to return this information should override.
  82 @end deftypemethod
  83 @deftypemethod Applet {public String} getParameterInfo ()
  84 Returns a list of parameters this applet supports.  Each element of
  85  the array is a list of three strings with the name of the parameter,
  86  the data type or valid values, and a description.  This method is
  87  optional and the default implementation returns @code{null}.
  88 @end deftypemethod
  89 @deftypemethod Applet {public void} init ()
  90 This method is called when the applet is first loaded.  The default
  91  implementation does nothing.  Applets that wish to do one time
  92  initialization should override.
  93 @end deftypemethod
  94 @deftypemethod Applet {public void} destroy ()
  95 This method is called when the applet is being unloaded.  The default
  96  implementation does nothing.  Applets that need to clean up resources
  97  on exit should override.
  98 @end deftypemethod
  99 @deftypemethod Applet {public void} start ()
 100 This method is called when the applet should start running.  This is
 101  normally each time a web page containing it is loaded.  The default
 102  implemention does nothing.  Subclasses should override.
 103 @end deftypemethod
 104 @deftypemethod Applet {public void} stop ()
 105 This method is called when the applet should stop running.  This is
 106  normally when the next web page is loaded.  The default implementation
 107  does nothing.
 108 @end deftypemethod
 109 @deftypemethod Applet {public final void} setStub (java.applet.AppletStub@w{ }@var{stub})
 110 The browser calls this method to set the applet's stub, which is the
 111  low level interface to the browser.
 112 @end deftypemethod
 113 @deftypemethod AppletStub {public URL} getDocumentBase ()
 114 Returns the URL of the document this applet is embedded in.
 115 @end deftypemethod
 116 @deftypemethod AppletStub {public URL} getCodeBase ()
 117 Returns the URL of the code base for this applet.
 118 @end deftypemethod
 119 @deftypemethod AppletStub {public String} getParameter (java.lang.String@w{ }@var{name})
 120 Returns the value of the specified parameter that was specified in
 121  the &lt;APPLET&gt; tag for this applet.
 122 @end deftypemethod
 123 @deftypemethod AppletStub {public AppletContext} getAppletContext ()
 124 Returns the applet context for this applet.
 125 @end deftypemethod
 126 @deftypemethod AppletStub {public boolean} isActive ()
 127 Tests whether or not this applet is currently active.
 128 @end deftypemethod
 129 @deftypemethod AppletStub {public void} appletResize (int@w{ }@var{width}, int@w{ }@var{height})
 130 Requests that the applet window for this applet be resized.
 131 @end deftypemethod
 132 @deftypemethod AudioClip {public void} play ()
 133 Plays the audio clip starting from the beginning.
 134 @end deftypemethod
 135 @deftypemethod AudioClip {public void} stop ()
 136 Stops playing this audio clip.  There is no mechanism for restarting
 137  at the point where the clip is stopped.
 138 @end deftypemethod
 139 @deftypemethod AudioClip {public void} loop ()
 140 Plays this audio clip in a continuous loop.
 141 @end deftypemethod