gcc/libjava/doc/java-applet.texi
Anthony Green 6a9d31a7d4 001-01-07 Anthony Green <green@redhat.com>
* Makefile.am (texinfo): Add texinfo target for generating texinfo
        documentation.
	* Makefile.in: Rebuilt.

	* scripts/TexinfoDoclet.java: New file.

	* doc/java-applet.texi, doc/java-lang-reflect.texi,
	doc/java-awt-color.texi, doc/java-lang.texi,
	doc/java-awt-datatransfer.texi, doc/java-math.texi,
        doc/java-awt-event.texi, doc/java-net.texi,
	doc/java-awt-geom.texi, doc/java-security-spec.texi,
	doc/java-awt-image.texi, doc/java-security.texi,
	doc/java-awt-peer.texi, doc/java-sql.texi, doc/java-awt.texi,
	doc/java-text.texi, doc/java-beans-beancontext.texi,
        doc/java-util-jar.texi, doc/java-beans.texi,
	doc/java-util-zip.texi, doc/java-io.texi, doc/java-util.texi,
	doc/java-lang-ref.texi: New files.

From-SVN: r38789
2001-01-08 00:27:51 +00:00

142 lines
6.9 KiB
Plaintext

@deftypemethod AppletContext {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url})
Returns an audio clip from the specified URL.
@end deftypemethod
@deftypemethod AppletContext {public Image} getImage (java.net.URL@w{ }@var{url})
Returns an image from the specified URL. Note that the image is not
actually retrieved until the applet attempts to display it, so this
method returns immediately.
@end deftypemethod
@deftypemethod AppletContext {public Applet} getApplet (java.lang.String@w{ }@var{name})
Returns the applet in the document for this object that has the
specified name.
@end deftypemethod
@deftypemethod AppletContext {public Enumeration} getApplets ()
Returns a list of all the applets in the document for this object.
@end deftypemethod
@deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url})
Displays the web page pointed to by the specified URL in the window
for this object. This page replaces the document that is currently
there.
@end deftypemethod
@deftypemethod AppletContext {public void} showDocument (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{target})
Displays the web page pointed to be the sepcified URL in the window
with the specified name. The standard names "_top", "_blank",
"_parent", and "_self" are allowed.
@end deftypemethod
@deftypemethod AppletContext {public void} showStatus (java.lang.String@w{ }@var{message})
Displays the specified message in the status window if that window
exists.
@end deftypemethod
@deftypemethod Applet {public URL} getDocumentBase ()
Returns the URL of the document this applet is embedded in.
@end deftypemethod
@deftypemethod Applet {public URL} getCodeBase ()
Returns the URL of the code base for this applet.
@end deftypemethod
@deftypemethod Applet {public String} getParameter (java.lang.String@w{ }@var{name})
Returns the value of the specified parameter that was specified in
the &lt;APPLET&gt; tag for this applet.
@end deftypemethod
@deftypemethod Applet {public AppletContext} getAppletContext ()
Returns the applet context for this applet.
@end deftypemethod
@deftypemethod Applet {public boolean} isActive ()
Tests whether or not this applet is currently active.
@end deftypemethod
@deftypemethod Applet {public void} resize (int@w{ }@var{width}, int@w{ }@var{height})
Requests that the applet window for this applet be resized.
@end deftypemethod
@deftypemethod Applet {public void} resize (java.awt.Dimension@w{ }@var{dim})
Requests that the applet window for this applet be resized.
@end deftypemethod
@deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url})
Returns an audio clip from the specified URL.
@end deftypemethod
@deftypemethod Applet {public AudioClip} getAudioClip (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
Returns an audio clip from the specified URL and name
@end deftypemethod
@deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url})
Loads and plays the audio clip pointed to by the specified URL.
@end deftypemethod
@deftypemethod Applet {public void} play (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
Loads and plays the audio clip pointed to by the specified URL.
@end deftypemethod
@deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url})
Returns an image from the specified URL. Note that the image is not
actually retrieved until the applet attempts to display it, so this
method returns immediately.
@end deftypemethod
@deftypemethod Applet {public Image} getImage (java.net.URL@w{ }@var{url}, java.lang.String@w{ }@var{name})
Returns an image from the specified URL. Note that the image is not
actually retrieved until the applet attempts to display it, so this
method returns immediately.
@end deftypemethod
@deftypemethod Applet {public Locale} getLocale ()
Returns the locale for this applet, if it has been set. If no applet
specific locale has been set, the default locale is returned.
@end deftypemethod
@deftypemethod Applet {public String} getAppletInfo ()
Returns a descriptive string with applet defined information. The
implementation in this class returns @code{null}. Applets who
wish to return this information should override.
@end deftypemethod
@deftypemethod Applet {public String} getParameterInfo ()
Returns a list of parameters this applet supports. Each element of
the array is a list of three strings with the name of the parameter,
the data type or valid values, and a description. This method is
optional and the default implementation returns @code{null}.
@end deftypemethod
@deftypemethod Applet {public void} init ()
This method is called when the applet is first loaded. The default
implementation does nothing. Applets that wish to do one time
initialization should override.
@end deftypemethod
@deftypemethod Applet {public void} destroy ()
This method is called when the applet is being unloaded. The default
implementation does nothing. Applets that need to clean up resources
on exit should override.
@end deftypemethod
@deftypemethod Applet {public void} start ()
This method is called when the applet should start running. This is
normally each time a web page containing it is loaded. The default
implemention does nothing. Subclasses should override.
@end deftypemethod
@deftypemethod Applet {public void} stop ()
This method is called when the applet should stop running. This is
normally when the next web page is loaded. The default implementation
does nothing.
@end deftypemethod
@deftypemethod Applet {public final void} setStub (java.applet.AppletStub@w{ }@var{stub})
The browser calls this method to set the applet's stub, which is the
low level interface to the browser.
@end deftypemethod
@deftypemethod AppletStub {public URL} getDocumentBase ()
Returns the URL of the document this applet is embedded in.
@end deftypemethod
@deftypemethod AppletStub {public URL} getCodeBase ()
Returns the URL of the code base for this applet.
@end deftypemethod
@deftypemethod AppletStub {public String} getParameter (java.lang.String@w{ }@var{name})
Returns the value of the specified parameter that was specified in
the &lt;APPLET&gt; tag for this applet.
@end deftypemethod
@deftypemethod AppletStub {public AppletContext} getAppletContext ()
Returns the applet context for this applet.
@end deftypemethod
@deftypemethod AppletStub {public boolean} isActive ()
Tests whether or not this applet is currently active.
@end deftypemethod
@deftypemethod AppletStub {public void} appletResize (int@w{ }@var{width}, int@w{ }@var{height})
Requests that the applet window for this applet be resized.
@end deftypemethod
@deftypemethod AudioClip {public void} play ()
Plays the audio clip starting from the beginning.
@end deftypemethod
@deftypemethod AudioClip {public void} stop ()
Stops playing this audio clip. There is no mechanism for restarting
at the point where the clip is stopped.
@end deftypemethod
@deftypemethod AudioClip {public void} loop ()
Plays this audio clip in a continuous loop.
@end deftypemethod