APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt.event

public Class ContainerEvent

extends ComponentEvent
Class Inheritance
Imports
java.awt.Component, .Container, java.io.Serial
A low-level event which indicates that a container's contents changed because a component was added or removed.

Container events are provided for notification purposes ONLY; The AWT will automatically handle changes to the containers contents internally so that the program works properly regardless of whether the program is receiving these events or not.

This low-level event is generated by a container object (such as a Panel) when a component is added to it or removed from it. The event is passed to every ContainerListener or ContainerAdapter object which registered to receive such events using the component's addContainerListener method. (ContainerAdapter objects implement the ContainerListener interface.) Each such listener object gets this ContainerEvent when the event occurs.

An unspecified behavior will be caused if the id parameter of any particular ContainerEvent instance is not in the range from CONTAINER_FIRST to CONTAINER_LAST.

Authors
Tim Prinzing, Amy Fowler
Since
1.1
See Also
ContainerAdapter, ContainerListener, Tutorial: Writing a Container Listener

Field Summary

Modifier and TypeField and Description
pack-priv Component
child

The non-null component that is being added or removed from the Container.

public static final int
COMPONENT_ADDED

This event indicates that a component was added to the container.

public static final int
COMPONENT_REMOVED

This event indicates that a component was removed from the container.

public static final int
CONTAINER_FIRST

The first number in the range of ids used for container events.

public static final int
CONTAINER_LAST

The last number in the range of ids used for container events.

private static final long
serialVersionUID

Hides java.awt.event.ComponentEvent.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.
Inherited from java.awt.event.ComponentEvent:
COMPONENT_FIRSTCOMPONENT_HIDDENCOMPONENT_LASTCOMPONENT_MOVEDCOMPONENT_RESIZEDCOMPONENT_SHOWN

Constructor Summary

AccessConstructor and Description
public
ContainerEvent(Component
The Component object (container) that originated the event
source, int
An integer indicating the type of event. For information on allowable values, see the class description for ContainerEvent
id, Component
the component that was added or removed
child)

Constructs a ContainerEvent object.

Method Summary

Modifier and TypeMethod and Description
public Component

Returns:

the Component object that was added or removed
getChild()

Returns the component that was affected by the event.

public Container

Returns:

the Container object that originated the event, or null if the object is not a Container.
getContainer()

Returns the originator of the event.

public String

Returns:

a string identifying the event and its attributes
paramString()

Overrides java.awt.event.ComponentEvent.paramString.

Returns a parameter string identifying this event.

Inherited from java.awt.event.ComponentEvent:
getComponent

Field Detail

childback to summary
pack-priv Component child

The non-null component that is being added or removed from the Container.

See Also
getChild()
COMPONENT_ADDEDback to summary
public static final int COMPONENT_ADDED

This event indicates that a component was added to the container.

COMPONENT_REMOVEDback to summary
public static final int COMPONENT_REMOVED

This event indicates that a component was removed from the container.

CONTAINER_FIRSTback to summary
public static final int CONTAINER_FIRST

The first number in the range of ids used for container events.

CONTAINER_LASTback to summary
public static final int CONTAINER_LAST

The last number in the range of ids used for container events.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.awt.event.ComponentEvent.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.

Annotations
@Serial

Constructor Detail

ContainerEventback to summary
public ContainerEvent(Component source, int id, Component child)

Constructs a ContainerEvent object.

This method throws an IllegalArgumentException if source is null.

Parameters
source:Component

The Component object (container) that originated the event

id:int

An integer indicating the type of event. For information on allowable values, see the class description for ContainerEvent

child:Component

the component that was added or removed

Exceptions
IllegalArgumentException:
if source is null
See Also
getContainer(), getID(), getChild()

Method Detail

getChildback to summary
public Component getChild()

Returns the component that was affected by the event.

Returns:Component

the Component object that was added or removed

getContainerback to summary
public Container getContainer()

Returns the originator of the event.

Returns:Container

the Container object that originated the event, or null if the object is not a Container.

paramStringback to summary
public String paramString()

Overrides java.awt.event.ComponentEvent.paramString.

Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Returns:String

a string identifying the event and its attributes