evobject.java

Zaval Light-Weight Visual Components Library (LwVCL) is a pure Java alternative to humble AWT-based

/**
 *     Caption: Zaval Light-Weight Visual Components Library
 *     $Revision: 2.79 $
 *     $Date: 2003/08/22 11:24:16 $
 *
 *     @author:     Andrei Vishnevsky
 *     @version:    3.50
 *
 * Zaval Light-Weight Visual Components Library (LwVCL) is a pure Java
 * alternative to humble AWT-based and SWING-based GUI interfaces for
 * wide ranges of platforms, including J2SE, PersonalJava and J2ME.
 *
 * Designed as light-weight but, alternatively to Swing, built separately
 * from AWT (not on top of the java.awt library like Swing), the LwVCL is
 * the good alternative to highly performant, memory-efficient, flexible
 * GUI solution for embedded, stand-alone and applet applications.
 *
 * For more info on this product read Zaval Light-Weight Visual Components Library Tutorial
 * (It comes within this package).
 * The latest product version is always available from the product's homepage:
 * http://www.zaval.org/products/lwvcl/
 * and from the SourceForge:
 * http://sourceforge.net/projects/zaval0003/
 *
 * Contacts:
 *   Support : [e-mail]
 *   Change Requests : [e-mail]
 *   Feedback : [e-mail]
 *   Other : [e-mail]
 *
 * Copyright (C) 2001-2003  Zaval Creative Engineering Group (http://www.zaval.org)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * (version 2) as published by the Free Software Foundation.
 *
 * 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.zaval.util.event;

/**
 * This abstract class represents an event that has unique integer identifier.
 * You can inherit the class to create own event classes that may be identified by an
 * integer id.
 */
public abstract class EvObject
extends java.util.EventObject
{
  private int id;

 /**
  * Constructs the event object with the specified source object and the event id.
  * @param <code>src</code> the object where the event originated.
  * @param <code>id</code> the specified event id.
  */
  public EvObject(Object src, int id)
  {
    super(src);
    if (!checkID(id)) throw new IllegalArgumentException();
    this.id = id;
  }

 /**
  * Gets the event id.
  * @return an event id.
  */
  public int getID () {
    return id;
  }

 /**
  * The method returns <code>true</code> if the specified id is valid for the event,
  * otherwise returns <code>false</code>. The method is called with the event constructor
  * to test if the event id is valid and if the event is not valid the IllegalArgumentException
  * will be thrown.
  * @param <code>id</code> the specified id.
  */
  protected abstract boolean checkID(int id);
}