// Copyright (c) 1996-98 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation for educational, research and non-profit
// purposes, without fee, and without a written agreement is hereby granted,
// provided that the above copyright notice and this paragraph appear in all
// copies. Permission to incorporate this software into commercial products may
// be obtained by contacting the University of California. David F. Redmiles
// Department of Information and Computer Science (ICS) University of
// California Irvine, California 92697-3425 Phone: 714-824-3823. This software
// program and documentation are copyrighted by The Regents of the University
// of California. The software program and documentation are supplied "as is",
// without any accompanying services from The Regents. The Regents do not
// warrant that the operation of the program will be uninterrupted or
// error-free. The end-user understands that the program was developed for
// research purposes and is advised not to rely exclusively on the program for
// any reason. IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY
// PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY
// DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
// SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
// ENHANCEMENTS, OR MODIFICATIONS.

// File: Globals.java
// Classes: Globals
// Original Author: jrobbins@ics.uci.edu
// $Id: Globals.java,v 1.22 1997/06/10 23:42:53 jrobbins Exp $

package uci.graphedit;

import java.util.*;
import java.applet.*;
import java.awt.*;
import java.net.*;
import uci.ui.*;

/** This class stores global info that is needed by all Editors. For
 *  example, it aids in communication between the various Palette's and
 *  Editor's by holding the next global Mode.  */

public class Globals {

  ////////////////////////////////////////////////////////////////
  // constants

  public static final String REMOVE = "Remove";
  public static final String HIGHLIGHT = "Highlight";
  public static final String UNHIGHLIGHT = "Unhighlight";

  ////////////////////////////////////////////////////////////////
  // applet related methods

  protected static AppletContext _appletContext;
  protected static Applet _applet;
  protected static MediaTracker _tracker;

  protected static TabPropFrame _tabPropFrame;

  public static String defaultStatus = "";

  public static void setApplet(Applet a) {
    _applet = a;
    if (!_applet.isActive()) return;
    _appletContext = a.getAppletContext();
    clearStatus();
    _tracker = new MediaTracker(a);
  }

  public static AppletContext getAppletContext() { return _appletContext; }
  public static Applet getApplet() { return _applet; }

  public static IStatusBar _StatusBar = null;
  public static void setStatusBar(IStatusBar sb) { _StatusBar = sb; }

  /** Show a string on the browser's status bar, or print a message
   * on the console.  */
  public static void showStatus(String s) {
    Editor ce = curEditor();
    if (_StatusBar != null) _StatusBar.showStatus(s);
    else if (_appletContext != null) _appletContext.showStatus(s);
    else if (ce != null) ce.showStatus(s);
    //else System.out.println(s);
  }

  public static void clearStatus() {
    showStatus(defaultStatus);
  }

  /**  <A HREF="../features.html#show_document">
   *  <TT>FEATURE: show_document</TT></A>
   */
  public static void showDocument(URL url) {
    if (_appletContext != null) _appletContext.showDocument(url);
  }

  /**  <A HREF="../features.html#show_document">
   *  <TT>FEATURE: show_document</TT></A>
   */
  public static void showDocument(URL url, String target) {
    if (_appletContext != null) _appletContext.showDocument(url, target);
  }

  /**  <A HREF="../features.html#show_document">
   *  <TT>FEATURE: show_document</TT></A>
   */
  public static void showDocument(String urlString) {
    URL url;
    try {
      url = new URL(urlString);
      showDocument(url);
    }
    catch (MalformedURLException ignore) { }
  }

  public static Image getImage(URL url) {
    Image img = null;
    if (_appletContext != null) img = _appletContext.getImage(url);
    if (_tracker !=null && img != null) _tracker.addImage(img, 1);
    return img;
  }

  public static Image getImage(String urlString) {
    try {
      Image img = null;
      URL url = new URL(urlString);
      if (_appletContext != null) img = _appletContext.getImage(url);
      if (_tracker !=null && img != null) _tracker.addImage(img, 1);
      return img;
    }
    catch (java.net.MalformedURLException e) { return null; }
  }

  public static void waitForImages() {
    if (_tracker == null) return;
    try { _tracker.waitForAll(); }
    catch (InterruptedException e) { }
  }

