/*
 * JextEvent.java - Jext event model
 * Copyright (C) 2000 Romain Guy
 *
 * This program 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 any later version.
 *
 * This program 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 program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package org.jext.event;

import org.jext.JextFrame;
import org.jext.JextTextArea;

/**
 * The JextEvent emitted by Jext windows on the order
 * of a Jext instance or on the order of another class
 * (JextTextArea for example).
 * @author Romain Guy
 * @see org.jext.event.JextListener
 */

public class JextEvent
{
  /** Event type indicating a change of the options */
  public static final int PROPERTIES_CHANGED = 0;
  /** Event type indicating a change of the colorizing syntax mode */
  public static final int SYNTAX_MODE_CHANGED = 1;

  // text area specific
  /** Event type indicating a change in a text area */
  public static final int CHANGED_UPDATE = 2;
  /** Event type indicating an insertion in a text area */
  public static final int INSERT_UPDATE = 3;
  /** Event type indicating a removing in a text area */
  public static final int REMOVE_UPDATE = 4;

  /** Event type indicating a file was opened */
  public static final int FILE_OPENED = 10;
  /** Event type indicating a file was cleared (new) */
  public static final int FILE_CLEARED = 11;

  /** Event type indicating batch mode is on */
  public static final int BATCH_MODE_SET = 20;
  /** Event type indicating batch mode is off */
  public static final int BATCH_MODE_UNSET = 21;

  /** Event type indicating current selected text area has gained focus. UNUSED */
  public static final int TEXT_AREA_FOCUS_GAINED = 76;
  /** Event type indicating current selected text area has changed */
  public static final int TEXT_AREA_SELECTED = 77;
  /** Event type indicating a new text area is available */
  public static final int TEXT_AREA_OPENED = 78;
  /** Event type indicating a text area was closed */
  public static final int TEXT_AREA_CLOSED = 79;

  /** Event type indicating a new window was opened */
  public static final int OPENING_WINDOW = 98;
  /** Event type indicating a window was closed */
  public static final int CLOSING_WINDOW = 99;
  /**
   * Event type indicating the last Jext window is being killed, and maybe Jext itself. In the background
   * mode, in fact, when the last window of Jext is closed, you'll get this event and you should, i.e.,
   * save properties; but when a new window is created, the start method won't be called, so it won't
   * be able to reinitialize freed resources.
   * If Jext instead is completely closed, Plugin.stop() is called. But it is not assured that the stop method will
   * be called, for instance if the user shutdowns the PC while Jext is still in the bg(and the user won't close Jext
   * when it's in the BG). So don't rely on stop().
   */
  public static final int KILLING_JEXT = 101;

  // private
  private int event;
  private JextFrame parent;
  private JextTextArea textArea;

  /**
   * Creates a new JextEvent, registering the parent of
   * this event, the type of the event and also the
   * text area which was selected when event was created.
   * @param parent Jext parent
   * @param eventType A int value which determine the nature of the event
   */

  public JextEvent(JextFrame parent, int eventType)
  {
    this.parent = parent;
    this.textArea = parent.getTextArea();
    this.event = eventType;
  }

  /**
   * Creates a new JextEvent, registering the parent of
   * this event, the type of the event and also the
   * text area which was selected when event was created.
   * @param parent Jext parent
   * @param The event related text area
   * @param eventType A int value which determine the nature of the event
   */

  public JextEvent(JextFrame parent, JextTextArea textArea, int eventType)
  {
    this.parent = parent;
    this.textArea = textArea;
    this.event = eventType;
  }

  /**
   * Returns the type of event.
   * @return A int indicating the type of the fired event
   */

  public int getWhat()
  {
    return event;
  }

  /**
   * Returns the Jext parent from which the
   * event has been fired.
   * @return A Jext instance, indicating which window has fired the event
   */

  public JextFrame getJextFrame()
  {
    return parent;
  }

  /**
   * Returns the text area which was visible when the event has been
   * fired as the selected text area may have changed when event is received
   * due to the action of another listener.
   * @return A JextTextArea designating the selected text area when event
   * has been fired
   */

  public JextTextArea getTextArea()
  {
    return textArea;
  }
}

// End of JextEvent.java