< prev index next >

src/java.desktop/share/classes/java/awt/event/HierarchyEvent.java

Print this page

        

@@ -28,12 +28,12 @@
 import java.awt.AWTEvent;
 import java.awt.Component;
 import java.awt.Container;
 
 /**
- * An event which indicates a change to the <code>Component</code>
- * hierarchy to which <code>Component</code> belongs.
+ * An event which indicates a change to the {@code Component}
+ * hierarchy to which {@code Component} belongs.
  * <ul>
  * <li>Hierarchy Change Events (HierarchyListener)
  *     <ul>
  *     <li> addition of an ancestor
  *     <li> removal of an ancestor

@@ -55,22 +55,22 @@
  * program is receiving these events or not.
  * <p>
  * This event is generated by a Container object (such as a Panel) when the
  * Container is added, removed, moved, or resized, and passed down the
  * hierarchy. It is also generated by a Component object when that object's
- * <code>addNotify</code>, <code>removeNotify</code>, <code>show</code>, or
- * <code>hide</code> method is called. The {@code ANCESTOR_MOVED} and
+ * {@code addNotify}, {@code removeNotify}, {@code show}, or
+ * {@code hide} method is called. The {@code ANCESTOR_MOVED} and
  * {@code ANCESTOR_RESIZED}
- * events are dispatched to every <code>HierarchyBoundsListener</code> or
- * <code>HierarchyBoundsAdapter</code> object which registered to receive
- * such events using the Component's <code>addHierarchyBoundsListener</code>
- * method. (<code>HierarchyBoundsAdapter</code> objects implement the <code>
- * HierarchyBoundsListener</code> interface.) The {@code HIERARCHY_CHANGED} events are
- * dispatched to every <code>HierarchyListener</code> object which registered
- * to receive such events using the Component's <code>addHierarchyListener
- * </code> method. Each such listener object gets this <code>HierarchyEvent
- * </code> when the event occurs.
+ * events are dispatched to every {@code HierarchyBoundsListener} or
+ * {@code HierarchyBoundsAdapter} object which registered to receive
+ * such events using the Component's {@code addHierarchyBoundsListener}
+ * method. ({@code HierarchyBoundsAdapter} objects implement the
+ * {@code HierarchyBoundsListener} interface.) The {@code HIERARCHY_CHANGED} events are
+ * dispatched to every {@code HierarchyListener} object which registered
+ * to receive such events using the Component's {@code addHierarchyListener}
+ * method. Each such listener object gets this {@code HierarchyEvent}
+ * when the event occurs.
  * <p>
  * An unspecified behavior will be caused if the {@code id} parameter
  * of any particular {@code HierarchyEvent} instance is not
  * in the range from {@code HIERARCHY_FIRST} to {@code HIERARCHY_LAST}.
  * <br>

@@ -120,41 +120,41 @@
      * Marks the last integer id for the range of ancestor event ids.
      */
     public static final int HIERARCHY_LAST = ANCESTOR_RESIZED;
 
     /**
-     * A change flag indicates that the <code>HIERARCHY_CHANGED</code> event
+     * A change flag indicates that the {@code HIERARCHY_CHANGED} event
      * was generated by a reparenting operation.
      */
     public static final int PARENT_CHANGED = 0x1;
 
     /**
-     * A change flag indicates that the <code>HIERARCHY_CHANGED</code> event
+     * A change flag indicates that the {@code HIERARCHY_CHANGED} event
      * was generated due to the changing of the hierarchy displayability.
      * To discern the
      * current displayability of the hierarchy, call the
-     * <code>Component.isDisplayable</code> method. Displayability changes occur
+     * {@code Component.isDisplayable} method. Displayability changes occur
      * in response to explicit or implicit calls of the
-     * <code>Component.addNotify</code> and
-     * <code>Component.removeNotify</code> methods.
+     * {@code Component.addNotify} and
+     * {@code Component.removeNotify} methods.
      *
      * @see java.awt.Component#isDisplayable()
      * @see java.awt.Component#addNotify()
      * @see java.awt.Component#removeNotify()
      */
     public static final int DISPLAYABILITY_CHANGED = 0x2;
 
     /**
-     * A change flag indicates that the <code>HIERARCHY_CHANGED</code> event
+     * A change flag indicates that the {@code HIERARCHY_CHANGED} event
      * was generated due to the changing of the hierarchy showing state.
      * To discern the
      * current showing state of the hierarchy, call the
-     * <code>Component.isShowing</code> method. Showing state changes occur
+     * {@code Component.isShowing} method. Showing state changes occur
      * when either the displayability or visibility of the
      * hierarchy occurs. Visibility changes occur in response to explicit
-     * or implicit calls of the <code>Component.show</code> and
-     * <code>Component.hide</code> methods.
+     * or implicit calls of the {@code Component.show} and
+     * {@code Component.hide} methods.
      *
      * @see java.awt.Component#isShowing()
      * @see java.awt.Component#addNotify()
      * @see java.awt.Component#removeNotify()
      * @see java.awt.Component#show()

@@ -165,28 +165,28 @@
     Component changed;
     Container changedParent;
     long      changeFlags;
 
     /**
-     * Constructs an <code>HierarchyEvent</code> object to identify a
-     * change in the <code>Component</code> hierarchy.
+     * Constructs an {@code HierarchyEvent} object to identify a
+     * change in the {@code Component} hierarchy.
      * <p>This method throws an
-     * <code>IllegalArgumentException</code> if <code>source</code>
-     * is <code>null</code>.
+     * {@code IllegalArgumentException} if {@code source}
+     * is {@code null}.
      *
-     * @param source          The <code>Component</code> object that
+     * @param source          The {@code Component} object that
      *                        originated the event
      * @param id              An integer indicating the type of event.
      *                        For information on allowable values, see
      *                        the class description for {@link HierarchyEvent}
-     * @param changed         The <code>Component</code> at the top of
+     * @param changed         The {@code Component} at the top of
      *                        the hierarchy which was changed
-     * @param changedParent   The parent of the <code>changed</code> component.
+     * @param changedParent   The parent of the {@code changed} component.
      *                        This
      *                        may be the parent before or after the
      *                        change, depending on the type of change
-     * @throws IllegalArgumentException if <code>source</code> is {@code null}
+     * @throws IllegalArgumentException if {@code source} is {@code null}
      * @see #getSource()
      * @see #getID()
      * @see #getChanged()
      * @see #getChangedParent()
      */

