/* ----------------------------------------------------------------------------
   The Kiwi Toolkit - A Java Class Library
   Copyright (C) 1998-2004 Mark A. Lindner

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 
   The author may be contacted at: mark_a_lindner@yahoo.com
   ----------------------------------------------------------------------------
   $Log: KiwiAppletContext.java,v $
   Revision 1.4  2004/05/06 00:46:52  markl
   comment block updates

   Revision 1.3  2003/06/02 06:49:44  markl
   Added applet map management to context.

   Revision 1.2  2003/06/01 11:08:55  markl
   Final refinements for release 1.4.2
   ----------------------------------------------------------------------------
*/

package kiwi.ui.applet;

import java.applet.*;
import java.awt.*;
import java.io.*;
import java.net.*;
import java.util.*;

import kiwi.ui.*;

/** A basic implementation of an applet context. The
  * <code>showDocument()</code> and <code>showStatus()</code> methods are
  * no-ops and may be overriden by subclasses to provide application-specific
  * behavior.
  *
  * @author Mark Lindner
  * @since Kiwi 1.4.2
  */

public abstract class KiwiAppletContext implements AppletContext
  {
  private Hashtable applets;
  private Hashtable streams;

  /** Construct a new Kiwi applet context.
   */
  
  public KiwiAppletContext()
    {
    applets = new Hashtable();
    streams = new Hashtable();
    }

  /** Add an applet to the applet context.
    *
    * @param name The name of the applet.
    * @param applet The applet to add.
    */
  
  public void addApplet(String name, Applet applet)
    {
    applets.put(name, applet);
    }

  /** Remove an applet from the applet context.
   *
   * @param name The name of the applet to remove.
   */

  public void removeApplet(String name)
    {
    applets.remove(name);
    }
  
  /** Look up an applet by name.
    *
    * @param name The name of the applet
    * @return The <code>Applet</code> object on success, or <code>null</code>
    * if an applet with the given name was not found in this applet context.
    */
  
  public Applet getApplet(String name)
    {
    return((Applet)applets.get(name));
    }

  /** Get all of the applets managed by this applet context.
    *
    * @return An enumeration of <code>Applet</code> objects.
    */
  
  public Enumeration getApplets()
    {
    return(applets.elements());
    }

  /** Load an audio clip at the specified URL.
    *
    * @param url The URL of the audio clip to load.
    * @return The audio clip on success, or <code>null</code> on failure.
    */
  
  public java.applet.AudioClip getAudioClip(URL url)
    {
    java.applet.AudioClip ac = null;

    try
      {
      ac = new kiwi.ui.AudioClip(url);

      }
    catch(Exception ex) { ex.printStackTrace(); }
    
    return(ac);
    }

  /** Load an image at the specified URL.
    *
    * @param url The URL of the image to load.
    * @return The image on success, or <code>null</code> on failure.
    */
  
  public Image getImage(URL url)
    {
    Toolkit tk = Toolkit.getDefaultToolkit();

    Image img = tk.getImage(url);

    return(img);
    }

  /** Display the document at the given URL. The default implementation does
    * nothing.
    */
  
  public void showDocument(URL url)
    {
    }

  /** Display the document at the given URL. The default implementation does
    * nothing.
    */
  
  public void showDocument(URL url, String target)
    {
    }

  /** Get a list of keys of the streams associated with this applet context.
    *
    * @return An iterator for the stream keys.
    */
  
  public Iterator getStreamKeys()
    {
    return(streams.keySet().iterator());
    }

  /** Associate a stream with this applet context.
    *
    * @param key The key for the stream.
    * @param stream The stream.
    * @exception java.io.IOException If an I/O exception occurs.
    */
  
  public void setStream(String key, InputStream stream) throws IOException
    {
    streams.put(key, stream);
    }

  /** Look up a stream by key.
    *
    * @param key The key for the stream.
    * @return The <code>InputStream</code> on success, or <code>null</code> if
    * a stream with the given key is not associated with this applet context.
    */
  
  public InputStream getStream(String key)
    {
    return((InputStream)streams.get(key));
    }

  /** Display a status message from the applet. The default implementation
    * does nothing.
    *
    * @param msg The message to display.
    */
  
  public void showStatus(String msg)
    {
    }
  
  }

/* end of source file */