AncestorEvent.java   [plain text]

/* AncestorEvent.java --
   Copyright (C) 2002 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath 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, or (at your option)
any later version.

GNU Classpath 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 GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing.event;

// Imports
import javax.swing.*;
import java.awt.*;

/**
 * Ancestor Event
 * @author Andrew Selkirk
 * @author Ronald Veldema
 */
public class AncestorEvent extends AWTEvent {

	//-------------------------------------------------------------
	// Constants --------------------------------------------------
	//-------------------------------------------------------------

	/**
	 * ANCESTOR_ADDED constant
	 */
	public static int ANCESTOR_ADDED	= 0;
	
	/**
	 * ANCESTOR_MOVED constant
	 */
	public static int ANCESTOR_MOVED	= 1;

	/**
	 * ANCESTOR_REMOVED constant
	 */
	public static int ANCESTOR_REMOVED	= 2;


	//-------------------------------------------------------------
	// Variables --------------------------------------------------
	//-------------------------------------------------------------

	/**
	 * Source component
	 */
	private JComponent	sourceComponent	= null;

	/**
	 * Ancestor
	 */
	private Container	ancestor		= null;
	
	/**
	 * Ancestor Parent
	 */
	private Container	ancestorParent	= null;


	//-------------------------------------------------------------
	// Initialization ---------------------------------------------
	//-------------------------------------------------------------

	/**
	 * Constructor AncestorEvent
	 * @param source Source component
	 * @param id ID
	 * @param ancestor ancestor
	 * @param ancestorParent parent ancestor
	 */
	public AncestorEvent(JComponent source, int id, Container ancestor, 
						Container ancestorParent) {
		super(source, id);
		this.sourceComponent = source;
		this.ancestor 		= ancestor;
		this.ancestorParent	= ancestorParent;
	} // AncestorEvent()


	//-------------------------------------------------------------
	// Methods ----------------------------------------------------
	//-------------------------------------------------------------

	/**
	 * Get ancestor
	 * @return ancestor
	 */
	public Container getAncestor() {
		return ancestor;
	} // getAncestor()

	/**
	 * Get ancestor parent
	 * @return ancestor parent
	 */
	public Container getAncestorParent() {
		return ancestorParent;
	} // getAncestorParent()

	/**
	 * Get component
	 * @return component
	 */
	public JComponent getComponent() {
		return sourceComponent;
	} // getComponent()


} // AncestorEvent