java.awt.event

Class ContainerEvent

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

UNKNOWN: updated to 1.4

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.

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.

Field Detail

COMPONENT_ADDED

public static final int COMPONENT_ADDED

This id indicates a component was added to the container.

COMPONENT_REMOVED

public static final int COMPONENT_REMOVED

This id indicates a component was removed from the container.

CONTAINER_FIRST

public static final int CONTAINER_FIRST

This is the first id in the id range used by this class.

CONTAINER_LAST

public static final int CONTAINER_LAST

This is the last id in the id range used by this class.

Constructor Detail

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 Detail

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()

Returns: a string identifying this event