java.awt.event
Class ContainerEvent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject 
      extended by java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent 
          extended by java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent 
              extended by java.awt.event.ContainerEvent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class ContainerEvent
extends ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent

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.

Since:
1.1
See Also:
ContainerAdapter sample code for java.awt.event.ContainerAdapter definition code for java.awt.event.ContainerAdapter , ContainerListener sample code for java.awt.event.ContainerListener definition code for java.awt.event.ContainerListener , Tutorial: Writing a Container Listener, Reference: The Java Class Libraries (update file), Serialized Form

Field Summary
static int COMPONENT_ADDED sample code for java.awt.event.ContainerEvent.COMPONENT_ADDED definition code for java.awt.event.ContainerEvent.COMPONENT_ADDED
          This event indicates that a component was added to the container.
static int COMPONENT_REMOVED sample code for java.awt.event.ContainerEvent.COMPONENT_REMOVED definition code for java.awt.event.ContainerEvent.COMPONENT_REMOVED
          This event indicates that a component was removed from the container.
static int CONTAINER_FIRST sample code for java.awt.event.ContainerEvent.CONTAINER_FIRST definition code for java.awt.event.ContainerEvent.CONTAINER_FIRST
          The first number in the range of ids used for container events.
static int CONTAINER_LAST sample code for java.awt.event.ContainerEvent.CONTAINER_LAST definition code for java.awt.event.ContainerEvent.CONTAINER_LAST
          The last number in the range of ids used for container events.
 
Fields inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
COMPONENT_FIRST sample code for java.awt.event.ComponentEvent.COMPONENT_FIRST definition code for java.awt.event.ComponentEvent.COMPONENT_FIRST , COMPONENT_HIDDEN sample code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN definition code for java.awt.event.ComponentEvent.COMPONENT_HIDDEN , COMPONENT_LAST sample code for java.awt.event.ComponentEvent.COMPONENT_LAST definition code for java.awt.event.ComponentEvent.COMPONENT_LAST , COMPONENT_MOVED sample code for java.awt.event.ComponentEvent.COMPONENT_MOVED definition code for java.awt.event.ComponentEvent.COMPONENT_MOVED , COMPONENT_RESIZED sample code for java.awt.event.ComponentEvent.COMPONENT_RESIZED definition code for java.awt.event.ComponentEvent.COMPONENT_RESIZED , COMPONENT_SHOWN sample code for java.awt.event.ComponentEvent.COMPONENT_SHOWN definition code for java.awt.event.ComponentEvent.COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
ACTION_EVENT_MASK sample code for java.awt.AWTEvent.ACTION_EVENT_MASK definition code for java.awt.AWTEvent.ACTION_EVENT_MASK , ADJUSTMENT_EVENT_MASK sample code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK definition code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK , COMPONENT_EVENT_MASK sample code for java.awt.AWTEvent.COMPONENT_EVENT_MASK definition code for java.awt.AWTEvent.COMPONENT_EVENT_MASK , consumed sample code for java.awt.AWTEvent.consumed definition code for java.awt.AWTEvent.consumed , CONTAINER_EVENT_MASK sample code for java.awt.AWTEvent.CONTAINER_EVENT_MASK definition code for java.awt.AWTEvent.CONTAINER_EVENT_MASK , FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.FOCUS_EVENT_MASK , HIERARCHY_BOUNDS_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK , HIERARCHY_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK , id sample code for java.awt.AWTEvent.id definition code for java.awt.AWTEvent.id , INPUT_METHOD_EVENT_MASK sample code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK definition code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK , INVOCATION_EVENT_MASK sample code for java.awt.AWTEvent.INVOCATION_EVENT_MASK definition code for java.awt.AWTEvent.INVOCATION_EVENT_MASK , ITEM_EVENT_MASK sample code for java.awt.AWTEvent.ITEM_EVENT_MASK definition code for java.awt.AWTEvent.ITEM_EVENT_MASK , KEY_EVENT_MASK sample code for java.awt.AWTEvent.KEY_EVENT_MASK definition code for java.awt.AWTEvent.KEY_EVENT_MASK , MOUSE_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_EVENT_MASK , MOUSE_MOTION_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK , MOUSE_WHEEL_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK , PAINT_EVENT_MASK sample code for java.awt.AWTEvent.PAINT_EVENT_MASK definition code for java.awt.AWTEvent.PAINT_EVENT_MASK , RESERVED_ID_MAX sample code for java.awt.AWTEvent.RESERVED_ID_MAX definition code for java.awt.AWTEvent.RESERVED_ID_MAX , TEXT_EVENT_MASK sample code for java.awt.AWTEvent.TEXT_EVENT_MASK definition code for java.awt.AWTEvent.TEXT_EVENT_MASK , WINDOW_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_EVENT_MASK , WINDOW_FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK , WINDOW_STATE_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
source sample code for java.util.EventObject.source definition code for java.util.EventObject.source
 