@@ -196,33 +196,33 @@
         this.changed = changed;
         this.changedParent = changedParent;
     }
 
     /**
-     * Constructs an <code>HierarchyEvent</code> object to identify
-     * a change in the <code>Component</code> hierarchy.
+     * Constructs an {@code HierarchyEvent} object to identify
+     * a change in the {@code Component} hierarchy.
      * <p> This method throws an
-     * <code>IllegalArgumentException</code> if <code>source</code>
-     * is <code>null</code>.
+     * {@code IllegalArgumentException} if {@code source}
+     * is {@code null}.
      *
-     * @param source          The <code>Component</code> object that
+     * @param source          The {@code Component} object that
      *                        originated the event
      * @param id              An integer indicating the type of event.
      *                        For information on allowable values, see
      *                        the class description for {@link HierarchyEvent}
-     * @param changed         The <code>Component</code> at the top
+     * @param changed         The {@code Component} at the top
      *                        of the hierarchy which was changed
-     * @param changedParent   The parent of the <code>changed</code> component.
+     * @param changedParent   The parent of the {@code changed} component.
      *                        This
      *                        may be the parent before or after the
      *                        change, depending on the type of change
      * @param changeFlags     A bitmask which indicates the type(s) of
-     *                        the <code>HIERARCHY_CHANGED</code> events
+     *                        the {@code HIERARCHY_CHANGED} events
      *                        represented in this event object.
      *                        For information on allowable values, see
      *                        the class description for {@link HierarchyEvent}
-     * @throws IllegalArgumentException if <code>source</code> is null
+     * @throws IllegalArgumentException if {@code source} is null
      * @see #getSource()
      * @see #getID()
      * @see #getChanged()
      * @see #getChangedParent()
      * @see #getChangeFlags()

@@ -236,13 +236,13 @@
     }
 
     /**
      * Returns the originator of the event.
      *
-     * @return the <code>Component</code> object that originated
-     * the event, or <code>null</code> if the object is not a
-     * <code>Component</code>.
+     * @return the {@code Component} object that originated
+     * the event, or {@code null} if the object is not a
+     * {@code Component}.
      */
     public Component getComponent() {
         return (source instanceof Component) ? (Component)source : null;
     }
 

@@ -255,17 +255,17 @@
     public Component getChanged() {
         return changed;
     }
 
     /**
-     * Returns the parent of the Component returned by <code>
-     * getChanged()</code>. For a HIERARCHY_CHANGED event where the
-     * change was of type PARENT_CHANGED via a call to <code>
-     * Container.add</code>, the parent returned is the parent
+     * Returns the parent of the Component returned by
+     * {@code getChanged()}. For a HIERARCHY_CHANGED event where the
+     * change was of type PARENT_CHANGED via a call to
+     * {@code Container.add}, the parent returned is the parent
      * after the add operation. For a HIERARCHY_CHANGED event where
-     * the change was of type PARENT_CHANGED via a call to <code>
-     * Container.remove</code>, the parent returned is the parent
+     * the change was of type PARENT_CHANGED via a call to
+     * {@code Container.remove}, the parent returned is the parent
      * before the remove operation. For all other events and types,
      * the parent returned is the parent during the operation.
      *
      * @return the parent of the changed Component
      */
< prev index next >