java.awt.event

Class ContainerEvent

Implemented Interfaces:
Serializable

public class ContainerEvent
extends ComponentEvent

This event is generated when a component is added or removed from a container. Applications do not ordinarily need to handle these events since the AWT system handles them internally.
Since:
1.1
See Also:
ContainerAdapter, ContainerListener, Serialized Form

Field Summary

static int
COMPONENT_ADDED
This id indicates a component was added to the container.
static int
COMPONENT_REMOVED
This id indicates a component was removed from the container.
static int
CONTAINER_FIRST
This is the first id in the id range used by this class.
static int
CONTAINER_LAST
This is the last id in the id range used by this class.

Fields inherited from class java.awt.event.ComponentEvent

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK, consumed, id

Fields inherited from class java.util.EventObject

source

Constructor Summary

ContainerEvent(Component source, int id, Component child)
Initializes a new instance of ContainerEvent with the specified source and id.

Method Summary

Component
getChild()
This method returns the child object that was added or removed from the container.
Container
getContainer()
Returns the source of this event as a Container.
String
paramString()
This method returns a string identifying this event.

Methods inherited from class java.awt.event.ComponentEvent

getComponent, paramString

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPONENT_ADDED

public static final int COMPONENT_ADDED
This id indicates a component was added to the container.
Field Value:
300

COMPONENT_REMOVED

public static final int COMPONENT_REMOVED
This id indicates a component was removed from the container.
Field Value:
301

CONTAINER_FIRST

public static final int CONTAINER_FIRST
This is the first id in the id range used by this class.
Field Value:
300

CONTAINER_LAST

public static final int CONTAINER_LAST
This is the last id in the id range used by this class.
Field Value:
301

Constructor Details

ContainerEvent

public ContainerEvent(Component source,
                      int id,
                      Component child)
Initializes a new instance of ContainerEvent with the specified source and id. Additionally, the affected child component is also passed as a parameter. Note that an invalid id leads to unspecified results.
Parameters:
source - the source container of the event
id - the event id
child - the child component affected by this event
Throws:
IllegalArgumentException - if source is null

Method Details

getChild

public Component getChild()
This method returns the child object that was added or removed from the container.
Returns:
the child object added or removed

getContainer

public Container getContainer()
Returns the source of this event as a Container.
Returns:
the source of the event
Throws:
ClassCastException - if the source is changed to a non-Container

paramString

public String paramString()
This method returns a string identifying this event. It is formatted as: (getID() == COMPONENT_ADDED ? "COMPONENT_ADDED" : "COMPONENT_REMOVED") + ",child=" + getChild().getName().
Overrides:
paramString in interface ComponentEvent
Returns:
a string identifying this event

ContainerEvent.java -- components added/removed from a container Copyright (C) 1999, 2002, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.