Constructor Summary
ContainerEvent sample code for java.awt.event.ContainerEvent.ContainerEvent(java.awt.Component, int, java.awt.Component) definition code for java.awt.event.ContainerEvent.ContainerEvent(java.awt.Component, int, java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  source, int id, Component sample code for java.awt.Component definition code for java.awt.Component  child)
          Constructs a ContainerEvent object.
 
Method Summary
 Component sample code for java.awt.Component definition code for java.awt.Component getChild sample code for java.awt.event.ContainerEvent.getChild() definition code for java.awt.event.ContainerEvent.getChild() ()
          Returns the component that was affected by the event.
 Container sample code for java.awt.Container definition code for java.awt.Container getContainer sample code for java.awt.event.ContainerEvent.getContainer() definition code for java.awt.event.ContainerEvent.getContainer() ()
          Returns the originator of the event.
 String sample code for java.lang.String definition code for java.lang.String paramString sample code for java.awt.event.ContainerEvent.paramString() definition code for java.awt.event.ContainerEvent.paramString() ()
          Returns a parameter string identifying this event.
 
Methods inherited from class java.awt.event.ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
getComponent sample code for java.awt.event.ComponentEvent.getComponent() definition code for java.awt.event.ComponentEvent.getComponent()
 
Methods inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
consume sample code for java.awt.AWTEvent.consume() definition code for java.awt.AWTEvent.consume() , getID sample code for java.awt.AWTEvent.getID() definition code for java.awt.AWTEvent.getID() , isConsumed sample code for java.awt.AWTEvent.isConsumed() definition code for java.awt.AWTEvent.isConsumed() , setSource sample code for java.awt.AWTEvent.setSource(java.lang.Object) definition code for java.awt.AWTEvent.setSource(java.lang.Object) , toString sample code for java.awt.AWTEvent.toString() definition code for java.awt.AWTEvent.toString()
 
Methods inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
getSource sample code for java.util.EventObject.getSource() definition code for java.util.EventObject.getSource()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

CONTAINER_FIRST sample code for java.awt.event.ContainerEvent.CONTAINER_FIRST

public static final int CONTAINER_FIRST
The first number in the range of ids used for container events.

See Also:
Constant Field Values

CONTAINER_LAST sample code for java.awt.event.ContainerEvent.CONTAINER_LAST

public static final int CONTAINER_LAST
The last number in the range of ids used for container events.

See Also:
Constant Field Values

COMPONENT_ADDED sample code for java.awt.event.ContainerEvent.COMPONENT_ADDED

public static final int COMPONENT_ADDED
This event indicates that a component was added to the container.

See Also:
Constant Field Values

COMPONENT_REMOVED sample code for java.awt.event.ContainerEvent.COMPONENT_REMOVED

public static final int COMPONENT_REMOVED
This event indicates that a component was removed from the container.

See Also:
Constant Field Values
Constructor Detail

ContainerEvent sample code for java.awt.event.ContainerEvent(java.awt.Component, int, java.awt.Component) definition code for java.awt.event.ContainerEvent(java.awt.Component, int, java.awt.Component)

public ContainerEvent(Component sample code for java.awt.Component definition code for java.awt.Component  source,
                      int id,
                      Component sample code for java.awt.Component definition code for java.awt.Component  child)
Constructs a ContainerEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

Parameters:
source - the Component object (container) that originated the event
id - an integer indicating the type of event
child - the component that was added or removed
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null
Method Detail

getContainer sample code for java.awt.event.ContainerEvent.getContainer() definition code for java.awt.event.ContainerEvent.getContainer()

public Container sample code for java.awt.Container definition code for java.awt.Container  getContainer()
Returns the originator of the event.

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

getChild sample code for java.awt.event.ContainerEvent.getChild() definition code for java.awt.event.ContainerEvent.getChild()

public Component sample code for java.awt.Component definition code for java.awt.Component  getChild()
Returns the component that was affected by the event.

Returns:
the Component object that was added or removed

paramString sample code for java.awt.event.ContainerEvent.paramString() definition code for java.awt.event.ContainerEvent.paramString()

public String sample code for java.lang.String definition code for java.lang.String  paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Overrides:
paramString sample code for java.awt.event.ComponentEvent.paramString() definition code for java.awt.event.ComponentEvent.paramString() in class ComponentEvent sample code for java.awt.event.ComponentEvent definition code for java.awt.event.ComponentEvent
Returns:
a string identifying the event and its attributes