  public static void quit() {
    showStatus("Quiting");
    // Needs-More-Work: put up "are you sure?" dialog
    if (_appletContext != null) {
      // return are running an applet
      // Needs-More-Work: now it is up to the Applet to close all windows
      _applet.destroy();
    }
    // in any case, try to exit
    System.exit(0);
  }

  ////////////////////////////////////////////////////////////////
  // user preferences

  /** The user's preferences for various editor features. */
  protected static Prefs _prefs = new Prefs();

  /** Reply the user's preferences. */
  public static Prefs prefs() { return _prefs; }

  ////////////////////////////////////////////////////////////////
  // properties sheet

  /** <A HREF="../features.html#property_sheet">
   *  <TT>FEATURE: property_sheet</TT></A>
   */
  public static void setPropertySheet(TabPropFrame tpf) {
    _tabPropFrame = tpf;
  }

  /** <A HREF="../features.html#property_sheet">
   *  <TT>FEATURE: property_sheet</TT></A>
   */
  public static void startPropertySheet() {
    if (_tabPropFrame == null) _tabPropFrame = new TabPropFrame();
    if (_tabPropFrame.isVisible()) _tabPropFrame.toFront();
    else _tabPropFrame.show();
    if (curEditor() == null) return;
    Vector selectedDEs = curEditor().selectedDEs();
    if (selectedDEs.size() == 1)
      propertySheetSubject((DiagramElement)selectedDEs.elementAt(0));
  }

  /** <A HREF="../features.html#property_sheet">
   *  <TT>FEATURE: property_sheet</TT></A>
   */
  public static void propertySheetSubject(DiagramElement de) {
    if (_tabPropFrame != null)
      _tabPropFrame.select(de);
  }

  /** <A HREF="../features.html#property_sheet_universe">
   *  <TT>FEATURE: property_sheet_universe</TT></A>
   */
  public static void addToUniverse(DiagramElement de) {
    if (_tabPropFrame != null)
      _tabPropFrame.addToUniverse(de);
  }

  /** <A HREF="../features.html#property_sheet_universe">
   *  <TT>FEATURE: property_sheet_universe</TT></A>
   */
  public static void removeFromUniverse(DiagramElement de) {
    if (_tabPropFrame != null)
      _tabPropFrame.removeFromUniverse(de);
  }

  static {
    if (_tabPropFrame == null) _tabPropFrame = new TabPropFrame();
    //_tabPropFrame.show();
  }

  public static Frame someFrame() { return _tabPropFrame; }

  ////////////////////////////////////////////////////////////////
  // Editor Modes

  /** True if the next global Mode should remain as the next global
   *  mode even after it has been given to one editor. */
  protected static boolean _sticky = false;

  /** Set whether the next global mode should remain as the next
   *  global mode even after it has been given to one editor. */
  public static void setSticky(boolean b) { _sticky = b; }

  /** The next global mode. This is given to an editor on mouse entry */
  protected static Mode _mode;

  /** What mode should Editor's go into if the Palette is not
   *  requesting a specific mode? */
  protected static Mode defaultMode() { return new ModeSelect(); }

  /** Set the next global mode. */
  public static void mode(Mode m) { _mode = m; }

  /** Set the next global mode, and set it's stickiness. */
  public static void mode(Mode m, boolean s) {
    _mode = m;
    _sticky = s;
  }

  /** Reply the next global mode. */
  public static Mode mode() {
    if (_mode == null) _mode = defaultMode();
    return _mode;
  }

  /** Determine the next global mode. This is called when a mode
   *  finishes whatever it was meant to accomplish. For now, a sticky
   *  mode stays the next global mode, all other modes are "popped" off
   *  a single element stack and the defaultMode becomes the next
   *  global mode. In the future it may be useful to have a true stack
   *  of pending modes, I don't know.
   *
   * @see Mode#done */
  public static Mode nextMode() {
    if (!_sticky) _mode = defaultMode();
    return _mode;
  }

  ////////////////////////////////////////////////////////////////
  // Methods that keep track of the current editor

  /** The Editor that most recently contained the mouse. */
  protected static Editor _curEditor;

  /** Set the current Editor. */
  public static void curEditor(Editor ce) { _curEditor = ce; }

  /** Reply the Editor that most recently contained the mouse. */
  public static Editor curEditor() { return _curEditor; }

} /* end class Globals */