home *** CD-ROM | disk | FTP | other *** search
/ Symantec Visual Cafe for Java 2.5 / symantec-visual-cafe-2.5-database-dev-edition.iso / VCafe / main.bin / AppletContext.java < prev    next >
Encoding:
Java Source  |  1997-05-20  |  4.9 KB  |  137 lines
  1. /*
  2.  * @(#)AppletContext.java    1.14 96/11/23
  3.  * 
  4.  * Copyright (c) 1995, 1996 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not
  8.  * disclose such Confidential Information and shall use it only in
  9.  * accordance with the terms of the license agreement you entered into
  10.  * with Sun.
  11.  * 
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  13.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  14.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  15.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  16.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  17.  * THIS SOFTWARE OR ITS DERIVATIVES.
  18.  * 
  19.  * CopyrightVersion 1.1_beta
  20.  * 
  21.  */
  22.  
  23. package java.applet;
  24.  
  25. import java.awt.Image;
  26. import java.awt.Graphics;
  27. import java.awt.image.ColorModel;
  28. import java.net.URL;
  29. import java.util.Enumeration;
  30.  
  31. /**
  32.  * This interface corresponds to an applet's environment: the 
  33.  * document containing the applet and the other applets in the same 
  34.  * document. 
  35.  * <p>
  36.  * The methods in this interface can be used by an applet to obtain 
  37.  * information about its environment. 
  38.  *
  39.  * @author     Arthur van Hoff
  40.  * @version     1.19, 01/30/97
  41.  * @since       JDK1.0
  42.  */
  43. public interface AppletContext {
  44.     /**
  45.      * Creates an audio clip. 
  46.      *
  47.      * @param   url   an absolute URL giving the location of the audio clip.
  48.      * @return  the audio clip at the specified URL.
  49.      * @since   JDK1.0
  50.      */
  51.     AudioClip getAudioClip(URL url);
  52.  
  53.     /**
  54.      * Returns an <code>Image</code> object that can then be painted on 
  55.      * the screen. The <code>url</code> argument<code> </code>that is 
  56.      * passed as an argument must specify an absolute URL. 
  57.      * <p>
  58.      * This method always returns immediately, whether or not the image 
  59.      * exists. When the applet attempts to draw the image on the screen, 
  60.      * the data will be loaded. The graphics primitives that draw the 
  61.      * image will incrementally paint on the screen. 
  62.      *
  63.      * @param   url   an absolute URL giving the location of the image.
  64.      * @return  the image at the specified URL.
  65.      * @see     java.awt.Image
  66.      * @since   JDK1.0
  67.      */
  68.     Image getImage(URL url);
  69.  
  70.     /**
  71.      * Finds and returns the applet in the document represented by this 
  72.      * applet context with the given name. The name can be set in the 
  73.      * HTML tag by setting the <code>name</code> attribute. 
  74.      *
  75.      * @param   name   an applet name.
  76.      * @return  the applet with the given name, or <code>null</code> if
  77.      *          not found.
  78.      * @since   JDK1.0
  79.      */
  80.     Applet getApplet(String name);
  81.  
  82.     /**
  83.      * Finds all the applets in the document represented by this applet 
  84.      * context. 
  85.      *
  86.      * @return  an enumeration of all applets in the document represented by
  87.      *          this applet context.
  88.      * @since   JDK1.0
  89.      */
  90.     Enumeration getApplets();
  91.  
  92.     /**
  93.      * Replaces the Web page currently being viewed with the given URL. 
  94.      * This method may be ignored by applet contexts that are not 
  95.      * browsers. 
  96.      *
  97.      * @param   url   an absolute URL giving the location of the document.
  98.      * @since   JDK1.0
  99.      */
  100.     void showDocument(URL url);
  101.  
  102.     /**
  103.      * Requests that the browser or applet viewer show the Web page 
  104.      * indicated by the <code>url</code> argument. The 
  105.      * <code>target</code> argument indicates where to display the frame. 
  106.      * The target argument is interpreted as follows:
  107.      * <p>
  108.      * <center><table border="3"> 
  109.      * <tr><td><code>"_self"</code>  <td>show in the current frame</tr>
  110.      * <tr><td><code>"_parent"</code><td>show in the parent frame</tr>
  111.      * <tr><td><code>"_top"</code>   <td>show in the topmost frame</tr>
  112.      * <tr><td><code>"_blank"</code> <td>show in a new unnamed
  113.      *                                   top-level window</tr>
  114.      * <tr><td>name<td>show in a new top-level window named <i>name</i></tr>
  115.      * </table> </center>
  116.      * <p>
  117.      * An applet viewer or browser is free to ignore <code>showDocument</code>. 
  118.      *
  119.      * @param   url   an absolute URL giving the location of the document.
  120.      * @param   target   a <code>String</code> indicating where to display
  121.      *                   the page.
  122.      * @since   JDK1.0
  123.      */
  124.     public void showDocument(URL url, String target);
  125.  
  126.     /**
  127.      * Requests that the argument string be displayed in the 
  128.      * "status window". Many browsers and applet viewers 
  129.      * provide such a window, where the application can inform users of 
  130.      * its current state. 
  131.      *
  132.      * @param   status   a string to display in the status window.
  133.      * @since   JDK1.0
  134.      */
  135.     void showStatus(String status);
  136. }
  137.