/*
 * @(#)AlertEvent.java    1.0  16 February 2001
 *
 * Copyright 2004
 * College of Computer and Information Science
 * Northeastern University
 * Boston, MA  02115
 *
 * The Java Power Tools software may be used for educational
 * purposes as long as this copyright notice is retained intact
 * at the top of all source files.
 *
 * To discuss possible commercial use of this software, 
 * contact Richard Rasala at Northeastern University, 
 * College of Computer and Information Science,
 * 617-373-2462 or rasala@ccs.neu.edu.
 *
 * The Java Power Tools software has been designed and built
 * in collaboration with Viera Proulx and Jeff Raab.
 *
 * Should this software be modified, the words "Modified from 
 * Original" must be included as a comment below this notice.
 *
 * All publication rights are retained.  This software or its 
 * documentation may not be published in any media either
 * in whole or in part without explicit permission.
 *
 * This software was created with support from Northeastern 
 * University and from NSF grant DUE-9950829.
 */

package edu.neu.ccs.gui;

import java.awt.AWTEvent;

/**
 * <P>Class of <CODE>{@link AWTEvent AWTEvent}</CODE>s 
 * encapsulating the designation that a graphical input object 
 * should enter or exit alert status.</P>
 *
 * @author  Jeff Raab
 * @version 2.2
 * @since   1.0
 */
public class AlertEvent extends AWTEvent {
    
    /** Value designating that alert status should be entered. */
    public static final int ALERT_ON = 0;
    
    /** Value designating that alert status should be exited. */
    public static final int ALERT_OFF = 1;
    
    //////////////////
    // Constructors //
    //////////////////
    
    /**
     * Constructs an alert event 
     * generated by the given source object 
     * with the given alert status specifier.
     *
     * @param source the object generating the event
     * @param status the alert status specifier
     */
    public AlertEvent(Object source, int status) {
        super(source, status);
    }

    ////////////////
    // Public API //
    ////////////////

    /**
     * Returns whether or not this event designates
     * that alert status should be entered.
     */
    public boolean isAlertOn() {
        return (getID() == ALERT_ON);
    }
}