This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.swing.event
class AncestorEvent
- All Implemented Interfaces:
- Serializable
public class AncestorEvent
extends AWTEvent
An event reported to a child component that originated from an
ancestor in the component hierarchy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans
package.
Please see {@link java.beans.XMLEncoder}.
Field Summary |
static int |
ANCESTOR_ADDED
An ancestor-component was added to the hierarchy of
visible objects (made visible), and is currently being displayed. |
static int |
ANCESTOR_MOVED
An ancestor-component changed its position on the screen. |
static int |
ANCESTOR_REMOVED
An ancestor-component was removed from the hierarchy
of visible objects (hidden) and is no longer being displayed. |
Fields inherited from class java.awt.AWTEvent |
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, 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 |
Constructor Summary |
Constructs an AncestorEvent object to identify a change
in an ancestor-component's display-status.
|
Method Summary |
Container |
Returns the ancestor that the event actually occurred on.
|
Container |
Returns the parent of the ancestor the event actually occurred on.
|
JComponent |
Returns the component that the listener was added to.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ANCESTOR_ADDED
public static final int ANCESTOR_ADDED
-
An ancestor-component was added to the hierarchy of
visible objects (made visible), and is currently being displayed.
ANCESTOR_MOVED
public static final int ANCESTOR_MOVED
-
An ancestor-component changed its position on the screen.
ANCESTOR_REMOVED
public static final int ANCESTOR_REMOVED
-
An ancestor-component was removed from the hierarchy
of visible objects (hidden) and is no longer being displayed.
AncestorEvent
public AncestorEvent(JComponent source,
int id,
Container ancestor,
Container ancestorParent)
-
Constructs an AncestorEvent object to identify a change
in an ancestor-component's display-status.
- Parameters:
source
- the JComponent that originated the event
(typically this
)
id
- an int specifying {@link #ANCESTOR_ADDED},
{@link #ANCESTOR_REMOVED} or {@link #ANCESTOR_MOVED}
ancestor
- a Container object specifying the ancestor-component
whose display-status changed
ancestorParent
- a Container object specifying the ancestor's parent
getAncestor
public Container getAncestor()
-
Returns the ancestor that the event actually occurred on.
getAncestorParent
public Container getAncestorParent()
-
Returns the parent of the ancestor the event actually occurred on.
This is most interesting in an ANCESTOR_REMOVED event, as
the ancestor may no longer be in the component hierarchy.
getComponent
public JComponent getComponent()
-
Returns the component that the listener was added to.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.