1 /*
2 * Copyright (c) 1995, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package java.awt;
26
27 import java.io.PrintStream;
28 import java.io.PrintWriter;
29 import java.util.Objects;
30 import java.util.Vector;
31 import java.util.Locale;
32 import java.util.EventListener;
33 import java.util.HashSet;
34 import java.util.Map;
35 import java.util.Set;
36 import java.util.Collections;
37 import java.awt.peer.ComponentPeer;
38 import java.awt.peer.ContainerPeer;
39 import java.awt.peer.LightweightPeer;
40 import java.awt.image.BufferStrategy;
41 import java.awt.image.ImageObserver;
42 import java.awt.image.ImageProducer;
43 import java.awt.image.ColorModel;
44 import java.awt.image.VolatileImage;
45 import java.awt.event.*;
46 import java.io.Serializable;
47 import java.io.ObjectOutputStream;
48 import java.io.ObjectInputStream;
49 import java.io.IOException;
50 import java.beans.PropertyChangeListener;
51 import java.beans.PropertyChangeSupport;
52 import java.beans.Transient;
53 import java.awt.im.InputContext;
54 import java.awt.im.InputMethodRequests;
55 import java.awt.dnd.DropTarget;
56 import java.lang.reflect.InvocationTargetException;
57 import java.lang.reflect.Method;
58 import java.security.AccessController;
59 import java.security.PrivilegedAction;
60 import java.security.AccessControlContext;
61 import javax.accessibility.*;
62 import java.applet.Applet;
63
64 import sun.awt.ComponentFactory;
65 import sun.security.action.GetPropertyAction;
66 import sun.awt.AppContext;
67 import sun.awt.AWTAccessor;
68 import sun.awt.ConstrainableGraphics;
69 import sun.awt.SubRegionShowable;
70 import sun.awt.SunToolkit;
71 import sun.awt.CausedFocusEvent;
72 import sun.awt.EmbeddedFrame;
73 import sun.awt.dnd.SunDropTargetEvent;
74 import sun.awt.im.CompositionArea;
75 import sun.font.FontManager;
76 import sun.font.FontManagerFactory;
77 import sun.font.SunFontManager;
78 import sun.java2d.SunGraphics2D;
79 import sun.java2d.pipe.Region;
80 import sun.awt.image.VSyncedBSManager;
81 import sun.java2d.pipe.hw.ExtendedBufferCapabilities;
82 import static sun.java2d.pipe.hw.ExtendedBufferCapabilities.VSyncType.*;
83 import sun.awt.RequestFocusController;
84 import sun.java2d.SunGraphicsEnvironment;
85 import sun.util.logging.PlatformLogger;
86
87 /**
88 * A <em>component</em> is an object having a graphical representation
89 * that can be displayed on the screen and that can interact with the
90 * user. Examples of components are the buttons, checkboxes, and scrollbars
91 * of a typical graphical user interface. <p>
92 * The <code>Component</code> class is the abstract superclass of
93 * the nonmenu-related Abstract Window Toolkit components. Class
94 * <code>Component</code> can also be extended directly to create a
95 * lightweight component. A lightweight component is a component that is
96 * not associated with a native window. On the contrary, a heavyweight
97 * component is associated with a native window. The {@link #isLightweight()}
98 * method may be used to distinguish between the two kinds of the components.
99 * <p>
100 * Lightweight and heavyweight components may be mixed in a single component
101 * hierarchy. However, for correct operating of such a mixed hierarchy of
102 * components, the whole hierarchy must be valid. When the hierarchy gets
103 * invalidated, like after changing the bounds of components, or
104 * adding/removing components to/from containers, the whole hierarchy must be
105 * validated afterwards by means of the {@link Container#validate()} method
106 * invoked on the top-most invalid container of the hierarchy.
107 *
108 * <h3>Serialization</h3>
109 * It is important to note that only AWT listeners which conform
110 * to the <code>Serializable</code> protocol will be saved when
111 * the object is stored. If an AWT object has listeners that
112 * aren't marked serializable, they will be dropped at
113 * <code>writeObject</code> time. Developers will need, as always,
114 * to consider the implications of making an object serializable.
115 * One situation to watch out for is this:
116 * <pre>
117 * import java.awt.*;
118 * import java.awt.event.*;
119 * import java.io.Serializable;
120 *
121 * class MyApp implements ActionListener, Serializable
122 * {
123 * BigObjectThatShouldNotBeSerializedWithAButton bigOne;
124 * Button aButton = new Button();
125 *
126 * MyApp()
127 * {
128 * // Oops, now aButton has a listener with a reference
129 * // to bigOne!
130 * aButton.addActionListener(this);
131 * }
132 *
133 * public void actionPerformed(ActionEvent e)
134 * {
135 * System.out.println("Hello There");
136 * }
137 * }
138 * </pre>
139 * In this example, serializing <code>aButton</code> by itself
140 * will cause <code>MyApp</code> and everything it refers to
141 * to be serialized as well. The problem is that the listener
142 * is serializable by coincidence, not by design. To separate
143 * the decisions about <code>MyApp</code> and the
144 * <code>ActionListener</code> being serializable one can use a
145 * nested class, as in the following example:
146 * <pre>
147 * import java.awt.*;
148 * import java.awt.event.*;
149 * import java.io.Serializable;
150 *
151 * class MyApp implements java.io.Serializable
152 * {
153 * BigObjectThatShouldNotBeSerializedWithAButton bigOne;
154 * Button aButton = new Button();
155 *
156 * static class MyActionListener implements ActionListener
157 * {
158 * public void actionPerformed(ActionEvent e)
159 * {
160 * System.out.println("Hello There");
161 * }
162 * }
163 *
164 * MyApp()
165 * {
166 * aButton.addActionListener(new MyActionListener());
167 * }
168 * }
169 * </pre>
170 * <p>
171 * <b>Note</b>: For more information on the paint mechanisms utilized
172 * by AWT and Swing, including information on how to write the most
173 * efficient painting code, see
174 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
175 * <p>
176 * For details on the focus subsystem, see
177 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/misc/focus.html">
178 * How to Use the Focus Subsystem</a>,
179 * a section in <em>The Java Tutorial</em>, and the
180 * <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
181 * for more information.
182 *
183 * @author Arthur van Hoff
184 * @author Sami Shaio
185 */
186 public abstract class Component implements ImageObserver, MenuContainer,
187 Serializable
188 {
189
190 private static final PlatformLogger log = PlatformLogger.getLogger("java.awt.Component");
191 private static final PlatformLogger eventLog = PlatformLogger.getLogger("java.awt.event.Component");
192 private static final PlatformLogger focusLog = PlatformLogger.getLogger("java.awt.focus.Component");
193 private static final PlatformLogger mixingLog = PlatformLogger.getLogger("java.awt.mixing.Component");
194
195 /**
196 * The peer of the component. The peer implements the component's
197 * behavior. The peer is set when the <code>Component</code> is
198 * added to a container that also is a peer.
199 * @see #addNotify
200 * @see #removeNotify
201 */
202 transient volatile ComponentPeer peer;
203
204 /**
205 * The parent of the object. It may be <code>null</code>
206 * for top-level components.
207 * @see #getParent
208 */
209 transient Container parent;
210
211 /**
212 * The <code>AppContext</code> of the component. Applets/Plugin may
213 * change the AppContext.
214 */
215 transient AppContext appContext;
216
217 /**
218 * The x position of the component in the parent's coordinate system.
219 *
220 * @serial
221 * @see #getLocation
222 */
223 int x;
224
225 /**
226 * The y position of the component in the parent's coordinate system.
227 *
228 * @serial
229 * @see #getLocation
230 */
231 int y;
232
233 /**
234 * The width of the component.
235 *
236 * @serial
237 * @see #getSize
238 */
239 int width;
240
241 /**
242 * The height of the component.
243 *
244 * @serial
245 * @see #getSize
246 */
247 int height;
248
249 /**
250 * The foreground color for this component.
251 * <code>foreground</code> can be <code>null</code>.
252 *
253 * @serial
254 * @see #getForeground
255 * @see #setForeground
256 */
257 Color foreground;
258
259 /**
260 * The background color for this component.
261 * <code>background</code> can be <code>null</code>.
262 *
263 * @serial
264 * @see #getBackground
265 * @see #setBackground
266 */
267 Color background;
268
269 /**
270 * The font used by this component.
271 * The <code>font</code> can be <code>null</code>.
272 *
273 * @serial
274 * @see #getFont
275 * @see #setFont
276 */
277 volatile Font font;
278
279 /**
280 * The font which the peer is currently using.
281 * (<code>null</code> if no peer exists.)
282 */
283 Font peerFont;
284
285 /**
286 * The cursor displayed when pointer is over this component.
287 * This value can be <code>null</code>.
288 *
289 * @serial
290 * @see #getCursor
291 * @see #setCursor
292 */
293 Cursor cursor;
294
295 /**
296 * The locale for the component.
297 *
298 * @serial
299 * @see #getLocale
300 * @see #setLocale
301 */
302 Locale locale;
303
304 /**
305 * A reference to a <code>GraphicsConfiguration</code> object
306 * used to describe the characteristics of a graphics
307 * destination.
308 * This value can be <code>null</code>.
309 *
310 * @since 1.3
311 * @serial
312 * @see GraphicsConfiguration
313 * @see #getGraphicsConfiguration
314 */
315 private transient GraphicsConfiguration graphicsConfig = null;
316
317 /**
318 * A reference to a <code>BufferStrategy</code> object
319 * used to manipulate the buffers on this component.
320 *
321 * @since 1.4
322 * @see java.awt.image.BufferStrategy
323 * @see #getBufferStrategy()
324 */
325 transient BufferStrategy bufferStrategy = null;
326
327 /**
328 * True when the object should ignore all repaint events.
329 *
330 * @since 1.4
331 * @serial
332 * @see #setIgnoreRepaint
333 * @see #getIgnoreRepaint
334 */
335 boolean ignoreRepaint = false;
336
337 /**
338 * True when the object is visible. An object that is not
339 * visible is not drawn on the screen.
340 *
341 * @serial
342 * @see #isVisible
343 * @see #setVisible
344 */
345 boolean visible = true;
346
347 /**
348 * True when the object is enabled. An object that is not
349 * enabled does not interact with the user.
350 *
351 * @serial
352 * @see #isEnabled
353 * @see #setEnabled
354 */
355 boolean enabled = true;
356
357 /**
358 * True when the object is valid. An invalid object needs to
359 * be laid out. This flag is set to false when the object
360 * size is changed.
361 *
362 * @serial
363 * @see #isValid
364 * @see #validate
365 * @see #invalidate
366 */
367 private volatile boolean valid = false;
368
369 /**
370 * The <code>DropTarget</code> associated with this component.
371 *
372 * @since 1.2
373 * @serial
374 * @see #setDropTarget
375 * @see #getDropTarget
376 */
377 DropTarget dropTarget;
378
379 /**
380 * @serial
381 * @see #add
382 */
383 Vector<PopupMenu> popups;
384
385 /**
386 * A component's name.
387 * This field can be <code>null</code>.
388 *
389 * @serial
390 * @see #getName
391 * @see #setName(String)
392 */
393 private String name;
394
395 /**
396 * A bool to determine whether the name has
397 * been set explicitly. <code>nameExplicitlySet</code> will
398 * be false if the name has not been set and
399 * true if it has.
400 *
401 * @serial
402 * @see #getName
403 * @see #setName(String)
404 */
405 private boolean nameExplicitlySet = false;
406
407 /**
408 * Indicates whether this Component can be focused.
409 *
410 * @serial
411 * @see #setFocusable
412 * @see #isFocusable
413 * @since 1.4
414 */
415 private boolean focusable = true;
416
417 private static final int FOCUS_TRAVERSABLE_UNKNOWN = 0;
418 private static final int FOCUS_TRAVERSABLE_DEFAULT = 1;
419 private static final int FOCUS_TRAVERSABLE_SET = 2;
420
421 /**
422 * Tracks whether this Component is relying on default focus traversability.
423 *
424 * @serial
425 * @since 1.4
426 */
427 private int isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN;
428
429 /**
430 * The focus traversal keys. These keys will generate focus traversal
431 * behavior for Components for which focus traversal keys are enabled. If a
432 * value of null is specified for a traversal key, this Component inherits
433 * that traversal key from its parent. If all ancestors of this Component
434 * have null specified for that traversal key, then the current
435 * KeyboardFocusManager's default traversal key is used.
436 *
437 * @serial
438 * @see #setFocusTraversalKeys
439 * @see #getFocusTraversalKeys
440 * @since 1.4
441 */
442 Set<AWTKeyStroke>[] focusTraversalKeys;
443
444 private static final String[] focusTraversalKeyPropertyNames = {
445 "forwardFocusTraversalKeys",
446 "backwardFocusTraversalKeys",
447 "upCycleFocusTraversalKeys",
448 "downCycleFocusTraversalKeys"
449 };
450
451 /**
452 * Indicates whether focus traversal keys are enabled for this Component.
453 * Components for which focus traversal keys are disabled receive key
454 * events for focus traversal keys. Components for which focus traversal
455 * keys are enabled do not see these events; instead, the events are
456 * automatically converted to traversal operations.
457 *
458 * @serial
459 * @see #setFocusTraversalKeysEnabled
460 * @see #getFocusTraversalKeysEnabled
461 * @since 1.4
462 */
463 private boolean focusTraversalKeysEnabled = true;
464
465 /**
466 * The locking object for AWT component-tree and layout operations.
467 *
468 * @see #getTreeLock
469 */
470 static final Object LOCK = new AWTTreeLock();
471 static class AWTTreeLock {}
472
473 /*
474 * The component's AccessControlContext.
475 */
476 private transient volatile AccessControlContext acc =
477 AccessController.getContext();
478
479 /**
480 * Minimum size.
481 * (This field perhaps should have been transient).
482 *
483 * @serial
484 */
485 Dimension minSize;
486
487 /**
488 * Whether or not setMinimumSize has been invoked with a non-null value.
489 */
490 boolean minSizeSet;
491
492 /**
493 * Preferred size.
494 * (This field perhaps should have been transient).
495 *
496 * @serial
497 */
498 Dimension prefSize;
499
500 /**
501 * Whether or not setPreferredSize has been invoked with a non-null value.
502 */
503 boolean prefSizeSet;
504
505 /**
506 * Maximum size
507 *
508 * @serial
509 */
510 Dimension maxSize;
511
512 /**
513 * Whether or not setMaximumSize has been invoked with a non-null value.
514 */
515 boolean maxSizeSet;
516
517 /**
518 * The orientation for this component.
519 * @see #getComponentOrientation
520 * @see #setComponentOrientation
521 */
522 transient ComponentOrientation componentOrientation
523 = ComponentOrientation.UNKNOWN;
524
525 /**
526 * <code>newEventsOnly</code> will be true if the event is
527 * one of the event types enabled for the component.
528 * It will then allow for normal processing to
529 * continue. If it is false the event is passed
530 * to the component's parent and up the ancestor
531 * tree until the event has been consumed.
532 *
533 * @serial
534 * @see #dispatchEvent
535 */
536 boolean newEventsOnly = false;
537 transient ComponentListener componentListener;
538 transient FocusListener focusListener;
539 transient HierarchyListener hierarchyListener;
540 transient HierarchyBoundsListener hierarchyBoundsListener;
541 transient KeyListener keyListener;
542 transient MouseListener mouseListener;
543 transient MouseMotionListener mouseMotionListener;
544 transient MouseWheelListener mouseWheelListener;
545 transient InputMethodListener inputMethodListener;
546
547 /** Internal, constants for serialization */
548 final static String actionListenerK = "actionL";
549 final static String adjustmentListenerK = "adjustmentL";
550 final static String componentListenerK = "componentL";
551 final static String containerListenerK = "containerL";
552 final static String focusListenerK = "focusL";
553 final static String itemListenerK = "itemL";
554 final static String keyListenerK = "keyL";
555 final static String mouseListenerK = "mouseL";
556 final static String mouseMotionListenerK = "mouseMotionL";
557 final static String mouseWheelListenerK = "mouseWheelL";
558 final static String textListenerK = "textL";
559 final static String ownedWindowK = "ownedL";
560 final static String windowListenerK = "windowL";
561 final static String inputMethodListenerK = "inputMethodL";
562 final static String hierarchyListenerK = "hierarchyL";
563 final static String hierarchyBoundsListenerK = "hierarchyBoundsL";
564 final static String windowStateListenerK = "windowStateL";
565 final static String windowFocusListenerK = "windowFocusL";
566
567 /**
568 * The <code>eventMask</code> is ONLY set by subclasses via
569 * <code>enableEvents</code>.
570 * The mask should NOT be set when listeners are registered
571 * so that we can distinguish the difference between when
572 * listeners request events and subclasses request them.
573 * One bit is used to indicate whether input methods are
574 * enabled; this bit is set by <code>enableInputMethods</code> and is
575 * on by default.
576 *
577 * @serial
578 * @see #enableInputMethods
579 * @see AWTEvent
580 */
581 long eventMask = AWTEvent.INPUT_METHODS_ENABLED_MASK;
582
583 /**
584 * Static properties for incremental drawing.
585 * @see #imageUpdate
586 */
587 static boolean isInc;
588 static int incRate;
589 static {
590 /* ensure that the necessary native libraries are loaded */
591 Toolkit.loadLibraries();
592 /* initialize JNI field and method ids */
593 if (!GraphicsEnvironment.isHeadless()) {
594 initIDs();
595 }
596
597 String s = java.security.AccessController.doPrivileged(
598 new GetPropertyAction("awt.image.incrementaldraw"));
599 isInc = (s == null || s.equals("true"));
600
601 s = java.security.AccessController.doPrivileged(
602 new GetPropertyAction("awt.image.redrawrate"));
603 incRate = (s != null) ? Integer.parseInt(s) : 100;
604 }
605
606 /**
607 * Ease-of-use constant for <code>getAlignmentY()</code>.
608 * Specifies an alignment to the top of the component.
609 * @see #getAlignmentY
610 */
611 public static final float TOP_ALIGNMENT = 0.0f;
612
613 /**
614 * Ease-of-use constant for <code>getAlignmentY</code> and
615 * <code>getAlignmentX</code>. Specifies an alignment to
616 * the center of the component
617 * @see #getAlignmentX
618 * @see #getAlignmentY
619 */
620 public static final float CENTER_ALIGNMENT = 0.5f;
621
622 /**
623 * Ease-of-use constant for <code>getAlignmentY</code>.
624 * Specifies an alignment to the bottom of the component.
625 * @see #getAlignmentY
626 */
627 public static final float BOTTOM_ALIGNMENT = 1.0f;
628
629 /**
630 * Ease-of-use constant for <code>getAlignmentX</code>.
631 * Specifies an alignment to the left side of the component.
632 * @see #getAlignmentX
633 */
634 public static final float LEFT_ALIGNMENT = 0.0f;
635
636 /**
637 * Ease-of-use constant for <code>getAlignmentX</code>.
638 * Specifies an alignment to the right side of the component.
639 * @see #getAlignmentX
640 */
641 public static final float RIGHT_ALIGNMENT = 1.0f;
642
643 /*
644 * JDK 1.1 serialVersionUID
645 */
646 private static final long serialVersionUID = -7644114512714619750L;
647
648 /**
649 * If any <code>PropertyChangeListeners</code> have been registered,
650 * the <code>changeSupport</code> field describes them.
651 *
652 * @serial
653 * @since 1.2
654 * @see #addPropertyChangeListener
655 * @see #removePropertyChangeListener
656 * @see #firePropertyChange
657 */
658 private PropertyChangeSupport changeSupport;
659
660 /*
661 * In some cases using "this" as an object to synchronize by
662 * can lead to a deadlock if client code also uses synchronization
663 * by a component object. For every such situation revealed we should
664 * consider possibility of replacing "this" with the package private
665 * objectLock object introduced below. So far there are 3 issues known:
666 * - CR 6708322 (the getName/setName methods);
667 * - CR 6608764 (the PropertyChangeListener machinery);
668 * - CR 7108598 (the Container.paint/KeyboardFocusManager.clearMostRecentFocusOwner methods).
669 *
670 * Note: this field is considered final, though readObject() prohibits
671 * initializing final fields.
672 */
673 private transient Object objectLock = new Object();
674 Object getObjectLock() {
675 return objectLock;
676 }
677
678 /*
679 * Returns the acc this component was constructed with.
680 */
681 final AccessControlContext getAccessControlContext() {
682 if (acc == null) {
683 throw new SecurityException("Component is missing AccessControlContext");
684 }
685 return acc;
686 }
687
688 boolean isPacked = false;
689
690 /**
691 * Pseudoparameter for direct Geometry API (setLocation, setBounds setSize
692 * to signal setBounds what's changing. Should be used under TreeLock.
693 * This is only needed due to the inability to change the cross-calling
694 * order of public and deprecated methods.
695 */
696 private int boundsOp = ComponentPeer.DEFAULT_OPERATION;
697
698 /**
699 * Enumeration of the common ways the baseline of a component can
700 * change as the size changes. The baseline resize behavior is
701 * primarily for layout managers that need to know how the
702 * position of the baseline changes as the component size changes.
703 * In general the baseline resize behavior will be valid for sizes
704 * greater than or equal to the minimum size (the actual minimum
705 * size; not a developer specified minimum size). For sizes
706 * smaller than the minimum size the baseline may change in a way
707 * other than the baseline resize behavior indicates. Similarly,
708 * as the size approaches <code>Integer.MAX_VALUE</code> and/or
709 * <code>Short.MAX_VALUE</code> the baseline may change in a way
710 * other than the baseline resize behavior indicates.
711 *
712 * @see #getBaselineResizeBehavior
713 * @see #getBaseline(int,int)
714 * @since 1.6
715 */
716 public enum BaselineResizeBehavior {
717 /**
718 * Indicates the baseline remains fixed relative to the
719 * y-origin. That is, <code>getBaseline</code> returns
720 * the same value regardless of the height or width. For example, a
721 * <code>JLabel</code> containing non-empty text with a
722 * vertical alignment of <code>TOP</code> should have a
723 * baseline type of <code>CONSTANT_ASCENT</code>.
724 */
725 CONSTANT_ASCENT,
726
727 /**
728 * Indicates the baseline remains fixed relative to the height
729 * and does not change as the width is varied. That is, for
730 * any height H the difference between H and
731 * <code>getBaseline(w, H)</code> is the same. For example, a
732 * <code>JLabel</code> containing non-empty text with a
733 * vertical alignment of <code>BOTTOM</code> should have a
734 * baseline type of <code>CONSTANT_DESCENT</code>.
735 */
736 CONSTANT_DESCENT,
737
738 /**
739 * Indicates the baseline remains a fixed distance from
740 * the center of the component. That is, for any height H the
741 * difference between <code>getBaseline(w, H)</code> and
742 * <code>H / 2</code> is the same (plus or minus one depending upon
743 * rounding error).
744 * <p>
745 * Because of possible rounding errors it is recommended
746 * you ask for the baseline with two consecutive heights and use
747 * the return value to determine if you need to pad calculations
748 * by 1. The following shows how to calculate the baseline for
749 * any height:
750 * <pre>
751 * Dimension preferredSize = component.getPreferredSize();
752 * int baseline = getBaseline(preferredSize.width,
753 * preferredSize.height);
754 * int nextBaseline = getBaseline(preferredSize.width,
755 * preferredSize.height + 1);
756 * // Amount to add to height when calculating where baseline
757 * // lands for a particular height:
758 * int padding = 0;
759 * // Where the baseline is relative to the mid point
760 * int baselineOffset = baseline - height / 2;
761 * if (preferredSize.height % 2 == 0 &&
762 * baseline != nextBaseline) {
763 * padding = 1;
764 * }
765 * else if (preferredSize.height % 2 == 1 &&
766 * baseline == nextBaseline) {
767 * baselineOffset--;
768 * padding = 1;
769 * }
770 * // The following calculates where the baseline lands for
771 * // the height z:
772 * int calculatedBaseline = (z + padding) / 2 + baselineOffset;
773 * </pre>
774 */
775 CENTER_OFFSET,
776
777 /**
778 * Indicates the baseline resize behavior can not be expressed using
779 * any of the other constants. This may also indicate the baseline
780 * varies with the width of the component. This is also returned
781 * by components that do not have a baseline.
782 */
783 OTHER
784 }
785
786 /*
787 * The shape set with the applyCompoundShape() method. It includes the result
788 * of the HW/LW mixing related shape computation. It may also include
789 * the user-specified shape of the component.
790 * The 'null' value means the component has normal shape (or has no shape at all)
791 * and applyCompoundShape() will skip the following shape identical to normal.
792 */
793 private transient Region compoundShape = null;
794
795 /*
796 * Represents the shape of this lightweight component to be cut out from
797 * heavyweight components should they intersect. Possible values:
798 * 1. null - consider the shape rectangular
799 * 2. EMPTY_REGION - nothing gets cut out (children still get cut out)
800 * 3. non-empty - this shape gets cut out.
801 */
802 private transient Region mixingCutoutRegion = null;
803
804 /*
805 * Indicates whether addNotify() is complete
806 * (i.e. the peer is created).
807 */
808 private transient boolean isAddNotifyComplete = false;
809
810 /**
811 * Should only be used in subclass getBounds to check that part of bounds
812 * is actually changing
813 */
814 int getBoundsOp() {
815 assert Thread.holdsLock(getTreeLock());
816 return boundsOp;
817 }
818
819 void setBoundsOp(int op) {
820 assert Thread.holdsLock(getTreeLock());
821 if (op == ComponentPeer.RESET_OPERATION) {
822 boundsOp = ComponentPeer.DEFAULT_OPERATION;
823 } else
824 if (boundsOp == ComponentPeer.DEFAULT_OPERATION) {
825 boundsOp = op;
826 }
827 }
828
829 // Whether this Component has had the background erase flag
830 // specified via SunToolkit.disableBackgroundErase(). This is
831 // needed in order to make this function work on X11 platforms,
832 // where currently there is no chance to interpose on the creation
833 // of the peer and therefore the call to XSetBackground.
834 transient boolean backgroundEraseDisabled;
835
836 static {
837 AWTAccessor.setComponentAccessor(new AWTAccessor.ComponentAccessor() {
838 public void setBackgroundEraseDisabled(Component comp, boolean disabled) {
839 comp.backgroundEraseDisabled = disabled;
840 }
841 public boolean getBackgroundEraseDisabled(Component comp) {
842 return comp.backgroundEraseDisabled;
843 }
844 public Rectangle getBounds(Component comp) {
845 return new Rectangle(comp.x, comp.y, comp.width, comp.height);
846 }
847 public void setMixingCutoutShape(Component comp, Shape shape) {
848 Region region = shape == null ? null :
849 Region.getInstance(shape, null);
850
851 synchronized (comp.getTreeLock()) {
852 boolean needShowing = false;
853 boolean needHiding = false;
854
855 if (!comp.isNonOpaqueForMixing()) {
856 needHiding = true;
857 }
858
859 comp.mixingCutoutRegion = region;
860
861 if (!comp.isNonOpaqueForMixing()) {
862 needShowing = true;
863 }
864
865 if (comp.isMixingNeeded()) {
866 if (needHiding) {
867 comp.mixOnHiding(comp.isLightweight());
868 }
869 if (needShowing) {
870 comp.mixOnShowing();
871 }
872 }
873 }
874 }
875
876 public void setGraphicsConfiguration(Component comp,
877 GraphicsConfiguration gc)
878 {
879 comp.setGraphicsConfiguration(gc);
880 }
881 public boolean requestFocus(Component comp, CausedFocusEvent.Cause cause) {
882 return comp.requestFocus(cause);
883 }
884 public boolean canBeFocusOwner(Component comp) {
885 return comp.canBeFocusOwner();
886 }
887
888 public boolean isVisible(Component comp) {
889 return comp.isVisible_NoClientCode();
890 }
891 public void setRequestFocusController
892 (RequestFocusController requestController)
893 {
894 Component.setRequestFocusController(requestController);
895 }
896 public AppContext getAppContext(Component comp) {
897 return comp.appContext;
898 }
899 public void setAppContext(Component comp, AppContext appContext) {
900 comp.appContext = appContext;
901 }
902 public Container getParent(Component comp) {
903 return comp.getParent_NoClientCode();
904 }
905 public void setParent(Component comp, Container parent) {
906 comp.parent = parent;
907 }
908 public void setSize(Component comp, int width, int height) {
909 comp.width = width;
910 comp.height = height;
911 }
912 public Point getLocation(Component comp) {
913 return comp.location_NoClientCode();
914 }
915 public void setLocation(Component comp, int x, int y) {
916 comp.x = x;
917 comp.y = y;
918 }
919 public boolean isEnabled(Component comp) {
920 return comp.isEnabledImpl();
921 }
922 public boolean isDisplayable(Component comp) {
923 return comp.peer != null;
924 }
925 public Cursor getCursor(Component comp) {
926 return comp.getCursor_NoClientCode();
927 }
928 @SuppressWarnings("unchecked")
929 public <T extends ComponentPeer> T getPeer(Component comp) {
930 return (T) comp.peer;
931 }
932 public void setPeer(Component comp, ComponentPeer peer) {
933 comp.peer = peer;
934 }
935 public boolean isLightweight(Component comp) {
936 return (comp.peer instanceof LightweightPeer);
937 }
938 public boolean getIgnoreRepaint(Component comp) {
939 return comp.ignoreRepaint;
940 }
941 public int getWidth(Component comp) {
942 return comp.width;
943 }
944 public int getHeight(Component comp) {
945 return comp.height;
946 }
947 public int getX(Component comp) {
948 return comp.x;
949 }
950 public int getY(Component comp) {
951 return comp.y;
952 }
953 public Color getForeground(Component comp) {
954 return comp.foreground;
955 }
956 public Color getBackground(Component comp) {
957 return comp.background;
958 }
959 public void setBackground(Component comp, Color background) {
960 comp.background = background;
961 }
962 public Font getFont(Component comp) {
963 return comp.getFont_NoClientCode();
964 }
965 public void processEvent(Component comp, AWTEvent e) {
966 comp.processEvent(e);
967 }
968
969 public AccessControlContext getAccessControlContext(Component comp) {
970 return comp.getAccessControlContext();
971 }
972
973 public void revalidateSynchronously(Component comp) {
974 comp.revalidateSynchronously();
975 }
976
977 @Override
978 public void createBufferStrategy(Component comp, int numBuffers,
979 BufferCapabilities caps) throws AWTException {
980 comp.createBufferStrategy(numBuffers, caps);
981 }
982
983 @Override
984 public BufferStrategy getBufferStrategy(Component comp) {
985 return comp.getBufferStrategy();
986 }
987 });
988 }
989
990 /**
991 * Constructs a new component. Class <code>Component</code> can be
992 * extended directly to create a lightweight component that does not
993 * utilize an opaque native window. A lightweight component must be
994 * hosted by a native container somewhere higher up in the component
995 * tree (for example, by a <code>Frame</code> object).
996 */
997 protected Component() {
998 appContext = AppContext.getAppContext();
999 }
1000
1001 @SuppressWarnings({"rawtypes", "unchecked"})
1002 void initializeFocusTraversalKeys() {
1003 focusTraversalKeys = new Set[3];
1004 }
1005
1006 /**
1007 * Constructs a name for this component. Called by <code>getName</code>
1008 * when the name is <code>null</code>.
1009 */
1010 String constructComponentName() {
1011 return null; // For strict compliance with prior platform versions, a Component
1012 // that doesn't set its name should return null from
1013 // getName()
1014 }
1015
1016 /**
1017 * Gets the name of the component.
1018 * @return this component's name
1019 * @see #setName
1020 * @since 1.1
1021 */
1022 public String getName() {
1023 if (name == null && !nameExplicitlySet) {
1024 synchronized(getObjectLock()) {
1025 if (name == null && !nameExplicitlySet)
1026 name = constructComponentName();
1027 }
1028 }
1029 return name;
1030 }
1031
1032 /**
1033 * Sets the name of the component to the specified string.
1034 * @param name the string that is to be this
1035 * component's name
1036 * @see #getName
1037 * @since 1.1
1038 */
1039 public void setName(String name) {
1040 String oldName;
1041 synchronized(getObjectLock()) {
1042 oldName = this.name;
1043 this.name = name;
1044 nameExplicitlySet = true;
1045 }
1046 firePropertyChange("name", oldName, name);
1047 }
1048
1049 /**
1050 * Gets the parent of this component.
1051 * @return the parent container of this component
1052 * @since 1.0
1053 */
1054 public Container getParent() {
1055 return getParent_NoClientCode();
1056 }
1057
1058 // NOTE: This method may be called by privileged threads.
1059 // This functionality is implemented in a package-private method
1060 // to insure that it cannot be overridden by client subclasses.
1061 // DO NOT INVOKE CLIENT CODE ON THIS THREAD!
1062 final Container getParent_NoClientCode() {
1063 return parent;
1064 }
1065
1066 // This method is overridden in the Window class to return null,
1067 // because the parent field of the Window object contains
1068 // the owner of the window, not its parent.
1069 Container getContainer() {
1070 return getParent_NoClientCode();
1071 }
1072
1073 /**
1074 * Associate a <code>DropTarget</code> with this component.
1075 * The <code>Component</code> will receive drops only if it
1076 * is enabled.
1077 *
1078 * @see #isEnabled
1079 * @param dt The DropTarget
1080 */
1081
1082 public synchronized void setDropTarget(DropTarget dt) {
1083 if (dt == dropTarget || (dropTarget != null && dropTarget.equals(dt)))
1084 return;
1085
1086 DropTarget old;
1087
1088 if ((old = dropTarget) != null) {
1089 dropTarget.removeNotify();
1090
1091 DropTarget t = dropTarget;
1092
1093 dropTarget = null;
1094
1095 try {
1096 t.setComponent(null);
1097 } catch (IllegalArgumentException iae) {
1098 // ignore it.
1099 }
1100 }
1101
1102 // if we have a new one, and we have a peer, add it!
1103
1104 if ((dropTarget = dt) != null) {
1105 try {
1106 dropTarget.setComponent(this);
1107 dropTarget.addNotify();
1108 } catch (IllegalArgumentException iae) {
1109 if (old != null) {
1110 try {
1111 old.setComponent(this);
1112 dropTarget.addNotify();
1113 } catch (IllegalArgumentException iae1) {
1114 // ignore it!
1115 }
1116 }
1117 }
1118 }
1119 }
1120
1121 /**
1122 * Gets the <code>DropTarget</code> associated with this
1123 * <code>Component</code>.
1124 *
1125 * @return the drop target
1126 */
1127
1128 public synchronized DropTarget getDropTarget() { return dropTarget; }
1129
1130 /**
1131 * Gets the <code>GraphicsConfiguration</code> associated with this
1132 * <code>Component</code>.
1133 * If the <code>Component</code> has not been assigned a specific
1134 * <code>GraphicsConfiguration</code>,
1135 * the <code>GraphicsConfiguration</code> of the
1136 * <code>Component</code> object's top-level container is
1137 * returned.
1138 * If the <code>Component</code> has been created, but not yet added
1139 * to a <code>Container</code>, this method returns <code>null</code>.
1140 *
1141 * @return the <code>GraphicsConfiguration</code> used by this
1142 * <code>Component</code> or <code>null</code>
1143 * @since 1.3
1144 */
1145 public GraphicsConfiguration getGraphicsConfiguration() {
1146 synchronized(getTreeLock()) {
1147 return getGraphicsConfiguration_NoClientCode();
1148 }
1149 }
1150
1151 final GraphicsConfiguration getGraphicsConfiguration_NoClientCode() {
1152 return graphicsConfig;
1153 }
1154
1155 void setGraphicsConfiguration(GraphicsConfiguration gc) {
1156 synchronized(getTreeLock()) {
1157 if (updateGraphicsData(gc)) {
1158 removeNotify();
1159 addNotify();
1160 }
1161 }
1162 }
1163
1164 boolean updateGraphicsData(GraphicsConfiguration gc) {
1165 checkTreeLock();
1166
1167 if (graphicsConfig == gc) {
1168 return false;
1169 }
1170
1171 graphicsConfig = gc;
1172
1173 ComponentPeer peer = this.peer;
1174 if (peer != null) {
1175 return peer.updateGraphicsData(gc);
1176 }
1177 return false;
1178 }
1179
1180 /**
1181 * Checks that this component's <code>GraphicsDevice</code>
1182 * <code>idString</code> matches the string argument.
1183 */
1184 void checkGD(String stringID) {
1185 if (graphicsConfig != null) {
1186 if (!graphicsConfig.getDevice().getIDstring().equals(stringID)) {
1187 throw new IllegalArgumentException(
1188 "adding a container to a container on a different GraphicsDevice");
1189 }
1190 }
1191 }
1192
1193 /**
1194 * Gets this component's locking object (the object that owns the thread
1195 * synchronization monitor) for AWT component-tree and layout
1196 * operations.
1197 * @return this component's locking object
1198 */
1199 public final Object getTreeLock() {
1200 return LOCK;
1201 }
1202
1203 final void checkTreeLock() {
1204 if (!Thread.holdsLock(getTreeLock())) {
1205 throw new IllegalStateException("This function should be called while holding treeLock");
1206 }
1207 }
1208
1209 /**
1210 * Gets the toolkit of this component. Note that
1211 * the frame that contains a component controls which
1212 * toolkit is used by that component. Therefore if the component
1213 * is moved from one frame to another, the toolkit it uses may change.
1214 * @return the toolkit of this component
1215 * @since 1.0
1216 */
1217 public Toolkit getToolkit() {
1218 return getToolkitImpl();
1219 }
1220
1221 /*
1222 * This is called by the native code, so client code can't
1223 * be called on the toolkit thread.
1224 */
1225 final Toolkit getToolkitImpl() {
1226 Container parent = this.parent;
1227 if (parent != null) {
1228 return parent.getToolkitImpl();
1229 }
1230 return Toolkit.getDefaultToolkit();
1231 }
1232
1233 final ComponentFactory getComponentFactory() {
1234 final Toolkit toolkit = getToolkit();
1235 if (toolkit instanceof ComponentFactory) {
1236 return (ComponentFactory) toolkit;
1237 }
1238 throw new AWTError("UI components are unsupported by: " + toolkit);
1239 }
1240
1241 /**
1242 * Determines whether this component is valid. A component is valid
1243 * when it is correctly sized and positioned within its parent
1244 * container and all its children are also valid.
1245 * In order to account for peers' size requirements, components are invalidated
1246 * before they are first shown on the screen. By the time the parent container
1247 * is fully realized, all its components will be valid.
1248 * @return <code>true</code> if the component is valid, <code>false</code>
1249 * otherwise
1250 * @see #validate
1251 * @see #invalidate
1252 * @since 1.0
1253 */
1254 public boolean isValid() {
1255 return (peer != null) && valid;
1256 }
1257
1258 /**
1259 * Determines whether this component is displayable. A component is
1260 * displayable when it is connected to a native screen resource.
1261 * <p>
1262 * A component is made displayable either when it is added to
1263 * a displayable containment hierarchy or when its containment
1264 * hierarchy is made displayable.
1265 * A containment hierarchy is made displayable when its ancestor
1266 * window is either packed or made visible.
1267 * <p>
1268 * A component is made undisplayable either when it is removed from
1269 * a displayable containment hierarchy or when its containment hierarchy
1270 * is made undisplayable. A containment hierarchy is made
1271 * undisplayable when its ancestor window is disposed.
1272 *
1273 * @return <code>true</code> if the component is displayable,
1274 * <code>false</code> otherwise
1275 * @see Container#add(Component)
1276 * @see Window#pack
1277 * @see Window#show
1278 * @see Container#remove(Component)
1279 * @see Window#dispose
1280 * @since 1.2
1281 */
1282 public boolean isDisplayable() {
1283 return peer != null;
1284 }
1285
1286 /**
1287 * Determines whether this component should be visible when its
1288 * parent is visible. Components are
1289 * initially visible, with the exception of top level components such
1290 * as <code>Frame</code> objects.
1291 * @return <code>true</code> if the component is visible,
1292 * <code>false</code> otherwise
1293 * @see #setVisible
1294 * @since 1.0
1295 */
1296 @Transient
1297 public boolean isVisible() {
1298 return isVisible_NoClientCode();
1299 }
1300 final boolean isVisible_NoClientCode() {
1301 return visible;
1302 }
1303
1304 /**
1305 * Determines whether this component will be displayed on the screen.
1306 * @return <code>true</code> if the component and all of its ancestors
1307 * until a toplevel window or null parent are visible,
1308 * <code>false</code> otherwise
1309 */
1310 boolean isRecursivelyVisible() {
1311 return visible && (parent == null || parent.isRecursivelyVisible());
1312 }
1313
1314 /**
1315 * Translates absolute coordinates into coordinates in the coordinate
1316 * space of this component.
1317 */
1318 Point pointRelativeToComponent(Point absolute) {
1319 Point compCoords = getLocationOnScreen();
1320 return new Point(absolute.x - compCoords.x,
1321 absolute.y - compCoords.y);
1322 }
1323
1324 /**
1325 * Assuming that mouse location is stored in PointerInfo passed
1326 * to this method, it finds a Component that is in the same
1327 * Window as this Component and is located under the mouse pointer.
1328 * If no such Component exists, null is returned.
1329 * NOTE: this method should be called under the protection of
1330 * tree lock, as it is done in Component.getMousePosition() and
1331 * Container.getMousePosition(boolean).
1332 */
1333 Component findUnderMouseInWindow(PointerInfo pi) {
1334 if (!isShowing()) {
1335 return null;
1336 }
1337 Window win = getContainingWindow();
1338 Toolkit toolkit = Toolkit.getDefaultToolkit();
1339 if (!(toolkit instanceof ComponentFactory)) {
1340 return null;
1341 }
1342 if (!((ComponentFactory) toolkit).getMouseInfoPeer().isWindowUnderMouse(win)) {
1343 return null;
1344 }
1345 final boolean INCLUDE_DISABLED = true;
1346 Point relativeToWindow = win.pointRelativeToComponent(pi.getLocation());
1347 Component inTheSameWindow = win.findComponentAt(relativeToWindow.x,
1348 relativeToWindow.y,
1349 INCLUDE_DISABLED);
1350 return inTheSameWindow;
1351 }
1352
1353 /**
1354 * Returns the position of the mouse pointer in this <code>Component</code>'s
1355 * coordinate space if the <code>Component</code> is directly under the mouse
1356 * pointer, otherwise returns <code>null</code>.
1357 * If the <code>Component</code> is not showing on the screen, this method
1358 * returns <code>null</code> even if the mouse pointer is above the area
1359 * where the <code>Component</code> would be displayed.
1360 * If the <code>Component</code> is partially or fully obscured by other
1361 * <code>Component</code>s or native windows, this method returns a non-null
1362 * value only if the mouse pointer is located above the unobscured part of the
1363 * <code>Component</code>.
1364 * <p>
1365 * For <code>Container</code>s it returns a non-null value if the mouse is
1366 * above the <code>Container</code> itself or above any of its descendants.
1367 * Use {@link Container#getMousePosition(boolean)} if you need to exclude children.
1368 * <p>
1369 * Sometimes the exact mouse coordinates are not important, and the only thing
1370 * that matters is whether a specific <code>Component</code> is under the mouse
1371 * pointer. If the return value of this method is <code>null</code>, mouse
1372 * pointer is not directly above the <code>Component</code>.
1373 *
1374 * @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true
1375 * @see #isShowing
1376 * @see Container#getMousePosition
1377 * @return mouse coordinates relative to this <code>Component</code>, or null
1378 * @since 1.5
1379 */
1380 public Point getMousePosition() throws HeadlessException {
1381 if (GraphicsEnvironment.isHeadless()) {
1382 throw new HeadlessException();
1383 }
1384
1385 PointerInfo pi = java.security.AccessController.doPrivileged(
1386 new java.security.PrivilegedAction<PointerInfo>() {
1387 public PointerInfo run() {
1388 return MouseInfo.getPointerInfo();
1389 }
1390 }
1391 );
1392
1393 synchronized (getTreeLock()) {
1394 Component inTheSameWindow = findUnderMouseInWindow(pi);
1395 if (!isSameOrAncestorOf(inTheSameWindow, true)) {
1396 return null;
1397 }
1398 return pointRelativeToComponent(pi.getLocation());
1399 }
1400 }
1401
1402 /**
1403 * Overridden in Container. Must be called under TreeLock.
1404 */
1405 boolean isSameOrAncestorOf(Component comp, boolean allowChildren) {
1406 return comp == this;
1407 }
1408
1409 /**
1410 * Determines whether this component is showing on screen. This means
1411 * that the component must be visible, and it must be in a container
1412 * that is visible and showing.
1413 * <p>
1414 * <strong>Note:</strong> sometimes there is no way to detect whether the
1415 * {@code Component} is actually visible to the user. This can happen when:
1416 * <ul>
1417 * <li>the component has been added to a visible {@code ScrollPane} but
1418 * the {@code Component} is not currently in the scroll pane's view port.
1419 * <li>the {@code Component} is obscured by another {@code Component} or
1420 * {@code Container}.
1421 * </ul>
1422 * @return <code>true</code> if the component is showing,
1423 * <code>false</code> otherwise
1424 * @see #setVisible
1425 * @since 1.0
1426 */
1427 public boolean isShowing() {
1428 if (visible && (peer != null)) {
1429 Container parent = this.parent;
1430 return (parent == null) || parent.isShowing();
1431 }
1432 return false;
1433 }
1434
1435 /**
1436 * Determines whether this component is enabled. An enabled component
1437 * can respond to user input and generate events. Components are
1438 * enabled initially by default. A component may be enabled or disabled by
1439 * calling its <code>setEnabled</code> method.
1440 * @return <code>true</code> if the component is enabled,
1441 * <code>false</code> otherwise
1442 * @see #setEnabled
1443 * @since 1.0
1444 */
1445 public boolean isEnabled() {
1446 return isEnabledImpl();
1447 }
1448
1449 /*
1450 * This is called by the native code, so client code can't
1451 * be called on the toolkit thread.
1452 */
1453 final boolean isEnabledImpl() {
1454 return enabled;
1455 }
1456
1457 /**
1458 * Enables or disables this component, depending on the value of the
1459 * parameter <code>b</code>. An enabled component can respond to user
1460 * input and generate events. Components are enabled initially by default.
1461 *
1462 * <p>Note: Disabling a lightweight component does not prevent it from
1463 * receiving MouseEvents.
1464 * <p>Note: Disabling a heavyweight container prevents all components
1465 * in this container from receiving any input events. But disabling a
1466 * lightweight container affects only this container.
1467 *
1468 * @param b If <code>true</code>, this component is
1469 * enabled; otherwise this component is disabled
1470 * @see #isEnabled
1471 * @see #isLightweight
1472 * @since 1.1
1473 */
1474 public void setEnabled(boolean b) {
1475 enable(b);
1476 }
1477
1478 /**
1479 * @deprecated As of JDK version 1.1,
1480 * replaced by <code>setEnabled(boolean)</code>.
1481 */
1482 @Deprecated
1483 public void enable() {
1484 if (!enabled) {
1485 synchronized (getTreeLock()) {
1486 enabled = true;
1487 ComponentPeer peer = this.peer;
1488 if (peer != null) {
1489 peer.setEnabled(true);
1490 if (visible) {
1491 updateCursorImmediately();
1492 }
1493 }
1494 }
1495 if (accessibleContext != null) {
1496 accessibleContext.firePropertyChange(
1497 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
1498 null, AccessibleState.ENABLED);
1499 }
1500 }
1501 }
1502
1503 /**
1504 * Enables or disables this component.
1505 *
1506 * @param b {@code true} to enable this component;
1507 * otherwise {@code false}
1508 *
1509 * @deprecated As of JDK version 1.1,
1510 * replaced by <code>setEnabled(boolean)</code>.
1511 */
1512 @Deprecated
1513 public void enable(boolean b) {
1514 if (b) {
1515 enable();
1516 } else {
1517 disable();
1518 }
1519 }
1520
1521 /**
1522 * @deprecated As of JDK version 1.1,
1523 * replaced by <code>setEnabled(boolean)</code>.
1524 */
1525 @Deprecated
1526 public void disable() {
1527 if (enabled) {
1528 KeyboardFocusManager.clearMostRecentFocusOwner(this);
1529 synchronized (getTreeLock()) {
1530 enabled = false;
1531 // A disabled lw container is allowed to contain a focus owner.
1532 if ((isFocusOwner() || (containsFocus() && !isLightweight())) &&
1533 KeyboardFocusManager.isAutoFocusTransferEnabled())
1534 {
1535 // Don't clear the global focus owner. If transferFocus
1536 // fails, we want the focus to stay on the disabled
1537 // Component so that keyboard traversal, et. al. still
1538 // makes sense to the user.
1539 transferFocus(false);
1540 }
1541 ComponentPeer peer = this.peer;
1542 if (peer != null) {
1543 peer.setEnabled(false);
1544 if (visible) {
1545 updateCursorImmediately();
1546 }
1547 }
1548 }
1549 if (accessibleContext != null) {
1550 accessibleContext.firePropertyChange(
1551 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
1552 null, AccessibleState.ENABLED);
1553 }
1554 }
1555 }
1556
1557 /**
1558 * Returns true if this component is painted to an offscreen image
1559 * ("buffer") that's copied to the screen later. Component
1560 * subclasses that support double buffering should override this
1561 * method to return true if double buffering is enabled.
1562 *
1563 * @return false by default
1564 */
1565 public boolean isDoubleBuffered() {
1566 return false;
1567 }
1568
1569 /**
1570 * Enables or disables input method support for this component. If input
1571 * method support is enabled and the component also processes key events,
1572 * incoming events are offered to
1573 * the current input method and will only be processed by the component or
1574 * dispatched to its listeners if the input method does not consume them.
1575 * By default, input method support is enabled.
1576 *
1577 * @param enable true to enable, false to disable
1578 * @see #processKeyEvent
1579 * @since 1.2
1580 */
1581 public void enableInputMethods(boolean enable) {
1582 if (enable) {
1583 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0)
1584 return;
1585
1586 // If this component already has focus, then activate the
1587 // input method by dispatching a synthesized focus gained
1588 // event.
1589 if (isFocusOwner()) {
1590 InputContext inputContext = getInputContext();
1591 if (inputContext != null) {
1592 FocusEvent focusGainedEvent =
1593 new FocusEvent(this, FocusEvent.FOCUS_GAINED);
1594 inputContext.dispatchEvent(focusGainedEvent);
1595 }
1596 }
1597
1598 eventMask |= AWTEvent.INPUT_METHODS_ENABLED_MASK;
1599 } else {
1600 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) {
1601 InputContext inputContext = getInputContext();
1602 if (inputContext != null) {
1603 inputContext.endComposition();
1604 inputContext.removeNotify(this);
1605 }
1606 }
1607 eventMask &= ~AWTEvent.INPUT_METHODS_ENABLED_MASK;
1608 }
1609 }
1610
1611 /**
1612 * Shows or hides this component depending on the value of parameter
1613 * <code>b</code>.
1614 * <p>
1615 * This method changes layout-related information, and therefore,
1616 * invalidates the component hierarchy.
1617 *
1618 * @param b if <code>true</code>, shows this component;
1619 * otherwise, hides this component
1620 * @see #isVisible
1621 * @see #invalidate
1622 * @since 1.1
1623 */
1624 public void setVisible(boolean b) {
1625 show(b);
1626 }
1627
1628 /**
1629 * @deprecated As of JDK version 1.1,
1630 * replaced by <code>setVisible(boolean)</code>.
1631 */
1632 @Deprecated
1633 public void show() {
1634 if (!visible) {
1635 synchronized (getTreeLock()) {
1636 visible = true;
1637 mixOnShowing();
1638 ComponentPeer peer = this.peer;
1639 if (peer != null) {
1640 peer.setVisible(true);
1641 createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED,
1642 this, parent,
1643 HierarchyEvent.SHOWING_CHANGED,
1644 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK));
1645 if (peer instanceof LightweightPeer) {
1646 repaint();
1647 }
1648 updateCursorImmediately();
1649 }
1650
1651 if (componentListener != null ||
1652 (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
1653 Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) {
1654 ComponentEvent e = new ComponentEvent(this,
1655 ComponentEvent.COMPONENT_SHOWN);
1656 Toolkit.getEventQueue().postEvent(e);
1657 }
1658 }
1659 Container parent = this.parent;
1660 if (parent != null) {
1661 parent.invalidate();
1662 }
1663 }
1664 }
1665
1666 /**
1667 * Makes this component visible or invisible.
1668 *
1669 * @param b {@code true} to make this component visible;
1670 * otherwise {@code false}
1671 *
1672 * @deprecated As of JDK version 1.1,
1673 * replaced by <code>setVisible(boolean)</code>.
1674 */
1675 @Deprecated
1676 public void show(boolean b) {
1677 if (b) {
1678 show();
1679 } else {
1680 hide();
1681 }
1682 }
1683
1684 boolean containsFocus() {
1685 return isFocusOwner();
1686 }
1687
1688 void clearMostRecentFocusOwnerOnHide() {
1689 KeyboardFocusManager.clearMostRecentFocusOwner(this);
1690 }
1691
1692 void clearCurrentFocusCycleRootOnHide() {
1693 /* do nothing */
1694 }
1695
1696 /**
1697 * @deprecated As of JDK version 1.1,
1698 * replaced by <code>setVisible(boolean)</code>.
1699 */
1700 @Deprecated
1701 public void hide() {
1702 isPacked = false;
1703
1704 if (visible) {
1705 clearCurrentFocusCycleRootOnHide();
1706 clearMostRecentFocusOwnerOnHide();
1707 synchronized (getTreeLock()) {
1708 visible = false;
1709 mixOnHiding(isLightweight());
1710 if (containsFocus() && KeyboardFocusManager.isAutoFocusTransferEnabled()) {
1711 transferFocus(true);
1712 }
1713 ComponentPeer peer = this.peer;
1714 if (peer != null) {
1715 peer.setVisible(false);
1716 createHierarchyEvents(HierarchyEvent.HIERARCHY_CHANGED,
1717 this, parent,
1718 HierarchyEvent.SHOWING_CHANGED,
1719 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK));
1720 if (peer instanceof LightweightPeer) {
1721 repaint();
1722 }
1723 updateCursorImmediately();
1724 }
1725 if (componentListener != null ||
1726 (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
1727 Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK)) {
1728 ComponentEvent e = new ComponentEvent(this,
1729 ComponentEvent.COMPONENT_HIDDEN);
1730 Toolkit.getEventQueue().postEvent(e);
1731 }
1732 }
1733 Container parent = this.parent;
1734 if (parent != null) {
1735 parent.invalidate();
1736 }
1737 }
1738 }
1739
1740 /**
1741 * Gets the foreground color of this component.
1742 * @return this component's foreground color; if this component does
1743 * not have a foreground color, the foreground color of its parent
1744 * is returned
1745 * @see #setForeground
1746 * @since 1.0
1747 * @beaninfo
1748 * bound: true
1749 */
1750 @Transient
1751 public Color getForeground() {
1752 Color foreground = this.foreground;
1753 if (foreground != null) {
1754 return foreground;
1755 }
1756 Container parent = this.parent;
1757 return (parent != null) ? parent.getForeground() : null;
1758 }
1759
1760 /**
1761 * Sets the foreground color of this component.
1762 * @param c the color to become this component's
1763 * foreground color; if this parameter is <code>null</code>
1764 * then this component will inherit
1765 * the foreground color of its parent
1766 * @see #getForeground
1767 * @since 1.0
1768 */
1769 public void setForeground(Color c) {
1770 Color oldColor = foreground;
1771 ComponentPeer peer = this.peer;
1772 foreground = c;
1773 if (peer != null) {
1774 c = getForeground();
1775 if (c != null) {
1776 peer.setForeground(c);
1777 }
1778 }
1779 // This is a bound property, so report the change to
1780 // any registered listeners. (Cheap if there are none.)
1781 firePropertyChange("foreground", oldColor, c);
1782 }
1783
1784 /**
1785 * Returns whether the foreground color has been explicitly set for this
1786 * Component. If this method returns <code>false</code>, this Component is
1787 * inheriting its foreground color from an ancestor.
1788 *
1789 * @return <code>true</code> if the foreground color has been explicitly
1790 * set for this Component; <code>false</code> otherwise.
1791 * @since 1.4
1792 */
1793 public boolean isForegroundSet() {
1794 return (foreground != null);
1795 }
1796
1797 /**
1798 * Gets the background color of this component.
1799 * @return this component's background color; if this component does
1800 * not have a background color,
1801 * the background color of its parent is returned
1802 * @see #setBackground
1803 * @since 1.0
1804 */
1805 @Transient
1806 public Color getBackground() {
1807 Color background = this.background;
1808 if (background != null) {
1809 return background;
1810 }
1811 Container parent = this.parent;
1812 return (parent != null) ? parent.getBackground() : null;
1813 }
1814
1815 /**
1816 * Sets the background color of this component.
1817 * <p>
1818 * The background color affects each component differently and the
1819 * parts of the component that are affected by the background color
1820 * may differ between operating systems.
1821 *
1822 * @param c the color to become this component's color;
1823 * if this parameter is <code>null</code>, then this
1824 * component will inherit the background color of its parent
1825 * @see #getBackground
1826 * @since 1.0
1827 * @beaninfo
1828 * bound: true
1829 */
1830 public void setBackground(Color c) {
1831 Color oldColor = background;
1832 ComponentPeer peer = this.peer;
1833 background = c;
1834 if (peer != null) {
1835 c = getBackground();
1836 if (c != null) {
1837 peer.setBackground(c);
1838 }
1839 }
1840 // This is a bound property, so report the change to
1841 // any registered listeners. (Cheap if there are none.)
1842 firePropertyChange("background", oldColor, c);
1843 }
1844
1845 /**
1846 * Returns whether the background color has been explicitly set for this
1847 * Component. If this method returns <code>false</code>, this Component is
1848 * inheriting its background color from an ancestor.
1849 *
1850 * @return <code>true</code> if the background color has been explicitly
1851 * set for this Component; <code>false</code> otherwise.
1852 * @since 1.4
1853 */
1854 public boolean isBackgroundSet() {
1855 return (background != null);
1856 }
1857
1858 /**
1859 * Gets the font of this component.
1860 * @return this component's font; if a font has not been set
1861 * for this component, the font of its parent is returned
1862 * @see #setFont
1863 * @since 1.0
1864 */
1865 @Transient
1866 public Font getFont() {
1867 return getFont_NoClientCode();
1868 }
1869
1870 // NOTE: This method may be called by privileged threads.
1871 // This functionality is implemented in a package-private method
1872 // to insure that it cannot be overridden by client subclasses.
1873 // DO NOT INVOKE CLIENT CODE ON THIS THREAD!
1874 final Font getFont_NoClientCode() {
1875 Font font = this.font;
1876 if (font != null) {
1877 return font;
1878 }
1879 Container parent = this.parent;
1880 return (parent != null) ? parent.getFont_NoClientCode() : null;
1881 }
1882
1883 /**
1884 * Sets the font of this component.
1885 * <p>
1886 * This method changes layout-related information, and therefore,
1887 * invalidates the component hierarchy.
1888 *
1889 * @param f the font to become this component's font;
1890 * if this parameter is <code>null</code> then this
1891 * component will inherit the font of its parent
1892 * @see #getFont
1893 * @see #invalidate
1894 * @since 1.0
1895 * @beaninfo
1896 * bound: true
1897 */
1898 public void setFont(Font f) {
1899 Font oldFont, newFont;
1900 synchronized(getTreeLock()) {
1901 oldFont = font;
1902 newFont = font = f;
1903 ComponentPeer peer = this.peer;
1904 if (peer != null) {
1905 f = getFont();
1906 if (f != null) {
1907 peer.setFont(f);
1908 peerFont = f;
1909 }
1910 }
1911 }
1912 // This is a bound property, so report the change to
1913 // any registered listeners. (Cheap if there are none.)
1914 firePropertyChange("font", oldFont, newFont);
1915
1916 // This could change the preferred size of the Component.
1917 // Fix for 6213660. Should compare old and new fonts and do not
1918 // call invalidate() if they are equal.
1919 if (f != oldFont && (oldFont == null ||
1920 !oldFont.equals(f))) {
1921 invalidateIfValid();
1922 }
1923 }
1924
1925 /**
1926 * Returns whether the font has been explicitly set for this Component. If
1927 * this method returns <code>false</code>, this Component is inheriting its
1928 * font from an ancestor.
1929 *
1930 * @return <code>true</code> if the font has been explicitly set for this
1931 * Component; <code>false</code> otherwise.
1932 * @since 1.4
1933 */
1934 public boolean isFontSet() {
1935 return (font != null);
1936 }
1937
1938 /**
1939 * Gets the locale of this component.
1940 * @return this component's locale; if this component does not
1941 * have a locale, the locale of its parent is returned
1942 * @see #setLocale
1943 * @exception IllegalComponentStateException if the <code>Component</code>
1944 * does not have its own locale and has not yet been added to
1945 * a containment hierarchy such that the locale can be determined
1946 * from the containing parent
1947 * @since 1.1
1948 */
1949 public Locale getLocale() {
1950 Locale locale = this.locale;
1951 if (locale != null) {
1952 return locale;
1953 }
1954 Container parent = this.parent;
1955
1956 if (parent == null) {
1957 throw new IllegalComponentStateException("This component must have a parent in order to determine its locale");
1958 } else {
1959 return parent.getLocale();
1960 }
1961 }
1962
1963 /**
1964 * Sets the locale of this component. This is a bound property.
1965 * <p>
1966 * This method changes layout-related information, and therefore,
1967 * invalidates the component hierarchy.
1968 *
1969 * @param l the locale to become this component's locale
1970 * @see #getLocale
1971 * @see #invalidate
1972 * @since 1.1
1973 */
1974 public void setLocale(Locale l) {
1975 Locale oldValue = locale;
1976 locale = l;
1977
1978 // This is a bound property, so report the change to
1979 // any registered listeners. (Cheap if there are none.)
1980 firePropertyChange("locale", oldValue, l);
1981
1982 // This could change the preferred size of the Component.
1983 invalidateIfValid();
1984 }
1985
1986 /**
1987 * Gets the instance of <code>ColorModel</code> used to display
1988 * the component on the output device.
1989 * @return the color model used by this component
1990 * @see java.awt.image.ColorModel
1991 * @see java.awt.peer.ComponentPeer#getColorModel()
1992 * @see Toolkit#getColorModel()
1993 * @since 1.0
1994 */
1995 public ColorModel getColorModel() {
1996 ComponentPeer peer = this.peer;
1997 if ((peer != null) && ! (peer instanceof LightweightPeer)) {
1998 return peer.getColorModel();
1999 } else if (GraphicsEnvironment.isHeadless()) {
2000 return ColorModel.getRGBdefault();
2001 } // else
2002 return getToolkit().getColorModel();
2003 }
2004
2005 /**
2006 * Gets the location of this component in the form of a
2007 * point specifying the component's top-left corner.
2008 * The location will be relative to the parent's coordinate space.
2009 * <p>
2010 * Due to the asynchronous nature of native event handling, this
2011 * method can return outdated values (for instance, after several calls
2012 * of <code>setLocation()</code> in rapid succession). For this
2013 * reason, the recommended method of obtaining a component's position is
2014 * within <code>java.awt.event.ComponentListener.componentMoved()</code>,
2015 * which is called after the operating system has finished moving the
2016 * component.
2017 * </p>
2018 * @return an instance of <code>Point</code> representing
2019 * the top-left corner of the component's bounds in
2020 * the coordinate space of the component's parent
2021 * @see #setLocation
2022 * @see #getLocationOnScreen
2023 * @since 1.1
2024 */
2025 public Point getLocation() {
2026 return location();
2027 }
2028
2029 /**
2030 * Gets the location of this component in the form of a point
2031 * specifying the component's top-left corner in the screen's
2032 * coordinate space.
2033 * @return an instance of <code>Point</code> representing
2034 * the top-left corner of the component's bounds in the
2035 * coordinate space of the screen
2036 * @throws IllegalComponentStateException if the
2037 * component is not showing on the screen
2038 * @see #setLocation
2039 * @see #getLocation
2040 */
2041 public Point getLocationOnScreen() {
2042 synchronized (getTreeLock()) {
2043 return getLocationOnScreen_NoTreeLock();
2044 }
2045 }
2046
2047 /*
2048 * a package private version of getLocationOnScreen
2049 * used by GlobalCursormanager to update cursor
2050 */
2051 final Point getLocationOnScreen_NoTreeLock() {
2052
2053 if (peer != null && isShowing()) {
2054 if (peer instanceof LightweightPeer) {
2055 // lightweight component location needs to be translated
2056 // relative to a native component.
2057 Container host = getNativeContainer();
2058 Point pt = host.peer.getLocationOnScreen();
2059 for(Component c = this; c != host; c = c.getParent()) {
2060 pt.x += c.x;
2061 pt.y += c.y;
2062 }
2063 return pt;
2064 } else {
2065 Point pt = peer.getLocationOnScreen();
2066 return pt;
2067 }
2068 } else {
2069 throw new IllegalComponentStateException("component must be showing on the screen to determine its location");
2070 }
2071 }
2072
2073
2074 /**
2075 * Returns the location of this component's top left corner.
2076 *
2077 * @return the location of this component's top left corner
2078 * @deprecated As of JDK version 1.1,
2079 * replaced by <code>getLocation()</code>.
2080 */
2081 @Deprecated
2082 public Point location() {
2083 return location_NoClientCode();
2084 }
2085
2086 private Point location_NoClientCode() {
2087 return new Point(x, y);
2088 }
2089
2090 /**
2091 * Moves this component to a new location. The top-left corner of
2092 * the new location is specified by the <code>x</code> and <code>y</code>
2093 * parameters in the coordinate space of this component's parent.
2094 * <p>
2095 * This method changes layout-related information, and therefore,
2096 * invalidates the component hierarchy.
2097 *
2098 * @param x the <i>x</i>-coordinate of the new location's
2099 * top-left corner in the parent's coordinate space
2100 * @param y the <i>y</i>-coordinate of the new location's
2101 * top-left corner in the parent's coordinate space
2102 * @see #getLocation
2103 * @see #setBounds
2104 * @see #invalidate
2105 * @since 1.1
2106 */
2107 public void setLocation(int x, int y) {
2108 move(x, y);
2109 }
2110
2111 /**
2112 * Moves this component to a new location.
2113 *
2114 * @param x the <i>x</i>-coordinate of the new location's
2115 * top-left corner in the parent's coordinate space
2116 * @param y the <i>y</i>-coordinate of the new location's
2117 * top-left corner in the parent's coordinate space
2118 *
2119 * @deprecated As of JDK version 1.1,
2120 * replaced by <code>setLocation(int, int)</code>.
2121 */
2122 @Deprecated
2123 public void move(int x, int y) {
2124 synchronized(getTreeLock()) {
2125 setBoundsOp(ComponentPeer.SET_LOCATION);
2126 setBounds(x, y, width, height);
2127 }
2128 }
2129
2130 /**
2131 * Moves this component to a new location. The top-left corner of
2132 * the new location is specified by point <code>p</code>. Point
2133 * <code>p</code> is given in the parent's coordinate space.
2134 * <p>
2135 * This method changes layout-related information, and therefore,
2136 * invalidates the component hierarchy.
2137 *
2138 * @param p the point defining the top-left corner
2139 * of the new location, given in the coordinate space of this
2140 * component's parent
2141 * @see #getLocation
2142 * @see #setBounds
2143 * @see #invalidate
2144 * @since 1.1
2145 */
2146 public void setLocation(Point p) {
2147 setLocation(p.x, p.y);
2148 }
2149
2150 /**
2151 * Returns the size of this component in the form of a
2152 * <code>Dimension</code> object. The <code>height</code>
2153 * field of the <code>Dimension</code> object contains
2154 * this component's height, and the <code>width</code>
2155 * field of the <code>Dimension</code> object contains
2156 * this component's width.
2157 * @return a <code>Dimension</code> object that indicates the
2158 * size of this component
2159 * @see #setSize
2160 * @since 1.1
2161 */
2162 public Dimension getSize() {
2163 return size();
2164 }
2165
2166 /**
2167 * Returns the size of this component in the form of a
2168 * {@code Dimension} object.
2169 *
2170 * @return the {@code Dimension} object that indicates the
2171 * size of this component
2172 * @deprecated As of JDK version 1.1,
2173 * replaced by <code>getSize()</code>.
2174 */
2175 @Deprecated
2176 public Dimension size() {
2177 return new Dimension(width, height);
2178 }
2179
2180 /**
2181 * Resizes this component so that it has width <code>width</code>
2182 * and height <code>height</code>.
2183 * <p>
2184 * This method changes layout-related information, and therefore,
2185 * invalidates the component hierarchy.
2186 *
2187 * @param width the new width of this component in pixels
2188 * @param height the new height of this component in pixels
2189 * @see #getSize
2190 * @see #setBounds
2191 * @see #invalidate
2192 * @since 1.1
2193 */
2194 public void setSize(int width, int height) {
2195 resize(width, height);
2196 }
2197
2198 /**
2199 * Resizes this component.
2200 *
2201 * @param width the new width of the component
2202 * @param height the new height of the component
2203 * @deprecated As of JDK version 1.1,
2204 * replaced by <code>setSize(int, int)</code>.
2205 */
2206 @Deprecated
2207 public void resize(int width, int height) {
2208 synchronized(getTreeLock()) {
2209 setBoundsOp(ComponentPeer.SET_SIZE);
2210 setBounds(x, y, width, height);
2211 }
2212 }
2213
2214 /**
2215 * Resizes this component so that it has width <code>d.width</code>
2216 * and height <code>d.height</code>.
2217 * <p>
2218 * This method changes layout-related information, and therefore,
2219 * invalidates the component hierarchy.
2220 *
2221 * @param d the dimension specifying the new size
2222 * of this component
2223 * @throws NullPointerException if {@code d} is {@code null}
2224 * @see #setSize
2225 * @see #setBounds
2226 * @see #invalidate
2227 * @since 1.1
2228 */
2229 public void setSize(Dimension d) {
2230 resize(d);
2231 }
2232
2233 /**
2234 * Resizes this component so that it has width {@code d.width}
2235 * and height {@code d.height}.
2236 *
2237 * @param d the new size of this component
2238 * @deprecated As of JDK version 1.1,
2239 * replaced by <code>setSize(Dimension)</code>.
2240 */
2241 @Deprecated
2242 public void resize(Dimension d) {
2243 setSize(d.width, d.height);
2244 }
2245
2246 /**
2247 * Gets the bounds of this component in the form of a
2248 * <code>Rectangle</code> object. The bounds specify this
2249 * component's width, height, and location relative to
2250 * its parent.
2251 * @return a rectangle indicating this component's bounds
2252 * @see #setBounds
2253 * @see #getLocation
2254 * @see #getSize
2255 */
2256 public Rectangle getBounds() {
2257 return bounds();
2258 }
2259
2260 /**
2261 * Returns the bounding rectangle of this component.
2262 *
2263 * @return the bounding rectangle for this component
2264 * @deprecated As of JDK version 1.1,
2265 * replaced by <code>getBounds()</code>.
2266 */
2267 @Deprecated
2268 public Rectangle bounds() {
2269 return new Rectangle(x, y, width, height);
2270 }
2271
2272 /**
2273 * Moves and resizes this component. The new location of the top-left
2274 * corner is specified by <code>x</code> and <code>y</code>, and the
2275 * new size is specified by <code>width</code> and <code>height</code>.
2276 * <p>
2277 * This method changes layout-related information, and therefore,
2278 * invalidates the component hierarchy.
2279 *
2280 * @param x the new <i>x</i>-coordinate of this component
2281 * @param y the new <i>y</i>-coordinate of this component
2282 * @param width the new <code>width</code> of this component
2283 * @param height the new <code>height</code> of this
2284 * component
2285 * @see #getBounds
2286 * @see #setLocation(int, int)
2287 * @see #setLocation(Point)
2288 * @see #setSize(int, int)
2289 * @see #setSize(Dimension)
2290 * @see #invalidate
2291 * @since 1.1
2292 */
2293 public void setBounds(int x, int y, int width, int height) {
2294 reshape(x, y, width, height);
2295 }
2296
2297 /**
2298 * Reshapes the bounding rectangle for this component.
2299 *
2300 * @param x the <i>x</i> coordinate of the upper left corner of the rectangle
2301 * @param y the <i>y</i> coordinate of the upper left corner of the rectangle
2302 * @param width the width of the rectangle
2303 * @param height the height of the rectangle
2304 *
2305 * @deprecated As of JDK version 1.1,
2306 * replaced by <code>setBounds(int, int, int, int)</code>.
2307 */
2308 @Deprecated
2309 public void reshape(int x, int y, int width, int height) {
2310 synchronized (getTreeLock()) {
2311 try {
2312 setBoundsOp(ComponentPeer.SET_BOUNDS);
2313 boolean resized = (this.width != width) || (this.height != height);
2314 boolean moved = (this.x != x) || (this.y != y);
2315 if (!resized && !moved) {
2316 return;
2317 }
2318 int oldX = this.x;
2319 int oldY = this.y;
2320 int oldWidth = this.width;
2321 int oldHeight = this.height;
2322 this.x = x;
2323 this.y = y;
2324 this.width = width;
2325 this.height = height;
2326
2327 if (resized) {
2328 isPacked = false;
2329 }
2330
2331 boolean needNotify = true;
2332 mixOnReshaping();
2333 if (peer != null) {
2334 // LightweightPeer is an empty stub so can skip peer.reshape
2335 if (!(peer instanceof LightweightPeer)) {
2336 reshapeNativePeer(x, y, width, height, getBoundsOp());
2337 // Check peer actually changed coordinates
2338 resized = (oldWidth != this.width) || (oldHeight != this.height);
2339 moved = (oldX != this.x) || (oldY != this.y);
2340 // fix for 5025858: do not send ComponentEvents for toplevel
2341 // windows here as it is done from peer or native code when
2342 // the window is really resized or moved, otherwise some
2343 // events may be sent twice
2344 if (this instanceof Window) {
2345 needNotify = false;
2346 }
2347 }
2348 if (resized) {
2349 invalidate();
2350 }
2351 if (parent != null) {
2352 parent.invalidateIfValid();
2353 }
2354 }
2355 if (needNotify) {
2356 notifyNewBounds(resized, moved);
2357 }
2358 repaintParentIfNeeded(oldX, oldY, oldWidth, oldHeight);
2359 } finally {
2360 setBoundsOp(ComponentPeer.RESET_OPERATION);
2361 }
2362 }
2363 }
2364
2365 private void repaintParentIfNeeded(int oldX, int oldY, int oldWidth,
2366 int oldHeight)
2367 {
2368 if (parent != null && peer instanceof LightweightPeer && isShowing()) {
2369 // Have the parent redraw the area this component occupied.
2370 parent.repaint(oldX, oldY, oldWidth, oldHeight);
2371 // Have the parent redraw the area this component *now* occupies.
2372 repaint();
2373 }
2374 }
2375
2376 private void reshapeNativePeer(int x, int y, int width, int height, int op) {
2377 // native peer might be offset by more than direct
2378 // parent since parent might be lightweight.
2379 int nativeX = x;
2380 int nativeY = y;
2381 for (Component c = parent;
2382 (c != null) && (c.peer instanceof LightweightPeer);
2383 c = c.parent)
2384 {
2385 nativeX += c.x;
2386 nativeY += c.y;
2387 }
2388 peer.setBounds(nativeX, nativeY, width, height, op);
2389 }
2390
2391 @SuppressWarnings("deprecation")
2392 private void notifyNewBounds(boolean resized, boolean moved) {
2393 if (componentListener != null
2394 || (eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0
2395 || Toolkit.enabledOnToolkit(AWTEvent.COMPONENT_EVENT_MASK))
2396 {
2397 if (resized) {
2398 ComponentEvent e = new ComponentEvent(this,
2399 ComponentEvent.COMPONENT_RESIZED);
2400 Toolkit.getEventQueue().postEvent(e);
2401 }
2402 if (moved) {
2403 ComponentEvent e = new ComponentEvent(this,
2404 ComponentEvent.COMPONENT_MOVED);
2405 Toolkit.getEventQueue().postEvent(e);
2406 }
2407 } else {
2408 if (this instanceof Container && ((Container)this).countComponents() > 0) {
2409 boolean enabledOnToolkit =
2410 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK);
2411 if (resized) {
2412
2413 ((Container)this).createChildHierarchyEvents(
2414 HierarchyEvent.ANCESTOR_RESIZED, 0, enabledOnToolkit);
2415 }
2416 if (moved) {
2417 ((Container)this).createChildHierarchyEvents(
2418 HierarchyEvent.ANCESTOR_MOVED, 0, enabledOnToolkit);
2419 }
2420 }
2421 }
2422 }
2423
2424 /**
2425 * Moves and resizes this component to conform to the new
2426 * bounding rectangle <code>r</code>. This component's new
2427 * position is specified by <code>r.x</code> and <code>r.y</code>,
2428 * and its new size is specified by <code>r.width</code> and
2429 * <code>r.height</code>
2430 * <p>
2431 * This method changes layout-related information, and therefore,
2432 * invalidates the component hierarchy.
2433 *
2434 * @param r the new bounding rectangle for this component
2435 * @throws NullPointerException if {@code r} is {@code null}
2436 * @see #getBounds
2437 * @see #setLocation(int, int)
2438 * @see #setLocation(Point)
2439 * @see #setSize(int, int)
2440 * @see #setSize(Dimension)
2441 * @see #invalidate
2442 * @since 1.1
2443 */
2444 public void setBounds(Rectangle r) {
2445 setBounds(r.x, r.y, r.width, r.height);
2446 }
2447
2448
2449 /**
2450 * Returns the current x coordinate of the components origin.
2451 * This method is preferable to writing
2452 * <code>component.getBounds().x</code>,
2453 * or <code>component.getLocation().x</code> because it doesn't
2454 * cause any heap allocations.
2455 *
2456 * @return the current x coordinate of the components origin
2457 * @since 1.2
2458 */
2459 public int getX() {
2460 return x;
2461 }
2462
2463
2464 /**
2465 * Returns the current y coordinate of the components origin.
2466 * This method is preferable to writing
2467 * <code>component.getBounds().y</code>,
2468 * or <code>component.getLocation().y</code> because it
2469 * doesn't cause any heap allocations.
2470 *
2471 * @return the current y coordinate of the components origin
2472 * @since 1.2
2473 */
2474 public int getY() {
2475 return y;
2476 }
2477
2478
2479 /**
2480 * Returns the current width of this component.
2481 * This method is preferable to writing
2482 * <code>component.getBounds().width</code>,
2483 * or <code>component.getSize().width</code> because it
2484 * doesn't cause any heap allocations.
2485 *
2486 * @return the current width of this component
2487 * @since 1.2
2488 */
2489 public int getWidth() {
2490 return width;
2491 }
2492
2493
2494 /**
2495 * Returns the current height of this component.
2496 * This method is preferable to writing
2497 * <code>component.getBounds().height</code>,
2498 * or <code>component.getSize().height</code> because it
2499 * doesn't cause any heap allocations.
2500 *
2501 * @return the current height of this component
2502 * @since 1.2
2503 */
2504 public int getHeight() {
2505 return height;
2506 }
2507
2508 /**
2509 * Stores the bounds of this component into "return value" <b>rv</b> and
2510 * return <b>rv</b>. If rv is <code>null</code> a new
2511 * <code>Rectangle</code> is allocated.
2512 * This version of <code>getBounds</code> is useful if the caller
2513 * wants to avoid allocating a new <code>Rectangle</code> object
2514 * on the heap.
2515 *
2516 * @param rv the return value, modified to the components bounds
2517 * @return rv
2518 */
2519 public Rectangle getBounds(Rectangle rv) {
2520 if (rv == null) {
2521 return new Rectangle(getX(), getY(), getWidth(), getHeight());
2522 }
2523 else {
2524 rv.setBounds(getX(), getY(), getWidth(), getHeight());
2525 return rv;
2526 }
2527 }
2528
2529 /**
2530 * Stores the width/height of this component into "return value" <b>rv</b>
2531 * and return <b>rv</b>. If rv is <code>null</code> a new
2532 * <code>Dimension</code> object is allocated. This version of
2533 * <code>getSize</code> is useful if the caller wants to avoid
2534 * allocating a new <code>Dimension</code> object on the heap.
2535 *
2536 * @param rv the return value, modified to the components size
2537 * @return rv
2538 */
2539 public Dimension getSize(Dimension rv) {
2540 if (rv == null) {
2541 return new Dimension(getWidth(), getHeight());
2542 }
2543 else {
2544 rv.setSize(getWidth(), getHeight());
2545 return rv;
2546 }
2547 }
2548
2549 /**
2550 * Stores the x,y origin of this component into "return value" <b>rv</b>
2551 * and return <b>rv</b>. If rv is <code>null</code> a new
2552 * <code>Point</code> is allocated.
2553 * This version of <code>getLocation</code> is useful if the
2554 * caller wants to avoid allocating a new <code>Point</code>
2555 * object on the heap.
2556 *
2557 * @param rv the return value, modified to the components location
2558 * @return rv
2559 */
2560 public Point getLocation(Point rv) {
2561 if (rv == null) {
2562 return new Point(getX(), getY());
2563 }
2564 else {
2565 rv.setLocation(getX(), getY());
2566 return rv;
2567 }
2568 }
2569
2570 /**
2571 * Returns true if this component is completely opaque, returns
2572 * false by default.
2573 * <p>
2574 * An opaque component paints every pixel within its
2575 * rectangular region. A non-opaque component paints only some of
2576 * its pixels, allowing the pixels underneath it to "show through".
2577 * A component that does not fully paint its pixels therefore
2578 * provides a degree of transparency.
2579 * <p>
2580 * Subclasses that guarantee to always completely paint their
2581 * contents should override this method and return true.
2582 *
2583 * @return true if this component is completely opaque
2584 * @see #isLightweight
2585 * @since 1.2
2586 */
2587 public boolean isOpaque() {
2588 if (peer == null) {
2589 return false;
2590 }
2591 else {
2592 return !isLightweight();
2593 }
2594 }
2595
2596
2597 /**
2598 * A lightweight component doesn't have a native toolkit peer.
2599 * Subclasses of <code>Component</code> and <code>Container</code>,
2600 * other than the ones defined in this package like <code>Button</code>
2601 * or <code>Scrollbar</code>, are lightweight.
2602 * All of the Swing components are lightweights.
2603 * <p>
2604 * This method will always return <code>false</code> if this component
2605 * is not displayable because it is impossible to determine the
2606 * weight of an undisplayable component.
2607 *
2608 * @return true if this component has a lightweight peer; false if
2609 * it has a native peer or no peer
2610 * @see #isDisplayable
2611 * @since 1.2
2612 */
2613 public boolean isLightweight() {
2614 return peer instanceof LightweightPeer;
2615 }
2616
2617
2618 /**
2619 * Sets the preferred size of this component to a constant
2620 * value. Subsequent calls to <code>getPreferredSize</code> will always
2621 * return this value. Setting the preferred size to <code>null</code>
2622 * restores the default behavior.
2623 *
2624 * @param preferredSize The new preferred size, or null
2625 * @see #getPreferredSize
2626 * @see #isPreferredSizeSet
2627 * @since 1.5
2628 */
2629 public void setPreferredSize(Dimension preferredSize) {
2630 Dimension old;
2631 // If the preferred size was set, use it as the old value, otherwise
2632 // use null to indicate we didn't previously have a set preferred
2633 // size.
2634 if (prefSizeSet) {
2635 old = this.prefSize;
2636 }
2637 else {
2638 old = null;
2639 }
2640 this.prefSize = preferredSize;
2641 prefSizeSet = (preferredSize != null);
2642 firePropertyChange("preferredSize", old, preferredSize);
2643 }
2644
2645
2646 /**
2647 * Returns true if the preferred size has been set to a
2648 * non-<code>null</code> value otherwise returns false.
2649 *
2650 * @return true if <code>setPreferredSize</code> has been invoked
2651 * with a non-null value.
2652 * @since 1.5
2653 */
2654 public boolean isPreferredSizeSet() {
2655 return prefSizeSet;
2656 }
2657
2658
2659 /**
2660 * Gets the preferred size of this component.
2661 * @return a dimension object indicating this component's preferred size
2662 * @see #getMinimumSize
2663 * @see LayoutManager
2664 */
2665 public Dimension getPreferredSize() {
2666 return preferredSize();
2667 }
2668
2669
2670 /**
2671 * Returns the component's preferred size.
2672 *
2673 * @return the component's preferred size
2674 * @deprecated As of JDK version 1.1,
2675 * replaced by <code>getPreferredSize()</code>.
2676 */
2677 @Deprecated
2678 public Dimension preferredSize() {
2679 /* Avoid grabbing the lock if a reasonable cached size value
2680 * is available.
2681 */
2682 Dimension dim = prefSize;
2683 if (dim == null || !(isPreferredSizeSet() || isValid())) {
2684 synchronized (getTreeLock()) {
2685 prefSize = (peer != null) ?
2686 peer.getPreferredSize() :
2687 getMinimumSize();
2688 dim = prefSize;
2689 }
2690 }
2691 return new Dimension(dim);
2692 }
2693
2694 /**
2695 * Sets the minimum size of this component to a constant
2696 * value. Subsequent calls to <code>getMinimumSize</code> will always
2697 * return this value. Setting the minimum size to <code>null</code>
2698 * restores the default behavior.
2699 *
2700 * @param minimumSize the new minimum size of this component
2701 * @see #getMinimumSize
2702 * @see #isMinimumSizeSet
2703 * @since 1.5
2704 */
2705 public void setMinimumSize(Dimension minimumSize) {
2706 Dimension old;
2707 // If the minimum size was set, use it as the old value, otherwise
2708 // use null to indicate we didn't previously have a set minimum
2709 // size.
2710 if (minSizeSet) {
2711 old = this.minSize;
2712 }
2713 else {
2714 old = null;
2715 }
2716 this.minSize = minimumSize;
2717 minSizeSet = (minimumSize != null);
2718 firePropertyChange("minimumSize", old, minimumSize);
2719 }
2720
2721 /**
2722 * Returns whether or not <code>setMinimumSize</code> has been
2723 * invoked with a non-null value.
2724 *
2725 * @return true if <code>setMinimumSize</code> has been invoked with a
2726 * non-null value.
2727 * @since 1.5
2728 */
2729 public boolean isMinimumSizeSet() {
2730 return minSizeSet;
2731 }
2732
2733 /**
2734 * Gets the minimum size of this component.
2735 * @return a dimension object indicating this component's minimum size
2736 * @see #getPreferredSize
2737 * @see LayoutManager
2738 */
2739 public Dimension getMinimumSize() {
2740 return minimumSize();
2741 }
2742
2743 /**
2744 * Returns the minimum size of this component.
2745 *
2746 * @return the minimum size of this component
2747 * @deprecated As of JDK version 1.1,
2748 * replaced by <code>getMinimumSize()</code>.
2749 */
2750 @Deprecated
2751 public Dimension minimumSize() {
2752 /* Avoid grabbing the lock if a reasonable cached size value
2753 * is available.
2754 */
2755 Dimension dim = minSize;
2756 if (dim == null || !(isMinimumSizeSet() || isValid())) {
2757 synchronized (getTreeLock()) {
2758 minSize = (peer != null) ?
2759 peer.getMinimumSize() :
2760 size();
2761 dim = minSize;
2762 }
2763 }
2764 return new Dimension(dim);
2765 }
2766
2767 /**
2768 * Sets the maximum size of this component to a constant
2769 * value. Subsequent calls to <code>getMaximumSize</code> will always
2770 * return this value. Setting the maximum size to <code>null</code>
2771 * restores the default behavior.
2772 *
2773 * @param maximumSize a <code>Dimension</code> containing the
2774 * desired maximum allowable size
2775 * @see #getMaximumSize
2776 * @see #isMaximumSizeSet
2777 * @since 1.5
2778 */
2779 public void setMaximumSize(Dimension maximumSize) {
2780 // If the maximum size was set, use it as the old value, otherwise
2781 // use null to indicate we didn't previously have a set maximum
2782 // size.
2783 Dimension old;
2784 if (maxSizeSet) {
2785 old = this.maxSize;
2786 }
2787 else {
2788 old = null;
2789 }
2790 this.maxSize = maximumSize;
2791 maxSizeSet = (maximumSize != null);
2792 firePropertyChange("maximumSize", old, maximumSize);
2793 }
2794
2795 /**
2796 * Returns true if the maximum size has been set to a non-<code>null</code>
2797 * value otherwise returns false.
2798 *
2799 * @return true if <code>maximumSize</code> is non-<code>null</code>,
2800 * false otherwise
2801 * @since 1.5
2802 */
2803 public boolean isMaximumSizeSet() {
2804 return maxSizeSet;
2805 }
2806
2807 /**
2808 * Gets the maximum size of this component.
2809 * @return a dimension object indicating this component's maximum size
2810 * @see #getMinimumSize
2811 * @see #getPreferredSize
2812 * @see LayoutManager
2813 */
2814 public Dimension getMaximumSize() {
2815 if (isMaximumSizeSet()) {
2816 return new Dimension(maxSize);
2817 }
2818 return new Dimension(Short.MAX_VALUE, Short.MAX_VALUE);
2819 }
2820
2821 /**
2822 * Returns the alignment along the x axis. This specifies how
2823 * the component would like to be aligned relative to other
2824 * components. The value should be a number between 0 and 1
2825 * where 0 represents alignment along the origin, 1 is aligned
2826 * the furthest away from the origin, 0.5 is centered, etc.
2827 *
2828 * @return the horizontal alignment of this component
2829 */
2830 public float getAlignmentX() {
2831 return CENTER_ALIGNMENT;
2832 }
2833
2834 /**
2835 * Returns the alignment along the y axis. This specifies how
2836 * the component would like to be aligned relative to other
2837 * components. The value should be a number between 0 and 1
2838 * where 0 represents alignment along the origin, 1 is aligned
2839 * the furthest away from the origin, 0.5 is centered, etc.
2840 *
2841 * @return the vertical alignment of this component
2842 */
2843 public float getAlignmentY() {
2844 return CENTER_ALIGNMENT;
2845 }
2846
2847 /**
2848 * Returns the baseline. The baseline is measured from the top of
2849 * the component. This method is primarily meant for
2850 * <code>LayoutManager</code>s to align components along their
2851 * baseline. A return value less than 0 indicates this component
2852 * does not have a reasonable baseline and that
2853 * <code>LayoutManager</code>s should not align this component on
2854 * its baseline.
2855 * <p>
2856 * The default implementation returns -1. Subclasses that support
2857 * baseline should override appropriately. If a value >= 0 is
2858 * returned, then the component has a valid baseline for any
2859 * size >= the minimum size and <code>getBaselineResizeBehavior</code>
2860 * can be used to determine how the baseline changes with size.
2861 *
2862 * @param width the width to get the baseline for
2863 * @param height the height to get the baseline for
2864 * @return the baseline or < 0 indicating there is no reasonable
2865 * baseline
2866 * @throws IllegalArgumentException if width or height is < 0
2867 * @see #getBaselineResizeBehavior
2868 * @see java.awt.FontMetrics
2869 * @since 1.6
2870 */
2871 public int getBaseline(int width, int height) {
2872 if (width < 0 || height < 0) {
2873 throw new IllegalArgumentException(
2874 "Width and height must be >= 0");
2875 }
2876 return -1;
2877 }
2878
2879 /**
2880 * Returns an enum indicating how the baseline of the component
2881 * changes as the size changes. This method is primarily meant for
2882 * layout managers and GUI builders.
2883 * <p>
2884 * The default implementation returns
2885 * <code>BaselineResizeBehavior.OTHER</code>. Subclasses that have a
2886 * baseline should override appropriately. Subclasses should
2887 * never return <code>null</code>; if the baseline can not be
2888 * calculated return <code>BaselineResizeBehavior.OTHER</code>. Callers
2889 * should first ask for the baseline using
2890 * <code>getBaseline</code> and if a value >= 0 is returned use
2891 * this method. It is acceptable for this method to return a
2892 * value other than <code>BaselineResizeBehavior.OTHER</code> even if
2893 * <code>getBaseline</code> returns a value less than 0.
2894 *
2895 * @return an enum indicating how the baseline changes as the component
2896 * size changes
2897 * @see #getBaseline(int, int)
2898 * @since 1.6
2899 */
2900 public BaselineResizeBehavior getBaselineResizeBehavior() {
2901 return BaselineResizeBehavior.OTHER;
2902 }
2903
2904 /**
2905 * Prompts the layout manager to lay out this component. This is
2906 * usually called when the component (more specifically, container)
2907 * is validated.
2908 * @see #validate
2909 * @see LayoutManager
2910 */
2911 public void doLayout() {
2912 layout();
2913 }
2914
2915 /**
2916 * @deprecated As of JDK version 1.1,
2917 * replaced by <code>doLayout()</code>.
2918 */
2919 @Deprecated
2920 public void layout() {
2921 }
2922
2923 /**
2924 * Validates this component.
2925 * <p>
2926 * The meaning of the term <i>validating</i> is defined by the ancestors of
2927 * this class. See {@link Container#validate} for more details.
2928 *
2929 * @see #invalidate
2930 * @see #doLayout()
2931 * @see LayoutManager
2932 * @see Container#validate
2933 * @since 1.0
2934 */
2935 public void validate() {
2936 synchronized (getTreeLock()) {
2937 ComponentPeer peer = this.peer;
2938 boolean wasValid = isValid();
2939 if (!wasValid && peer != null) {
2940 Font newfont = getFont();
2941 Font oldfont = peerFont;
2942 if (newfont != oldfont && (oldfont == null
2943 || !oldfont.equals(newfont))) {
2944 peer.setFont(newfont);
2945 peerFont = newfont;
2946 }
2947 peer.layout();
2948 }
2949 valid = true;
2950 if (!wasValid) {
2951 mixOnValidating();
2952 }
2953 }
2954 }
2955
2956 /**
2957 * Invalidates this component and its ancestors.
2958 * <p>
2959 * By default, all the ancestors of the component up to the top-most
2960 * container of the hierarchy are marked invalid. If the {@code
2961 * java.awt.smartInvalidate} system property is set to {@code true},
2962 * invalidation stops on the nearest validate root of this component.
2963 * Marking a container <i>invalid</i> indicates that the container needs to
2964 * be laid out.
2965 * <p>
2966 * This method is called automatically when any layout-related information
2967 * changes (e.g. setting the bounds of the component, or adding the
2968 * component to a container).
2969 * <p>
2970 * This method might be called often, so it should work fast.
2971 *
2972 * @see #validate
2973 * @see #doLayout
2974 * @see LayoutManager
2975 * @see java.awt.Container#isValidateRoot
2976 * @since 1.0
2977 */
2978 public void invalidate() {
2979 synchronized (getTreeLock()) {
2980 /* Nullify cached layout and size information.
2981 * For efficiency, propagate invalidate() upwards only if
2982 * some other component hasn't already done so first.
2983 */
2984 valid = false;
2985 if (!isPreferredSizeSet()) {
2986 prefSize = null;
2987 }
2988 if (!isMinimumSizeSet()) {
2989 minSize = null;
2990 }
2991 if (!isMaximumSizeSet()) {
2992 maxSize = null;
2993 }
2994 invalidateParent();
2995 }
2996 }
2997
2998 /**
2999 * Invalidates the parent of this component if any.
3000 *
3001 * This method MUST BE invoked under the TreeLock.
3002 */
3003 void invalidateParent() {
3004 if (parent != null) {
3005 parent.invalidateIfValid();
3006 }
3007 }
3008
3009 /** Invalidates the component unless it is already invalid.
3010 */
3011 final void invalidateIfValid() {
3012 if (isValid()) {
3013 invalidate();
3014 }
3015 }
3016
3017 /**
3018 * Revalidates the component hierarchy up to the nearest validate root.
3019 * <p>
3020 * This method first invalidates the component hierarchy starting from this
3021 * component up to the nearest validate root. Afterwards, the component
3022 * hierarchy is validated starting from the nearest validate root.
3023 * <p>
3024 * This is a convenience method supposed to help application developers
3025 * avoid looking for validate roots manually. Basically, it's equivalent to
3026 * first calling the {@link #invalidate()} method on this component, and
3027 * then calling the {@link #validate()} method on the nearest validate
3028 * root.
3029 *
3030 * @see Container#isValidateRoot
3031 * @since 1.7
3032 */
3033 public void revalidate() {
3034 revalidateSynchronously();
3035 }
3036
3037 /**
3038 * Revalidates the component synchronously.
3039 */
3040 final void revalidateSynchronously() {
3041 synchronized (getTreeLock()) {
3042 invalidate();
3043
3044 Container root = getContainer();
3045 if (root == null) {
3046 // There's no parents. Just validate itself.
3047 validate();
3048 } else {
3049 while (!root.isValidateRoot()) {
3050 if (root.getContainer() == null) {
3051 // If there's no validate roots, we'll validate the
3052 // topmost container
3053 break;
3054 }
3055
3056 root = root.getContainer();
3057 }
3058
3059 root.validate();
3060 }
3061 }
3062 }
3063
3064 /**
3065 * Creates a graphics context for this component. This method will
3066 * return <code>null</code> if this component is currently not
3067 * displayable.
3068 * @return a graphics context for this component, or <code>null</code>
3069 * if it has none
3070 * @see #paint
3071 * @since 1.0
3072 */
3073 public Graphics getGraphics() {
3074 if (peer instanceof LightweightPeer) {
3075 // This is for a lightweight component, need to
3076 // translate coordinate spaces and clip relative
3077 // to the parent.
3078 if (parent == null) return null;
3079 Graphics g = parent.getGraphics();
3080 if (g == null) return null;
3081 if (g instanceof ConstrainableGraphics) {
3082 ((ConstrainableGraphics) g).constrain(x, y, width, height);
3083 } else {
3084 g.translate(x,y);
3085 g.setClip(0, 0, width, height);
3086 }
3087 g.setFont(getFont());
3088 return g;
3089 } else {
3090 ComponentPeer peer = this.peer;
3091 return (peer != null) ? peer.getGraphics() : null;
3092 }
3093 }
3094
3095 final Graphics getGraphics_NoClientCode() {
3096 ComponentPeer peer = this.peer;
3097 if (peer instanceof LightweightPeer) {
3098 // This is for a lightweight component, need to
3099 // translate coordinate spaces and clip relative
3100 // to the parent.
3101 Container parent = this.parent;
3102 if (parent == null) return null;
3103 Graphics g = parent.getGraphics_NoClientCode();
3104 if (g == null) return null;
3105 if (g instanceof ConstrainableGraphics) {
3106 ((ConstrainableGraphics) g).constrain(x, y, width, height);
3107 } else {
3108 g.translate(x,y);
3109 g.setClip(0, 0, width, height);
3110 }
3111 g.setFont(getFont_NoClientCode());
3112 return g;
3113 } else {
3114 return (peer != null) ? peer.getGraphics() : null;
3115 }
3116 }
3117
3118 /**
3119 * Gets the font metrics for the specified font.
3120 * Warning: Since Font metrics are affected by the
3121 * {@link java.awt.font.FontRenderContext FontRenderContext} and
3122 * this method does not provide one, it can return only metrics for
3123 * the default render context which may not match that used when
3124 * rendering on the Component if {@link Graphics2D} functionality is being
3125 * used. Instead metrics can be obtained at rendering time by calling
3126 * {@link Graphics#getFontMetrics()} or text measurement APIs on the
3127 * {@link Font Font} class.
3128 * @param font the font for which font metrics is to be
3129 * obtained
3130 * @return the font metrics for <code>font</code>
3131 * @see #getFont
3132 * @see java.awt.peer.ComponentPeer#getFontMetrics(Font)
3133 * @see Toolkit#getFontMetrics(Font)
3134 * @since 1.0
3135 */
3136 public FontMetrics getFontMetrics(Font font) {
3137 // This is an unsupported hack, but left in for a customer.
3138 // Do not remove.
3139 FontManager fm = FontManagerFactory.getInstance();
3140 if (fm instanceof SunFontManager
3141 && ((SunFontManager) fm).usePlatformFontMetrics()) {
3142
3143 if (peer != null &&
3144 !(peer instanceof LightweightPeer)) {
3145 return peer.getFontMetrics(font);
3146 }
3147 }
3148 return sun.font.FontDesignMetrics.getMetrics(font);
3149 }
3150
3151 /**
3152 * Sets the cursor image to the specified cursor. This cursor
3153 * image is displayed when the <code>contains</code> method for
3154 * this component returns true for the current cursor location, and
3155 * this Component is visible, displayable, and enabled. Setting the
3156 * cursor of a <code>Container</code> causes that cursor to be displayed
3157 * within all of the container's subcomponents, except for those
3158 * that have a non-<code>null</code> cursor.
3159 * <p>
3160 * The method may have no visual effect if the Java platform
3161 * implementation and/or the native system do not support
3162 * changing the mouse cursor shape.
3163 * @param cursor One of the constants defined
3164 * by the <code>Cursor</code> class;
3165 * if this parameter is <code>null</code>
3166 * then this component will inherit
3167 * the cursor of its parent
3168 * @see #isEnabled
3169 * @see #isShowing
3170 * @see #getCursor
3171 * @see #contains
3172 * @see Toolkit#createCustomCursor
3173 * @see Cursor
3174 * @since 1.1
3175 */
3176 public void setCursor(Cursor cursor) {
3177 this.cursor = cursor;
3178 updateCursorImmediately();
3179 }
3180
3181 /**
3182 * Updates the cursor. May not be invoked from the native
3183 * message pump.
3184 */
3185 final void updateCursorImmediately() {
3186 if (peer instanceof LightweightPeer) {
3187 Container nativeContainer = getNativeContainer();
3188
3189 if (nativeContainer == null) return;
3190
3191 ComponentPeer cPeer = nativeContainer.peer;
3192
3193 if (cPeer != null) {
3194 cPeer.updateCursorImmediately();
3195 }
3196 } else if (peer != null) {
3197 peer.updateCursorImmediately();
3198 }
3199 }
3200
3201 /**
3202 * Gets the cursor set in the component. If the component does
3203 * not have a cursor set, the cursor of its parent is returned.
3204 * If no cursor is set in the entire hierarchy,
3205 * <code>Cursor.DEFAULT_CURSOR</code> is returned.
3206 *
3207 * @return the cursor for this component
3208 * @see #setCursor
3209 * @since 1.1
3210 */
3211 public Cursor getCursor() {
3212 return getCursor_NoClientCode();
3213 }
3214
3215 final Cursor getCursor_NoClientCode() {
3216 Cursor cursor = this.cursor;
3217 if (cursor != null) {
3218 return cursor;
3219 }
3220 Container parent = this.parent;
3221 if (parent != null) {
3222 return parent.getCursor_NoClientCode();
3223 } else {
3224 return Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR);
3225 }
3226 }
3227
3228 /**
3229 * Returns whether the cursor has been explicitly set for this Component.
3230 * If this method returns <code>false</code>, this Component is inheriting
3231 * its cursor from an ancestor.
3232 *
3233 * @return <code>true</code> if the cursor has been explicitly set for this
3234 * Component; <code>false</code> otherwise.
3235 * @since 1.4
3236 */
3237 public boolean isCursorSet() {
3238 return (cursor != null);
3239 }
3240
3241 /**
3242 * Paints this component.
3243 * <p>
3244 * This method is called when the contents of the component should
3245 * be painted; such as when the component is first being shown or
3246 * is damaged and in need of repair. The clip rectangle in the
3247 * <code>Graphics</code> parameter is set to the area
3248 * which needs to be painted.
3249 * Subclasses of <code>Component</code> that override this
3250 * method need not call <code>super.paint(g)</code>.
3251 * <p>
3252 * For performance reasons, <code>Component</code>s with zero width
3253 * or height aren't considered to need painting when they are first shown,
3254 * and also aren't considered to need repair.
3255 * <p>
3256 * <b>Note</b>: For more information on the paint mechanisms utilitized
3257 * by AWT and Swing, including information on how to write the most
3258 * efficient painting code, see
3259 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3260 *
3261 * @param g the graphics context to use for painting
3262 * @see #update
3263 * @since 1.0
3264 */
3265 public void paint(Graphics g) {
3266 }
3267
3268 /**
3269 * Updates this component.
3270 * <p>
3271 * If this component is not a lightweight component, the
3272 * AWT calls the <code>update</code> method in response to
3273 * a call to <code>repaint</code>. You can assume that
3274 * the background is not cleared.
3275 * <p>
3276 * The <code>update</code> method of <code>Component</code>
3277 * calls this component's <code>paint</code> method to redraw
3278 * this component. This method is commonly overridden by subclasses
3279 * which need to do additional work in response to a call to
3280 * <code>repaint</code>.
3281 * Subclasses of Component that override this method should either
3282 * call <code>super.update(g)</code>, or call <code>paint(g)</code>
3283 * directly from their <code>update</code> method.
3284 * <p>
3285 * The origin of the graphics context, its
3286 * (<code>0</code>, <code>0</code>) coordinate point, is the
3287 * top-left corner of this component. The clipping region of the
3288 * graphics context is the bounding rectangle of this component.
3289 *
3290 * <p>
3291 * <b>Note</b>: For more information on the paint mechanisms utilitized
3292 * by AWT and Swing, including information on how to write the most
3293 * efficient painting code, see
3294 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3295 *
3296 * @param g the specified context to use for updating
3297 * @see #paint
3298 * @see #repaint()
3299 * @since 1.0
3300 */
3301 public void update(Graphics g) {
3302 paint(g);
3303 }
3304
3305 /**
3306 * Paints this component and all of its subcomponents.
3307 * <p>
3308 * The origin of the graphics context, its
3309 * (<code>0</code>, <code>0</code>) coordinate point, is the
3310 * top-left corner of this component. The clipping region of the
3311 * graphics context is the bounding rectangle of this component.
3312 *
3313 * @param g the graphics context to use for painting
3314 * @see #paint
3315 * @since 1.0
3316 */
3317 public void paintAll(Graphics g) {
3318 if (isShowing()) {
3319 GraphicsCallback.PeerPaintCallback.getInstance().
3320 runOneComponent(this, new Rectangle(0, 0, width, height),
3321 g, g.getClip(),
3322 GraphicsCallback.LIGHTWEIGHTS |
3323 GraphicsCallback.HEAVYWEIGHTS);
3324 }
3325 }
3326
3327 /**
3328 * Simulates the peer callbacks into java.awt for painting of
3329 * lightweight Components.
3330 * @param g the graphics context to use for painting
3331 * @see #paintAll
3332 */
3333 void lightweightPaint(Graphics g) {
3334 paint(g);
3335 }
3336
3337 /**
3338 * Paints all the heavyweight subcomponents.
3339 */
3340 void paintHeavyweightComponents(Graphics g) {
3341 }
3342
3343 /**
3344 * Repaints this component.
3345 * <p>
3346 * If this component is a lightweight component, this method
3347 * causes a call to this component's <code>paint</code>
3348 * method as soon as possible. Otherwise, this method causes
3349 * a call to this component's <code>update</code> method as soon
3350 * as possible.
3351 * <p>
3352 * <b>Note</b>: For more information on the paint mechanisms utilitized
3353 * by AWT and Swing, including information on how to write the most
3354 * efficient painting code, see
3355 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3356
3357 *
3358 * @see #update(Graphics)
3359 * @since 1.0
3360 */
3361 public void repaint() {
3362 repaint(0, 0, 0, width, height);
3363 }
3364
3365 /**
3366 * Repaints the component. If this component is a lightweight
3367 * component, this results in a call to <code>paint</code>
3368 * within <code>tm</code> milliseconds.
3369 * <p>
3370 * <b>Note</b>: For more information on the paint mechanisms utilitized
3371 * by AWT and Swing, including information on how to write the most
3372 * efficient painting code, see
3373 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3374 *
3375 * @param tm maximum time in milliseconds before update
3376 * @see #paint
3377 * @see #update(Graphics)
3378 * @since 1.0
3379 */
3380 public void repaint(long tm) {
3381 repaint(tm, 0, 0, width, height);
3382 }
3383
3384 /**
3385 * Repaints the specified rectangle of this component.
3386 * <p>
3387 * If this component is a lightweight component, this method
3388 * causes a call to this component's <code>paint</code> method
3389 * as soon as possible. Otherwise, this method causes a call to
3390 * this component's <code>update</code> method as soon as possible.
3391 * <p>
3392 * <b>Note</b>: For more information on the paint mechanisms utilitized
3393 * by AWT and Swing, including information on how to write the most
3394 * efficient painting code, see
3395 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3396 *
3397 * @param x the <i>x</i> coordinate
3398 * @param y the <i>y</i> coordinate
3399 * @param width the width
3400 * @param height the height
3401 * @see #update(Graphics)
3402 * @since 1.0
3403 */
3404 public void repaint(int x, int y, int width, int height) {
3405 repaint(0, x, y, width, height);
3406 }
3407
3408 /**
3409 * Repaints the specified rectangle of this component within
3410 * <code>tm</code> milliseconds.
3411 * <p>
3412 * If this component is a lightweight component, this method causes
3413 * a call to this component's <code>paint</code> method.
3414 * Otherwise, this method causes a call to this component's
3415 * <code>update</code> method.
3416 * <p>
3417 * <b>Note</b>: For more information on the paint mechanisms utilitized
3418 * by AWT and Swing, including information on how to write the most
3419 * efficient painting code, see
3420 * <a href="http://www.oracle.com/technetwork/java/painting-140037.html">Painting in AWT and Swing</a>.
3421 *
3422 * @param tm maximum time in milliseconds before update
3423 * @param x the <i>x</i> coordinate
3424 * @param y the <i>y</i> coordinate
3425 * @param width the width
3426 * @param height the height
3427 * @see #update(Graphics)
3428 * @since 1.0
3429 */
3430 public void repaint(long tm, int x, int y, int width, int height) {
3431 if (this.peer instanceof LightweightPeer) {
3432 // Needs to be translated to parent coordinates since
3433 // a parent native container provides the actual repaint
3434 // services. Additionally, the request is restricted to
3435 // the bounds of the component.
3436 if (parent != null) {
3437 if (x < 0) {
3438 width += x;
3439 x = 0;
3440 }
3441 if (y < 0) {
3442 height += y;
3443 y = 0;
3444 }
3445
3446 int pwidth = (width > this.width) ? this.width : width;
3447 int pheight = (height > this.height) ? this.height : height;
3448
3449 if (pwidth <= 0 || pheight <= 0) {
3450 return;
3451 }
3452
3453 int px = this.x + x;
3454 int py = this.y + y;
3455 parent.repaint(tm, px, py, pwidth, pheight);
3456 }
3457 } else {
3458 if (isVisible() && (this.peer != null) &&
3459 (width > 0) && (height > 0)) {
3460 PaintEvent e = new PaintEvent(this, PaintEvent.UPDATE,
3461 new Rectangle(x, y, width, height));
3462 SunToolkit.postEvent(SunToolkit.targetToAppContext(this), e);
3463 }
3464 }
3465 }
3466
3467 /**
3468 * Prints this component. Applications should override this method
3469 * for components that must do special processing before being
3470 * printed or should be printed differently than they are painted.
3471 * <p>
3472 * The default implementation of this method calls the
3473 * <code>paint</code> method.
3474 * <p>
3475 * The origin of the graphics context, its
3476 * (<code>0</code>, <code>0</code>) coordinate point, is the
3477 * top-left corner of this component. The clipping region of the
3478 * graphics context is the bounding rectangle of this component.
3479 * @param g the graphics context to use for printing
3480 * @see #paint(Graphics)
3481 * @since 1.0
3482 */
3483 public void print(Graphics g) {
3484 paint(g);
3485 }
3486
3487 /**
3488 * Prints this component and all of its subcomponents.
3489 * <p>
3490 * The origin of the graphics context, its
3491 * (<code>0</code>, <code>0</code>) coordinate point, is the
3492 * top-left corner of this component. The clipping region of the
3493 * graphics context is the bounding rectangle of this component.
3494 * @param g the graphics context to use for printing
3495 * @see #print(Graphics)
3496 * @since 1.0
3497 */
3498 public void printAll(Graphics g) {
3499 if (isShowing()) {
3500 GraphicsCallback.PeerPrintCallback.getInstance().
3501 runOneComponent(this, new Rectangle(0, 0, width, height),
3502 g, g.getClip(),
3503 GraphicsCallback.LIGHTWEIGHTS |
3504 GraphicsCallback.HEAVYWEIGHTS);
3505 }
3506 }
3507
3508 /**
3509 * Simulates the peer callbacks into java.awt for printing of
3510 * lightweight Components.
3511 * @param g the graphics context to use for printing
3512 * @see #printAll
3513 */
3514 void lightweightPrint(Graphics g) {
3515 print(g);
3516 }
3517
3518 /**
3519 * Prints all the heavyweight subcomponents.
3520 */
3521 void printHeavyweightComponents(Graphics g) {
3522 }
3523
3524 private Insets getInsets_NoClientCode() {
3525 ComponentPeer peer = this.peer;
3526 if (peer instanceof ContainerPeer) {
3527 return (Insets)((ContainerPeer)peer).getInsets().clone();
3528 }
3529 return new Insets(0, 0, 0, 0);
3530 }
3531
3532 /**
3533 * Repaints the component when the image has changed.
3534 * This <code>imageUpdate</code> method of an <code>ImageObserver</code>
3535 * is called when more information about an
3536 * image which had been previously requested using an asynchronous
3537 * routine such as the <code>drawImage</code> method of
3538 * <code>Graphics</code> becomes available.
3539 * See the definition of <code>imageUpdate</code> for
3540 * more information on this method and its arguments.
3541 * <p>
3542 * The <code>imageUpdate</code> method of <code>Component</code>
3543 * incrementally draws an image on the component as more of the bits
3544 * of the image are available.
3545 * <p>
3546 * If the system property <code>awt.image.incrementaldraw</code>
3547 * is missing or has the value <code>true</code>, the image is
3548 * incrementally drawn. If the system property has any other value,
3549 * then the image is not drawn until it has been completely loaded.
3550 * <p>
3551 * Also, if incremental drawing is in effect, the value of the
3552 * system property <code>awt.image.redrawrate</code> is interpreted
3553 * as an integer to give the maximum redraw rate, in milliseconds. If
3554 * the system property is missing or cannot be interpreted as an
3555 * integer, the redraw rate is once every 100ms.
3556 * <p>
3557 * The interpretation of the <code>x</code>, <code>y</code>,
3558 * <code>width</code>, and <code>height</code> arguments depends on
3559 * the value of the <code>infoflags</code> argument.
3560 *
3561 * @param img the image being observed
3562 * @param infoflags see <code>imageUpdate</code> for more information
3563 * @param x the <i>x</i> coordinate
3564 * @param y the <i>y</i> coordinate
3565 * @param w the width
3566 * @param h the height
3567 * @return <code>false</code> if the infoflags indicate that the
3568 * image is completely loaded; <code>true</code> otherwise.
3569 *
3570 * @see java.awt.image.ImageObserver
3571 * @see Graphics#drawImage(Image, int, int, Color, java.awt.image.ImageObserver)
3572 * @see Graphics#drawImage(Image, int, int, java.awt.image.ImageObserver)
3573 * @see Graphics#drawImage(Image, int, int, int, int, Color, java.awt.image.ImageObserver)
3574 * @see Graphics#drawImage(Image, int, int, int, int, java.awt.image.ImageObserver)
3575 * @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
3576 * @since 1.0
3577 */
3578 public boolean imageUpdate(Image img, int infoflags,
3579 int x, int y, int w, int h) {
3580 int rate = -1;
3581 if ((infoflags & (FRAMEBITS|ALLBITS)) != 0) {
3582 rate = 0;
3583 } else if ((infoflags & SOMEBITS) != 0) {
3584 if (isInc) {
3585 rate = incRate;
3586 if (rate < 0) {
3587 rate = 0;
3588 }
3589 }
3590 }
3591 if (rate >= 0) {
3592 repaint(rate, 0, 0, width, height);
3593 }
3594 return (infoflags & (ALLBITS|ABORT)) == 0;
3595 }
3596
3597 /**
3598 * Creates an image from the specified image producer.
3599 * @param producer the image producer
3600 * @return the image produced
3601 * @since 1.0
3602 */
3603 public Image createImage(ImageProducer producer) {
3604 ComponentPeer peer = this.peer;
3605 if ((peer != null) && ! (peer instanceof LightweightPeer)) {
3606 return peer.createImage(producer);
3607 }
3608 return getToolkit().createImage(producer);
3609 }
3610
3611 /**
3612 * Creates an off-screen drawable image
3613 * to be used for double buffering.
3614 * @param width the specified width
3615 * @param height the specified height
3616 * @return an off-screen drawable image, which can be used for double
3617 * buffering. The return value may be <code>null</code> if the
3618 * component is not displayable. This will always happen if
3619 * <code>GraphicsEnvironment.isHeadless()</code> returns
3620 * <code>true</code>.
3621 * @see #isDisplayable
3622 * @see GraphicsEnvironment#isHeadless
3623 * @since 1.0
3624 */
3625 public Image createImage(int width, int height) {
3626 ComponentPeer peer = this.peer;
3627 if (peer instanceof LightweightPeer) {
3628 if (parent != null) { return parent.createImage(width, height); }
3629 else { return null;}
3630 } else {
3631 return (peer != null) ? peer.createImage(width, height) : null;
3632 }
3633 }
3634
3635 /**
3636 * Creates a volatile off-screen drawable image
3637 * to be used for double buffering.
3638 * @param width the specified width.
3639 * @param height the specified height.
3640 * @return an off-screen drawable image, which can be used for double
3641 * buffering. The return value may be <code>null</code> if the
3642 * component is not displayable. This will always happen if
3643 * <code>GraphicsEnvironment.isHeadless()</code> returns
3644 * <code>true</code>.
3645 * @see java.awt.image.VolatileImage
3646 * @see #isDisplayable
3647 * @see GraphicsEnvironment#isHeadless
3648 * @since 1.4
3649 */
3650 public VolatileImage createVolatileImage(int width, int height) {
3651 ComponentPeer peer = this.peer;
3652 if (peer instanceof LightweightPeer) {
3653 if (parent != null) {
3654 return parent.createVolatileImage(width, height);
3655 }
3656 else { return null;}
3657 } else {
3658 return (peer != null) ?
3659 peer.createVolatileImage(width, height) : null;
3660 }
3661 }
3662
3663 /**
3664 * Creates a volatile off-screen drawable image, with the given capabilities.
3665 * The contents of this image may be lost at any time due
3666 * to operating system issues, so the image must be managed
3667 * via the <code>VolatileImage</code> interface.
3668 * @param width the specified width.
3669 * @param height the specified height.
3670 * @param caps the image capabilities
3671 * @exception AWTException if an image with the specified capabilities cannot
3672 * be created
3673 * @return a VolatileImage object, which can be used
3674 * to manage surface contents loss and capabilities.
3675 * @see java.awt.image.VolatileImage
3676 * @since 1.4
3677 */
3678 public VolatileImage createVolatileImage(int width, int height,
3679 ImageCapabilities caps) throws AWTException {
3680 // REMIND : check caps
3681 return createVolatileImage(width, height);
3682 }
3683
3684 /**
3685 * Prepares an image for rendering on this component. The image
3686 * data is downloaded asynchronously in another thread and the
3687 * appropriate screen representation of the image is generated.
3688 * @param image the <code>Image</code> for which to
3689 * prepare a screen representation
3690 * @param observer the <code>ImageObserver</code> object
3691 * to be notified as the image is being prepared
3692 * @return <code>true</code> if the image has already been fully
3693 * prepared; <code>false</code> otherwise
3694 * @since 1.0
3695 */
3696 public boolean prepareImage(Image image, ImageObserver observer) {
3697 return prepareImage(image, -1, -1, observer);
3698 }
3699
3700 /**
3701 * Prepares an image for rendering on this component at the
3702 * specified width and height.
3703 * <p>
3704 * The image data is downloaded asynchronously in another thread,
3705 * and an appropriately scaled screen representation of the image is
3706 * generated.
3707 * @param image the instance of <code>Image</code>
3708 * for which to prepare a screen representation
3709 * @param width the width of the desired screen representation
3710 * @param height the height of the desired screen representation
3711 * @param observer the <code>ImageObserver</code> object
3712 * to be notified as the image is being prepared
3713 * @return <code>true</code> if the image has already been fully
3714 * prepared; <code>false</code> otherwise
3715 * @see java.awt.image.ImageObserver
3716 * @since 1.0
3717 */
3718 public boolean prepareImage(Image image, int width, int height,
3719 ImageObserver observer) {
3720 ComponentPeer peer = this.peer;
3721 if (peer instanceof LightweightPeer) {
3722 return (parent != null)
3723 ? parent.prepareImage(image, width, height, observer)
3724 : getToolkit().prepareImage(image, width, height, observer);
3725 } else {
3726 return (peer != null)
3727 ? peer.prepareImage(image, width, height, observer)
3728 : getToolkit().prepareImage(image, width, height, observer);
3729 }
3730 }
3731
3732 /**
3733 * Returns the status of the construction of a screen representation
3734 * of the specified image.
3735 * <p>
3736 * This method does not cause the image to begin loading. An
3737 * application must use the <code>prepareImage</code> method
3738 * to force the loading of an image.
3739 * <p>
3740 * Information on the flags returned by this method can be found
3741 * with the discussion of the <code>ImageObserver</code> interface.
3742 * @param image the <code>Image</code> object whose status
3743 * is being checked
3744 * @param observer the <code>ImageObserver</code>
3745 * object to be notified as the image is being prepared
3746 * @return the bitwise inclusive <b>OR</b> of
3747 * <code>ImageObserver</code> flags indicating what
3748 * information about the image is currently available
3749 * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver)
3750 * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver)
3751 * @see java.awt.image.ImageObserver
3752 * @since 1.0
3753 */
3754 public int checkImage(Image image, ImageObserver observer) {
3755 return checkImage(image, -1, -1, observer);
3756 }
3757
3758 /**
3759 * Returns the status of the construction of a screen representation
3760 * of the specified image.
3761 * <p>
3762 * This method does not cause the image to begin loading. An
3763 * application must use the <code>prepareImage</code> method
3764 * to force the loading of an image.
3765 * <p>
3766 * The <code>checkImage</code> method of <code>Component</code>
3767 * calls its peer's <code>checkImage</code> method to calculate
3768 * the flags. If this component does not yet have a peer, the
3769 * component's toolkit's <code>checkImage</code> method is called
3770 * instead.
3771 * <p>
3772 * Information on the flags returned by this method can be found
3773 * with the discussion of the <code>ImageObserver</code> interface.
3774 * @param image the <code>Image</code> object whose status
3775 * is being checked
3776 * @param width the width of the scaled version
3777 * whose status is to be checked
3778 * @param height the height of the scaled version
3779 * whose status is to be checked
3780 * @param observer the <code>ImageObserver</code> object
3781 * to be notified as the image is being prepared
3782 * @return the bitwise inclusive <b>OR</b> of
3783 * <code>ImageObserver</code> flags indicating what
3784 * information about the image is currently available
3785 * @see #prepareImage(Image, int, int, java.awt.image.ImageObserver)
3786 * @see Toolkit#checkImage(Image, int, int, java.awt.image.ImageObserver)
3787 * @see java.awt.image.ImageObserver
3788 * @since 1.0
3789 */
3790 public int checkImage(Image image, int width, int height,
3791 ImageObserver observer) {
3792 ComponentPeer peer = this.peer;
3793 if (peer instanceof LightweightPeer) {
3794 return (parent != null)
3795 ? parent.checkImage(image, width, height, observer)
3796 : getToolkit().checkImage(image, width, height, observer);
3797 } else {
3798 return (peer != null)
3799 ? peer.checkImage(image, width, height, observer)
3800 : getToolkit().checkImage(image, width, height, observer);
3801 }
3802 }
3803
3804 /**
3805 * Creates a new strategy for multi-buffering on this component.
3806 * Multi-buffering is useful for rendering performance. This method
3807 * attempts to create the best strategy available with the number of
3808 * buffers supplied. It will always create a <code>BufferStrategy</code>
3809 * with that number of buffers.
3810 * A page-flipping strategy is attempted first, then a blitting strategy
3811 * using accelerated buffers. Finally, an unaccelerated blitting
3812 * strategy is used.
3813 * <p>
3814 * Each time this method is called,
3815 * the existing buffer strategy for this component is discarded.
3816 * @param numBuffers number of buffers to create, including the front buffer
3817 * @exception IllegalArgumentException if numBuffers is less than 1.
3818 * @exception IllegalStateException if the component is not displayable
3819 * @see #isDisplayable
3820 * @see Window#getBufferStrategy()
3821 * @see Canvas#getBufferStrategy()
3822 * @since 1.4
3823 */
3824 void createBufferStrategy(int numBuffers) {
3825 BufferCapabilities bufferCaps;
3826 if (numBuffers > 1) {
3827 // Try to create a page-flipping strategy
3828 bufferCaps = new BufferCapabilities(new ImageCapabilities(true),
3829 new ImageCapabilities(true),
3830 BufferCapabilities.FlipContents.UNDEFINED);
3831 try {
3832 createBufferStrategy(numBuffers, bufferCaps);
3833 return; // Success
3834 } catch (AWTException e) {
3835 // Failed
3836 }
3837 }
3838 // Try a blitting (but still accelerated) strategy
3839 bufferCaps = new BufferCapabilities(new ImageCapabilities(true),
3840 new ImageCapabilities(true),
3841 null);
3842 try {
3843 createBufferStrategy(numBuffers, bufferCaps);
3844 return; // Success
3845 } catch (AWTException e) {
3846 // Failed
3847 }
3848 // Try an unaccelerated blitting strategy
3849 bufferCaps = new BufferCapabilities(new ImageCapabilities(false),
3850 new ImageCapabilities(false),
3851 null);
3852 try {
3853 createBufferStrategy(numBuffers, bufferCaps);
3854 return; // Success
3855 } catch (AWTException e) {
3856 // Code should never reach here (an unaccelerated blitting
3857 // strategy should always work)
3858 throw new InternalError("Could not create a buffer strategy", e);
3859 }
3860 }
3861
3862 /**
3863 * Creates a new strategy for multi-buffering on this component with the
3864 * required buffer capabilities. This is useful, for example, if only
3865 * accelerated memory or page flipping is desired (as specified by the
3866 * buffer capabilities).
3867 * <p>
3868 * Each time this method
3869 * is called, <code>dispose</code> will be invoked on the existing
3870 * <code>BufferStrategy</code>.
3871 * @param numBuffers number of buffers to create
3872 * @param caps the required capabilities for creating the buffer strategy;
3873 * cannot be <code>null</code>
3874 * @exception AWTException if the capabilities supplied could not be
3875 * supported or met; this may happen, for example, if there is not enough
3876 * accelerated memory currently available, or if page flipping is specified
3877 * but not possible.
3878 * @exception IllegalArgumentException if numBuffers is less than 1, or if
3879 * caps is <code>null</code>
3880 * @see Window#getBufferStrategy()
3881 * @see Canvas#getBufferStrategy()
3882 * @since 1.4
3883 */
3884 void createBufferStrategy(int numBuffers,
3885 BufferCapabilities caps) throws AWTException {
3886 // Check arguments
3887 if (numBuffers < 1) {
3888 throw new IllegalArgumentException(
3889 "Number of buffers must be at least 1");
3890 }
3891 if (caps == null) {
3892 throw new IllegalArgumentException("No capabilities specified");
3893 }
3894 // Destroy old buffers
3895 if (bufferStrategy != null) {
3896 bufferStrategy.dispose();
3897 }
3898 if (numBuffers == 1) {
3899 bufferStrategy = new SingleBufferStrategy(caps);
3900 } else {
3901 SunGraphicsEnvironment sge = (SunGraphicsEnvironment)
3902 GraphicsEnvironment.getLocalGraphicsEnvironment();
3903 if (!caps.isPageFlipping() && sge.isFlipStrategyPreferred(peer)) {
3904 caps = new ProxyCapabilities(caps);
3905 }
3906 // assert numBuffers > 1;
3907 if (caps.isPageFlipping()) {
3908 bufferStrategy = new FlipSubRegionBufferStrategy(numBuffers, caps);
3909 } else {
3910 bufferStrategy = new BltSubRegionBufferStrategy(numBuffers, caps);
3911 }
3912 }
3913 }
3914
3915 /**
3916 * This is a proxy capabilities class used when a FlipBufferStrategy
3917 * is created instead of the requested Blit strategy.
3918 *
3919 * @see sun.java2d.SunGraphicsEnvironment#isFlipStrategyPreferred(ComponentPeer)
3920 */
3921 private class ProxyCapabilities extends ExtendedBufferCapabilities {
3922 private BufferCapabilities orig;
3923 private ProxyCapabilities(BufferCapabilities orig) {
3924 super(orig.getFrontBufferCapabilities(),
3925 orig.getBackBufferCapabilities(),
3926 orig.getFlipContents() ==
3927 BufferCapabilities.FlipContents.BACKGROUND ?
3928 BufferCapabilities.FlipContents.BACKGROUND :
3929 BufferCapabilities.FlipContents.COPIED);
3930 this.orig = orig;
3931 }
3932 }
3933
3934 /**
3935 * @return the buffer strategy used by this component
3936 * @see Window#createBufferStrategy
3937 * @see Canvas#createBufferStrategy
3938 * @since 1.4
3939 */
3940 BufferStrategy getBufferStrategy() {
3941 return bufferStrategy;
3942 }
3943
3944 /**
3945 * @return the back buffer currently used by this component's
3946 * BufferStrategy. If there is no BufferStrategy or no
3947 * back buffer, this method returns null.
3948 */
3949 Image getBackBuffer() {
3950 if (bufferStrategy != null) {
3951 if (bufferStrategy instanceof BltBufferStrategy) {
3952 BltBufferStrategy bltBS = (BltBufferStrategy)bufferStrategy;
3953 return bltBS.getBackBuffer();
3954 } else if (bufferStrategy instanceof FlipBufferStrategy) {
3955 FlipBufferStrategy flipBS = (FlipBufferStrategy)bufferStrategy;
3956 return flipBS.getBackBuffer();
3957 }
3958 }
3959 return null;
3960 }
3961
3962 /**
3963 * Inner class for flipping buffers on a component. That component must
3964 * be a <code>Canvas</code> or <code>Window</code>.
3965 * @see Canvas
3966 * @see Window
3967 * @see java.awt.image.BufferStrategy
3968 * @author Michael Martak
3969 * @since 1.4
3970 */
3971 protected class FlipBufferStrategy extends BufferStrategy {
3972 /**
3973 * The number of buffers
3974 */
3975 protected int numBuffers; // = 0
3976 /**
3977 * The buffering capabilities
3978 */
3979 protected BufferCapabilities caps; // = null
3980 /**
3981 * The drawing buffer
3982 */
3983 protected Image drawBuffer; // = null
3984 /**
3985 * The drawing buffer as a volatile image
3986 */
3987 protected VolatileImage drawVBuffer; // = null
3988 /**
3989 * Whether or not the drawing buffer has been recently restored from
3990 * a lost state.
3991 */
3992 protected boolean validatedContents; // = false
3993
3994 /**
3995 * Size of the back buffers. (Note: these fields were added in 6.0
3996 * but kept package-private to avoid exposing them in the spec.
3997 * None of these fields/methods really should have been marked
3998 * protected when they were introduced in 1.4, but now we just have
3999 * to live with that decision.)
4000 */
4001
4002 /**
4003 * The width of the back buffers
4004 */
4005 int width;
4006
4007 /**
4008 * The height of the back buffers
4009 */
4010 int height;
4011
4012 /**
4013 * Creates a new flipping buffer strategy for this component.
4014 * The component must be a <code>Canvas</code> or <code>Window</code>.
4015 * @see Canvas
4016 * @see Window
4017 * @param numBuffers the number of buffers
4018 * @param caps the capabilities of the buffers
4019 * @exception AWTException if the capabilities supplied could not be
4020 * supported or met
4021 * @exception ClassCastException if the component is not a canvas or
4022 * window.
4023 * @exception IllegalStateException if the component has no peer
4024 * @exception IllegalArgumentException if {@code numBuffers} is less than two,
4025 * or if {@code BufferCapabilities.isPageFlipping} is not
4026 * {@code true}.
4027 * @see #createBuffers(int, BufferCapabilities)
4028 */
4029 protected FlipBufferStrategy(int numBuffers, BufferCapabilities caps)
4030 throws AWTException
4031 {
4032 if (!(Component.this instanceof Window) &&
4033 !(Component.this instanceof Canvas))
4034 {
4035 throw new ClassCastException(
4036 "Component must be a Canvas or Window");
4037 }
4038 this.numBuffers = numBuffers;
4039 this.caps = caps;
4040 createBuffers(numBuffers, caps);
4041 }
4042
4043 /**
4044 * Creates one or more complex, flipping buffers with the given
4045 * capabilities.
4046 * @param numBuffers number of buffers to create; must be greater than
4047 * one
4048 * @param caps the capabilities of the buffers.
4049 * <code>BufferCapabilities.isPageFlipping</code> must be
4050 * <code>true</code>.
4051 * @exception AWTException if the capabilities supplied could not be
4052 * supported or met
4053 * @exception IllegalStateException if the component has no peer
4054 * @exception IllegalArgumentException if numBuffers is less than two,
4055 * or if <code>BufferCapabilities.isPageFlipping</code> is not
4056 * <code>true</code>.
4057 * @see java.awt.BufferCapabilities#isPageFlipping()
4058 */
4059 protected void createBuffers(int numBuffers, BufferCapabilities caps)
4060 throws AWTException
4061 {
4062 if (numBuffers < 2) {
4063 throw new IllegalArgumentException(
4064 "Number of buffers cannot be less than two");
4065 } else if (peer == null) {
4066 throw new IllegalStateException(
4067 "Component must have a valid peer");
4068 } else if (caps == null || !caps.isPageFlipping()) {
4069 throw new IllegalArgumentException(
4070 "Page flipping capabilities must be specified");
4071 }
4072
4073 // save the current bounds
4074 width = getWidth();
4075 height = getHeight();
4076
4077 if (drawBuffer != null) {
4078 // dispose the existing backbuffers
4079 drawBuffer = null;
4080 drawVBuffer = null;
4081 destroyBuffers();
4082 // ... then recreate the backbuffers
4083 }
4084
4085 if (caps instanceof ExtendedBufferCapabilities) {
4086 ExtendedBufferCapabilities ebc =
4087 (ExtendedBufferCapabilities)caps;
4088 if (ebc.getVSync() == VSYNC_ON) {
4089 // if this buffer strategy is not allowed to be v-synced,
4090 // change the caps that we pass to the peer but keep on
4091 // trying to create v-synced buffers;
4092 // do not throw IAE here in case it is disallowed, see
4093 // ExtendedBufferCapabilities for more info
4094 if (!VSyncedBSManager.vsyncAllowed(this)) {
4095 caps = ebc.derive(VSYNC_DEFAULT);
4096 }
4097 }
4098 }
4099
4100 peer.createBuffers(numBuffers, caps);
4101 updateInternalBuffers();
4102 }
4103
4104 /**
4105 * Updates internal buffers (both volatile and non-volatile)
4106 * by requesting the back-buffer from the peer.
4107 */
4108 private void updateInternalBuffers() {
4109 // get the images associated with the draw buffer
4110 drawBuffer = getBackBuffer();
4111 if (drawBuffer instanceof VolatileImage) {
4112 drawVBuffer = (VolatileImage)drawBuffer;
4113 } else {
4114 drawVBuffer = null;
4115 }
4116 }
4117
4118 /**
4119 * @return direct access to the back buffer, as an image.
4120 * @exception IllegalStateException if the buffers have not yet
4121 * been created
4122 */
4123 protected Image getBackBuffer() {
4124 if (peer != null) {
4125 return peer.getBackBuffer();
4126 } else {
4127 throw new IllegalStateException(
4128 "Component must have a valid peer");
4129 }
4130 }
4131
4132 /**
4133 * Flipping moves the contents of the back buffer to the front buffer,
4134 * either by copying or by moving the video pointer.
4135 * @param flipAction an integer value describing the flipping action
4136 * for the contents of the back buffer. This should be one of the
4137 * values of the <code>BufferCapabilities.FlipContents</code>
4138 * property.
4139 * @exception IllegalStateException if the buffers have not yet
4140 * been created
4141 * @see java.awt.BufferCapabilities#getFlipContents()
4142 */
4143 protected void flip(BufferCapabilities.FlipContents flipAction) {
4144 if (peer != null) {
4145 Image backBuffer = getBackBuffer();
4146 if (backBuffer != null) {
4147 peer.flip(0, 0,
4148 backBuffer.getWidth(null),
4149 backBuffer.getHeight(null), flipAction);
4150 }
4151 } else {
4152 throw new IllegalStateException(
4153 "Component must have a valid peer");
4154 }
4155 }
4156
4157 void flipSubRegion(int x1, int y1, int x2, int y2,
4158 BufferCapabilities.FlipContents flipAction)
4159 {
4160 if (peer != null) {
4161 peer.flip(x1, y1, x2, y2, flipAction);
4162 } else {
4163 throw new IllegalStateException(
4164 "Component must have a valid peer");
4165 }
4166 }
4167
4168 /**
4169 * Destroys the buffers created through this object
4170 */
4171 protected void destroyBuffers() {
4172 VSyncedBSManager.releaseVsync(this);
4173 if (peer != null) {
4174 peer.destroyBuffers();
4175 } else {
4176 throw new IllegalStateException(
4177 "Component must have a valid peer");
4178 }
4179 }
4180
4181 /**
4182 * @return the buffering capabilities of this strategy
4183 */
4184 public BufferCapabilities getCapabilities() {
4185 if (caps instanceof ProxyCapabilities) {
4186 return ((ProxyCapabilities)caps).orig;
4187 } else {
4188 return caps;
4189 }
4190 }
4191
4192 /**
4193 * @return the graphics on the drawing buffer. This method may not
4194 * be synchronized for performance reasons; use of this method by multiple
4195 * threads should be handled at the application level. Disposal of the
4196 * graphics object must be handled by the application.
4197 */
4198 public Graphics getDrawGraphics() {
4199 revalidate();
4200 return drawBuffer.getGraphics();
4201 }
4202
4203 /**
4204 * Restore the drawing buffer if it has been lost
4205 */
4206 protected void revalidate() {
4207 revalidate(true);
4208 }
4209
4210 void revalidate(boolean checkSize) {
4211 validatedContents = false;
4212
4213 if (checkSize && (getWidth() != width || getHeight() != height)) {
4214 // component has been resized; recreate the backbuffers
4215 try {
4216 createBuffers(numBuffers, caps);
4217 } catch (AWTException e) {
4218 // shouldn't be possible
4219 }
4220 validatedContents = true;
4221 }
4222
4223 // get the buffers from the peer every time since they
4224 // might have been replaced in response to a display change event
4225 updateInternalBuffers();
4226
4227 // now validate the backbuffer
4228 if (drawVBuffer != null) {
4229 GraphicsConfiguration gc =
4230 getGraphicsConfiguration_NoClientCode();
4231 int returnCode = drawVBuffer.validate(gc);
4232 if (returnCode == VolatileImage.IMAGE_INCOMPATIBLE) {
4233 try {
4234 createBuffers(numBuffers, caps);
4235 } catch (AWTException e) {
4236 // shouldn't be possible
4237 }
4238 if (drawVBuffer != null) {
4239 // backbuffers were recreated, so validate again
4240 drawVBuffer.validate(gc);
4241 }
4242 validatedContents = true;
4243 } else if (returnCode == VolatileImage.IMAGE_RESTORED) {
4244 validatedContents = true;
4245 }
4246 }
4247 }
4248
4249 /**
4250 * @return whether the drawing buffer was lost since the last call to
4251 * <code>getDrawGraphics</code>
4252 */
4253 public boolean contentsLost() {
4254 if (drawVBuffer == null) {
4255 return false;
4256 }
4257 return drawVBuffer.contentsLost();
4258 }
4259
4260 /**
4261 * @return whether the drawing buffer was recently restored from a lost
4262 * state and reinitialized to the default background color (white)
4263 */
4264 public boolean contentsRestored() {
4265 return validatedContents;
4266 }
4267
4268 /**
4269 * Makes the next available buffer visible by either blitting or
4270 * flipping.
4271 */
4272 public void show() {
4273 flip(caps.getFlipContents());
4274 }
4275
4276 /**
4277 * Makes specified region of the next available buffer visible
4278 * by either blitting or flipping.
4279 */
4280 void showSubRegion(int x1, int y1, int x2, int y2) {
4281 flipSubRegion(x1, y1, x2, y2, caps.getFlipContents());
4282 }
4283
4284 /**
4285 * {@inheritDoc}
4286 * @since 1.6
4287 */
4288 public void dispose() {
4289 if (Component.this.bufferStrategy == this) {
4290 Component.this.bufferStrategy = null;
4291 if (peer != null) {
4292 destroyBuffers();
4293 }
4294 }
4295 }
4296
4297 } // Inner class FlipBufferStrategy
4298
4299 /**
4300 * Inner class for blitting offscreen surfaces to a component.
4301 *
4302 * @author Michael Martak
4303 * @since 1.4
4304 */
4305 protected class BltBufferStrategy extends BufferStrategy {
4306
4307 /**
4308 * The buffering capabilities
4309 */
4310 protected BufferCapabilities caps; // = null
4311 /**
4312 * The back buffers
4313 */
4314 protected VolatileImage[] backBuffers; // = null
4315 /**
4316 * Whether or not the drawing buffer has been recently restored from
4317 * a lost state.
4318 */
4319 protected boolean validatedContents; // = false
4320 /**
4321 * Width of the back buffers
4322 */
4323 protected int width;
4324 /**
4325 * Height of the back buffers
4326 */
4327 protected int height;
4328
4329 /**
4330 * Insets for the hosting Component. The size of the back buffer
4331 * is constrained by these.
4332 */
4333 private Insets insets;
4334
4335 /**
4336 * Creates a new blt buffer strategy around a component
4337 * @param numBuffers number of buffers to create, including the
4338 * front buffer
4339 * @param caps the capabilities of the buffers
4340 */
4341 protected BltBufferStrategy(int numBuffers, BufferCapabilities caps) {
4342 this.caps = caps;
4343 createBackBuffers(numBuffers - 1);
4344 }
4345
4346 /**
4347 * {@inheritDoc}
4348 * @since 1.6
4349 */
4350 public void dispose() {
4351 if (backBuffers != null) {
4352 for (int counter = backBuffers.length - 1; counter >= 0;
4353 counter--) {
4354 if (backBuffers[counter] != null) {
4355 backBuffers[counter].flush();
4356 backBuffers[counter] = null;
4357 }
4358 }
4359 }
4360 if (Component.this.bufferStrategy == this) {
4361 Component.this.bufferStrategy = null;
4362 }
4363 }
4364
4365 /**
4366 * Creates the back buffers
4367 *
4368 * @param numBuffers the number of buffers to create
4369 */
4370 protected void createBackBuffers(int numBuffers) {
4371 if (numBuffers == 0) {
4372 backBuffers = null;
4373 } else {
4374 // save the current bounds
4375 width = getWidth();
4376 height = getHeight();
4377 insets = getInsets_NoClientCode();
4378 int iWidth = width - insets.left - insets.right;
4379 int iHeight = height - insets.top - insets.bottom;
4380
4381 // It is possible for the component's width and/or height
4382 // to be 0 here. Force the size of the backbuffers to
4383 // be > 0 so that creating the image won't fail.
4384 iWidth = Math.max(1, iWidth);
4385 iHeight = Math.max(1, iHeight);
4386 if (backBuffers == null) {
4387 backBuffers = new VolatileImage[numBuffers];
4388 } else {
4389 // flush any existing backbuffers
4390 for (int i = 0; i < numBuffers; i++) {
4391 if (backBuffers[i] != null) {
4392 backBuffers[i].flush();
4393 backBuffers[i] = null;
4394 }
4395 }
4396 }
4397
4398 // create the backbuffers
4399 for (int i = 0; i < numBuffers; i++) {
4400 backBuffers[i] = createVolatileImage(iWidth, iHeight);
4401 }
4402 }
4403 }
4404
4405 /**
4406 * @return the buffering capabilities of this strategy
4407 */
4408 public BufferCapabilities getCapabilities() {
4409 return caps;
4410 }
4411
4412 /**
4413 * @return the draw graphics
4414 */
4415 public Graphics getDrawGraphics() {
4416 revalidate();
4417 Image backBuffer = getBackBuffer();
4418 if (backBuffer == null) {
4419 return getGraphics();
4420 }
4421 SunGraphics2D g = (SunGraphics2D)backBuffer.getGraphics();
4422 g.constrain(-insets.left, -insets.top,
4423 backBuffer.getWidth(null) + insets.left,
4424 backBuffer.getHeight(null) + insets.top);
4425 return g;
4426 }
4427
4428 /**
4429 * @return direct access to the back buffer, as an image.
4430 * If there is no back buffer, returns null.
4431 */
4432 Image getBackBuffer() {
4433 if (backBuffers != null) {
4434 return backBuffers[backBuffers.length - 1];
4435 } else {
4436 return null;
4437 }
4438 }
4439
4440 /**
4441 * Makes the next available buffer visible.
4442 */
4443 public void show() {
4444 showSubRegion(insets.left, insets.top,
4445 width - insets.right,
4446 height - insets.bottom);
4447 }
4448
4449 /**
4450 * Package-private method to present a specific rectangular area
4451 * of this buffer. This class currently shows only the entire
4452 * buffer, by calling showSubRegion() with the full dimensions of
4453 * the buffer. Subclasses (e.g., BltSubRegionBufferStrategy
4454 * and FlipSubRegionBufferStrategy) may have region-specific show
4455 * methods that call this method with actual sub regions of the
4456 * buffer.
4457 */
4458 void showSubRegion(int x1, int y1, int x2, int y2) {
4459 if (backBuffers == null) {
4460 return;
4461 }
4462 // Adjust location to be relative to client area.
4463 x1 -= insets.left;
4464 x2 -= insets.left;
4465 y1 -= insets.top;
4466 y2 -= insets.top;
4467 Graphics g = getGraphics_NoClientCode();
4468 if (g == null) {
4469 // Not showing, bail
4470 return;
4471 }
4472 try {
4473 // First image copy is in terms of Frame's coordinates, need
4474 // to translate to client area.
4475 g.translate(insets.left, insets.top);
4476 for (int i = 0; i < backBuffers.length; i++) {
4477 g.drawImage(backBuffers[i],
4478 x1, y1, x2, y2,
4479 x1, y1, x2, y2,
4480 null);
4481 g.dispose();
4482 g = null;
4483 g = backBuffers[i].getGraphics();
4484 }
4485 } finally {
4486 if (g != null) {
4487 g.dispose();
4488 }
4489 }
4490 }
4491
4492 /**
4493 * Restore the drawing buffer if it has been lost
4494 */
4495 protected void revalidate() {
4496 revalidate(true);
4497 }
4498
4499 void revalidate(boolean checkSize) {
4500 validatedContents = false;
4501
4502 if (backBuffers == null) {
4503 return;
4504 }
4505
4506 if (checkSize) {
4507 Insets insets = getInsets_NoClientCode();
4508 if (getWidth() != width || getHeight() != height ||
4509 !insets.equals(this.insets)) {
4510 // component has been resized; recreate the backbuffers
4511 createBackBuffers(backBuffers.length);
4512 validatedContents = true;
4513 }
4514 }
4515
4516 // now validate the backbuffer
4517 GraphicsConfiguration gc = getGraphicsConfiguration_NoClientCode();
4518 int returnCode =
4519 backBuffers[backBuffers.length - 1].validate(gc);
4520 if (returnCode == VolatileImage.IMAGE_INCOMPATIBLE) {
4521 if (checkSize) {
4522 createBackBuffers(backBuffers.length);
4523 // backbuffers were recreated, so validate again
4524 backBuffers[backBuffers.length - 1].validate(gc);
4525 }
4526 // else case means we're called from Swing on the toolkit
4527 // thread, don't recreate buffers as that'll deadlock
4528 // (creating VolatileImages invokes getting GraphicsConfig
4529 // which grabs treelock).
4530 validatedContents = true;
4531 } else if (returnCode == VolatileImage.IMAGE_RESTORED) {
4532 validatedContents = true;
4533 }
4534 }
4535
4536 /**
4537 * @return whether the drawing buffer was lost since the last call to
4538 * <code>getDrawGraphics</code>
4539 */
4540 public boolean contentsLost() {
4541 if (backBuffers == null) {
4542 return false;
4543 } else {
4544 return backBuffers[backBuffers.length - 1].contentsLost();
4545 }
4546 }
4547
4548 /**
4549 * @return whether the drawing buffer was recently restored from a lost
4550 * state and reinitialized to the default background color (white)
4551 */
4552 public boolean contentsRestored() {
4553 return validatedContents;
4554 }
4555 } // Inner class BltBufferStrategy
4556
4557 /**
4558 * Private class to perform sub-region flipping.
4559 */
4560 private class FlipSubRegionBufferStrategy extends FlipBufferStrategy
4561 implements SubRegionShowable
4562 {
4563
4564 protected FlipSubRegionBufferStrategy(int numBuffers,
4565 BufferCapabilities caps)
4566 throws AWTException
4567 {
4568 super(numBuffers, caps);
4569 }
4570
4571 public void show(int x1, int y1, int x2, int y2) {
4572 showSubRegion(x1, y1, x2, y2);
4573 }
4574
4575 // This is invoked by Swing on the toolkit thread.
4576 public boolean showIfNotLost(int x1, int y1, int x2, int y2) {
4577 if (!contentsLost()) {
4578 showSubRegion(x1, y1, x2, y2);
4579 return !contentsLost();
4580 }
4581 return false;
4582 }
4583 }
4584
4585 /**
4586 * Private class to perform sub-region blitting. Swing will use
4587 * this subclass via the SubRegionShowable interface in order to
4588 * copy only the area changed during a repaint.
4589 * See javax.swing.BufferStrategyPaintManager.
4590 */
4591 private class BltSubRegionBufferStrategy extends BltBufferStrategy
4592 implements SubRegionShowable
4593 {
4594
4595 protected BltSubRegionBufferStrategy(int numBuffers,
4596 BufferCapabilities caps)
4597 {
4598 super(numBuffers, caps);
4599 }
4600
4601 public void show(int x1, int y1, int x2, int y2) {
4602 showSubRegion(x1, y1, x2, y2);
4603 }
4604
4605 // This method is called by Swing on the toolkit thread.
4606 public boolean showIfNotLost(int x1, int y1, int x2, int y2) {
4607 if (!contentsLost()) {
4608 showSubRegion(x1, y1, x2, y2);
4609 return !contentsLost();
4610 }
4611 return false;
4612 }
4613 }
4614
4615 /**
4616 * Inner class for flipping buffers on a component. That component must
4617 * be a <code>Canvas</code> or <code>Window</code>.
4618 * @see Canvas
4619 * @see Window
4620 * @see java.awt.image.BufferStrategy
4621 * @author Michael Martak
4622 * @since 1.4
4623 */
4624 private class SingleBufferStrategy extends BufferStrategy {
4625
4626 private BufferCapabilities caps;
4627
4628 public SingleBufferStrategy(BufferCapabilities caps) {
4629 this.caps = caps;
4630 }
4631 public BufferCapabilities getCapabilities() {
4632 return caps;
4633 }
4634 public Graphics getDrawGraphics() {
4635 return getGraphics();
4636 }
4637 public boolean contentsLost() {
4638 return false;
4639 }
4640 public boolean contentsRestored() {
4641 return false;
4642 }
4643 public void show() {
4644 // Do nothing
4645 }
4646 } // Inner class SingleBufferStrategy
4647
4648 /**
4649 * Sets whether or not paint messages received from the operating system
4650 * should be ignored. This does not affect paint events generated in
4651 * software by the AWT, unless they are an immediate response to an
4652 * OS-level paint message.
4653 * <p>
4654 * This is useful, for example, if running under full-screen mode and
4655 * better performance is desired, or if page-flipping is used as the
4656 * buffer strategy.
4657 *
4658 * @param ignoreRepaint {@code true} if the paint messages from the OS
4659 * should be ignored; otherwise {@code false}
4660 *
4661 * @since 1.4
4662 * @see #getIgnoreRepaint
4663 * @see Canvas#createBufferStrategy
4664 * @see Window#createBufferStrategy
4665 * @see java.awt.image.BufferStrategy
4666 * @see GraphicsDevice#setFullScreenWindow
4667 */
4668 public void setIgnoreRepaint(boolean ignoreRepaint) {
4669 this.ignoreRepaint = ignoreRepaint;
4670 }
4671
4672 /**
4673 * @return whether or not paint messages received from the operating system
4674 * should be ignored.
4675 *
4676 * @since 1.4
4677 * @see #setIgnoreRepaint
4678 */
4679 public boolean getIgnoreRepaint() {
4680 return ignoreRepaint;
4681 }
4682
4683 /**
4684 * Checks whether this component "contains" the specified point,
4685 * where <code>x</code> and <code>y</code> are defined to be
4686 * relative to the coordinate system of this component.
4687 *
4688 * @param x the <i>x</i> coordinate of the point
4689 * @param y the <i>y</i> coordinate of the point
4690 * @return {@code true} if the point is within the component;
4691 * otherwise {@code false}
4692 * @see #getComponentAt(int, int)
4693 * @since 1.1
4694 */
4695 public boolean contains(int x, int y) {
4696 return inside(x, y);
4697 }
4698
4699 /**
4700 * Checks whether the point is inside of this component.
4701 *
4702 * @param x the <i>x</i> coordinate of the point
4703 * @param y the <i>y</i> coordinate of the point
4704 * @return {@code true} if the point is within the component;
4705 * otherwise {@code false}
4706 * @deprecated As of JDK version 1.1,
4707 * replaced by contains(int, int).
4708 */
4709 @Deprecated
4710 public boolean inside(int x, int y) {
4711 return (x >= 0) && (x < width) && (y >= 0) && (y < height);
4712 }
4713
4714 /**
4715 * Checks whether this component "contains" the specified point,
4716 * where the point's <i>x</i> and <i>y</i> coordinates are defined
4717 * to be relative to the coordinate system of this component.
4718 *
4719 * @param p the point
4720 * @return {@code true} if the point is within the component;
4721 * otherwise {@code false}
4722 * @throws NullPointerException if {@code p} is {@code null}
4723 * @see #getComponentAt(Point)
4724 * @since 1.1
4725 */
4726 public boolean contains(Point p) {
4727 return contains(p.x, p.y);
4728 }
4729
4730 /**
4731 * Determines if this component or one of its immediate
4732 * subcomponents contains the (<i>x</i>, <i>y</i>) location,
4733 * and if so, returns the containing component. This method only
4734 * looks one level deep. If the point (<i>x</i>, <i>y</i>) is
4735 * inside a subcomponent that itself has subcomponents, it does not
4736 * go looking down the subcomponent tree.
4737 * <p>
4738 * The <code>locate</code> method of <code>Component</code> simply
4739 * returns the component itself if the (<i>x</i>, <i>y</i>)
4740 * coordinate location is inside its bounding box, and <code>null</code>
4741 * otherwise.
4742 * @param x the <i>x</i> coordinate
4743 * @param y the <i>y</i> coordinate
4744 * @return the component or subcomponent that contains the
4745 * (<i>x</i>, <i>y</i>) location;
4746 * <code>null</code> if the location
4747 * is outside this component
4748 * @see #contains(int, int)
4749 * @since 1.0
4750 */
4751 public Component getComponentAt(int x, int y) {
4752 return locate(x, y);
4753 }
4754
4755 /**
4756 * Returns the component occupying the position specified (this component,
4757 * or immediate child component, or null if neither
4758 * of the first two occupies the location).
4759 *
4760 * @param x the <i>x</i> coordinate to search for components at
4761 * @param y the <i>y</i> coordinate to search for components at
4762 * @return the component at the specified location or {@code null}
4763 * @deprecated As of JDK version 1.1,
4764 * replaced by getComponentAt(int, int).
4765 */
4766 @Deprecated
4767 public Component locate(int x, int y) {
4768 return contains(x, y) ? this : null;
4769 }
4770
4771 /**
4772 * Returns the component or subcomponent that contains the
4773 * specified point.
4774 * @param p the point
4775 * @return the component at the specified location or {@code null}
4776 * @see java.awt.Component#contains
4777 * @since 1.1
4778 */
4779 public Component getComponentAt(Point p) {
4780 return getComponentAt(p.x, p.y);
4781 }
4782
4783 /**
4784 * @param e the event to deliver
4785 * @deprecated As of JDK version 1.1,
4786 * replaced by <code>dispatchEvent(AWTEvent e)</code>.
4787 */
4788 @Deprecated
4789 public void deliverEvent(Event e) {
4790 postEvent(e);
4791 }
4792
4793 /**
4794 * Dispatches an event to this component or one of its sub components.
4795 * Calls <code>processEvent</code> before returning for 1.1-style
4796 * events which have been enabled for the <code>Component</code>.
4797 * @param e the event
4798 */
4799 public final void dispatchEvent(AWTEvent e) {
4800 dispatchEventImpl(e);
4801 }
4802
4803 @SuppressWarnings("deprecation")
4804 void dispatchEventImpl(AWTEvent e) {
4805 int id = e.getID();
4806
4807 // Check that this component belongs to this app-context
4808 AppContext compContext = appContext;
4809 if (compContext != null && !compContext.equals(AppContext.getAppContext())) {
4810 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) {
4811 eventLog.fine("Event " + e + " is being dispatched on the wrong AppContext");
4812 }
4813 }
4814
4815 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) {
4816 eventLog.finest("{0}", e);
4817 }
4818
4819 /*
4820 * 0. Set timestamp and modifiers of current event.
4821 */
4822 if (!(e instanceof KeyEvent)) {
4823 // Timestamp of a key event is set later in DKFM.preDispatchKeyEvent(KeyEvent).
4824 EventQueue.setCurrentEventAndMostRecentTime(e);
4825 }
4826
4827 /*
4828 * 1. Pre-dispatchers. Do any necessary retargeting/reordering here
4829 * before we notify AWTEventListeners.
4830 */
4831
4832 if (e instanceof SunDropTargetEvent) {
4833 ((SunDropTargetEvent)e).dispatch();
4834 return;
4835 }
4836
4837 if (!e.focusManagerIsDispatching) {
4838 // Invoke the private focus retargeting method which provides
4839 // lightweight Component support
4840 if (e.isPosted) {
4841 e = KeyboardFocusManager.retargetFocusEvent(e);
4842 e.isPosted = true;
4843 }
4844
4845 // Now, with the event properly targeted to a lightweight
4846 // descendant if necessary, invoke the public focus retargeting
4847 // and dispatching function
4848 if (KeyboardFocusManager.getCurrentKeyboardFocusManager().
4849 dispatchEvent(e))
4850 {
4851 return;
4852 }
4853 }
4854 if ((e instanceof FocusEvent) && focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
4855 focusLog.finest("" + e);
4856 }
4857 // MouseWheel may need to be retargeted here so that
4858 // AWTEventListener sees the event go to the correct
4859 // Component. If the MouseWheelEvent needs to go to an ancestor,
4860 // the event is dispatched to the ancestor, and dispatching here
4861 // stops.
4862 if (id == MouseEvent.MOUSE_WHEEL &&
4863 (!eventTypeEnabled(id)) &&
4864 (peer != null && !peer.handlesWheelScrolling()) &&
4865 (dispatchMouseWheelToAncestor((MouseWheelEvent)e)))
4866 {
4867 return;
4868 }
4869
4870 /*
4871 * 2. Allow the Toolkit to pass this to AWTEventListeners.
4872 */
4873 Toolkit toolkit = Toolkit.getDefaultToolkit();
4874 toolkit.notifyAWTEventListeners(e);
4875
4876
4877 /*
4878 * 3. If no one has consumed a key event, allow the
4879 * KeyboardFocusManager to process it.
4880 */
4881 if (!e.isConsumed()) {
4882 if (e instanceof java.awt.event.KeyEvent) {
4883 KeyboardFocusManager.getCurrentKeyboardFocusManager().
4884 processKeyEvent(this, (KeyEvent)e);
4885 if (e.isConsumed()) {
4886 return;
4887 }
4888 }
4889 }
4890
4891 /*
4892 * 4. Allow input methods to process the event
4893 */
4894 if (areInputMethodsEnabled()) {
4895 // We need to pass on InputMethodEvents since some host
4896 // input method adapters send them through the Java
4897 // event queue instead of directly to the component,
4898 // and the input context also handles the Java composition window
4899 if(((e instanceof InputMethodEvent) && !(this instanceof CompositionArea))
4900 ||
4901 // Otherwise, we only pass on input and focus events, because
4902 // a) input methods shouldn't know about semantic or component-level events
4903 // b) passing on the events takes time
4904 // c) isConsumed() is always true for semantic events.
4905 (e instanceof InputEvent) || (e instanceof FocusEvent)) {
4906 InputContext inputContext = getInputContext();
4907
4908
4909 if (inputContext != null) {
4910 inputContext.dispatchEvent(e);
4911 if (e.isConsumed()) {
4912 if ((e instanceof FocusEvent) && focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
4913 focusLog.finest("3579: Skipping " + e);
4914 }
4915 return;
4916 }
4917 }
4918 }
4919 } else {
4920 // When non-clients get focus, we need to explicitly disable the native
4921 // input method. The native input method is actually not disabled when
4922 // the active/passive/peered clients loose focus.
4923 if (id == FocusEvent.FOCUS_GAINED) {
4924 InputContext inputContext = getInputContext();
4925 if (inputContext != null && inputContext instanceof sun.awt.im.InputContext) {
4926 ((sun.awt.im.InputContext)inputContext).disableNativeIM();
4927 }
4928 }
4929 }
4930
4931
4932 /*
4933 * 5. Pre-process any special events before delivery
4934 */
4935 switch(id) {
4936 // Handling of the PAINT and UPDATE events is now done in the
4937 // peer's handleEvent() method so the background can be cleared
4938 // selectively for non-native components on Windows only.
4939 // - Fred.Ecks@Eng.sun.com, 5-8-98
4940
4941 case KeyEvent.KEY_PRESSED:
4942 case KeyEvent.KEY_RELEASED:
4943 Container p = (Container)((this instanceof Container) ? this : parent);
4944 if (p != null) {
4945 p.preProcessKeyEvent((KeyEvent)e);
4946 if (e.isConsumed()) {
4947 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
4948 focusLog.finest("Pre-process consumed event");
4949 }
4950 return;
4951 }
4952 }
4953 break;
4954
4955 default:
4956 break;
4957 }
4958
4959 /*
4960 * 6. Deliver event for normal processing
4961 */
4962 if (newEventsOnly) {
4963 // Filtering needs to really be moved to happen at a lower
4964 // level in order to get maximum performance gain; it is
4965 // here temporarily to ensure the API spec is honored.
4966 //
4967 if (eventEnabled(e)) {
4968 processEvent(e);
4969 }
4970 } else if (id == MouseEvent.MOUSE_WHEEL) {
4971 // newEventsOnly will be false for a listenerless ScrollPane, but
4972 // MouseWheelEvents still need to be dispatched to it so scrolling
4973 // can be done.
4974 autoProcessMouseWheel((MouseWheelEvent)e);
4975 } else if (!(e instanceof MouseEvent && !postsOldMouseEvents())) {
4976 //
4977 // backward compatibility
4978 //
4979 Event olde = e.convertToOld();
4980 if (olde != null) {
4981 int key = olde.key;
4982 int modifiers = olde.modifiers;
4983
4984 postEvent(olde);
4985 if (olde.isConsumed()) {
4986 e.consume();
4987 }
4988 // if target changed key or modifier values, copy them
4989 // back to original event
4990 //
4991 switch(olde.id) {
4992 case Event.KEY_PRESS:
4993 case Event.KEY_RELEASE:
4994 case Event.KEY_ACTION:
4995 case Event.KEY_ACTION_RELEASE:
4996 if (olde.key != key) {
4997 ((KeyEvent)e).setKeyChar(olde.getKeyEventChar());
4998 }
4999 if (olde.modifiers != modifiers) {
5000 ((KeyEvent)e).setModifiers(olde.modifiers);
5001 }
5002 break;
5003 default:
5004 break;
5005 }
5006 }
5007 }
5008
5009 /*
5010 * 9. Allow the peer to process the event.
5011 * Except KeyEvents, they will be processed by peer after
5012 * all KeyEventPostProcessors
5013 * (see DefaultKeyboardFocusManager.dispatchKeyEvent())
5014 */
5015 if (!(e instanceof KeyEvent)) {
5016 ComponentPeer tpeer = peer;
5017 if (e instanceof FocusEvent && (tpeer == null || tpeer instanceof LightweightPeer)) {
5018 // if focus owner is lightweight then its native container
5019 // processes event
5020 Component source = (Component)e.getSource();
5021 if (source != null) {
5022 Container target = source.getNativeContainer();
5023 if (target != null) {
5024 tpeer = target.peer;
5025 }
5026 }
5027 }
5028 if (tpeer != null) {
5029 tpeer.handleEvent(e);
5030 }
5031 }
5032 } // dispatchEventImpl()
5033
5034 /*
5035 * If newEventsOnly is false, method is called so that ScrollPane can
5036 * override it and handle common-case mouse wheel scrolling. NOP
5037 * for Component.
5038 */
5039 void autoProcessMouseWheel(MouseWheelEvent e) {}
5040
5041 /*
5042 * Dispatch given MouseWheelEvent to the first ancestor for which
5043 * MouseWheelEvents are enabled.
5044 *
5045 * Returns whether or not event was dispatched to an ancestor
5046 */
5047 boolean dispatchMouseWheelToAncestor(MouseWheelEvent e) {
5048 int newX, newY;
5049 newX = e.getX() + getX(); // Coordinates take into account at least
5050 newY = e.getY() + getY(); // the cursor's position relative to this
5051 // Component (e.getX()), and this Component's
5052 // position relative to its parent.
5053 MouseWheelEvent newMWE;
5054
5055 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) {
5056 eventLog.finest("dispatchMouseWheelToAncestor");
5057 eventLog.finest("orig event src is of " + e.getSource().getClass());
5058 }
5059
5060 /* parent field for Window refers to the owning Window.
5061 * MouseWheelEvents should NOT be propagated into owning Windows
5062 */
5063 synchronized (getTreeLock()) {
5064 Container anc = getParent();
5065 while (anc != null && !anc.eventEnabled(e)) {
5066 // fix coordinates to be relative to new event source
5067 newX += anc.getX();
5068 newY += anc.getY();
5069
5070 if (!(anc instanceof Window)) {
5071 anc = anc.getParent();
5072 }
5073 else {
5074 break;
5075 }
5076 }
5077
5078 if (eventLog.isLoggable(PlatformLogger.Level.FINEST)) {
5079 eventLog.finest("new event src is " + anc.getClass());
5080 }
5081
5082 if (anc != null && anc.eventEnabled(e)) {
5083 // Change event to be from new source, with new x,y
5084 // For now, just create a new event - yucky
5085
5086 newMWE = new MouseWheelEvent(anc, // new source
5087 e.getID(),
5088 e.getWhen(),
5089 e.getModifiers(),
5090 newX, // x relative to new source
5091 newY, // y relative to new source
5092 e.getXOnScreen(),
5093 e.getYOnScreen(),
5094 e.getClickCount(),
5095 e.isPopupTrigger(),
5096 e.getScrollType(),
5097 e.getScrollAmount(),
5098 e.getWheelRotation(),
5099 e.getPreciseWheelRotation());
5100 ((AWTEvent)e).copyPrivateDataInto(newMWE);
5101 // When dispatching a wheel event to
5102 // ancestor, there is no need trying to find descendant
5103 // lightweights to dispatch event to.
5104 // If we dispatch the event to toplevel ancestor,
5105 // this could enclose the loop: 6480024.
5106 anc.dispatchEventToSelf(newMWE);
5107 if (newMWE.isConsumed()) {
5108 e.consume();
5109 }
5110 return true;
5111 }
5112 }
5113 return false;
5114 }
5115
5116 boolean areInputMethodsEnabled() {
5117 // in 1.2, we assume input method support is required for all
5118 // components that handle key events, but components can turn off
5119 // input methods by calling enableInputMethods(false).
5120 return ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) &&
5121 ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 || keyListener != null);
5122 }
5123
5124 // REMIND: remove when filtering is handled at lower level
5125 boolean eventEnabled(AWTEvent e) {
5126 return eventTypeEnabled(e.id);
5127 }
5128
5129 boolean eventTypeEnabled(int type) {
5130 switch(type) {
5131 case ComponentEvent.COMPONENT_MOVED:
5132 case ComponentEvent.COMPONENT_RESIZED:
5133 case ComponentEvent.COMPONENT_SHOWN:
5134 case ComponentEvent.COMPONENT_HIDDEN:
5135 if ((eventMask & AWTEvent.COMPONENT_EVENT_MASK) != 0 ||
5136 componentListener != null) {
5137 return true;
5138 }
5139 break;
5140 case FocusEvent.FOCUS_GAINED:
5141 case FocusEvent.FOCUS_LOST:
5142 if ((eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0 ||
5143 focusListener != null) {
5144 return true;
5145 }
5146 break;
5147 case KeyEvent.KEY_PRESSED:
5148 case KeyEvent.KEY_RELEASED:
5149 case KeyEvent.KEY_TYPED:
5150 if ((eventMask & AWTEvent.KEY_EVENT_MASK) != 0 ||
5151 keyListener != null) {
5152 return true;
5153 }
5154 break;
5155 case MouseEvent.MOUSE_PRESSED:
5156 case MouseEvent.MOUSE_RELEASED:
5157 case MouseEvent.MOUSE_ENTERED:
5158 case MouseEvent.MOUSE_EXITED:
5159 case MouseEvent.MOUSE_CLICKED:
5160 if ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0 ||
5161 mouseListener != null) {
5162 return true;
5163 }
5164 break;
5165 case MouseEvent.MOUSE_MOVED:
5166 case MouseEvent.MOUSE_DRAGGED:
5167 if ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0 ||
5168 mouseMotionListener != null) {
5169 return true;
5170 }
5171 break;
5172 case MouseEvent.MOUSE_WHEEL:
5173 if ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0 ||
5174 mouseWheelListener != null) {
5175 return true;
5176 }
5177 break;
5178 case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
5179 case InputMethodEvent.CARET_POSITION_CHANGED:
5180 if ((eventMask & AWTEvent.INPUT_METHOD_EVENT_MASK) != 0 ||
5181 inputMethodListener != null) {
5182 return true;
5183 }
5184 break;
5185 case HierarchyEvent.HIERARCHY_CHANGED:
5186 if ((eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
5187 hierarchyListener != null) {
5188 return true;
5189 }
5190 break;
5191 case HierarchyEvent.ANCESTOR_MOVED:
5192 case HierarchyEvent.ANCESTOR_RESIZED:
5193 if ((eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 ||
5194 hierarchyBoundsListener != null) {
5195 return true;
5196 }
5197 break;
5198 case ActionEvent.ACTION_PERFORMED:
5199 if ((eventMask & AWTEvent.ACTION_EVENT_MASK) != 0) {
5200 return true;
5201 }
5202 break;
5203 case TextEvent.TEXT_VALUE_CHANGED:
5204 if ((eventMask & AWTEvent.TEXT_EVENT_MASK) != 0) {
5205 return true;
5206 }
5207 break;
5208 case ItemEvent.ITEM_STATE_CHANGED:
5209 if ((eventMask & AWTEvent.ITEM_EVENT_MASK) != 0) {
5210 return true;
5211 }
5212 break;
5213 case AdjustmentEvent.ADJUSTMENT_VALUE_CHANGED:
5214 if ((eventMask & AWTEvent.ADJUSTMENT_EVENT_MASK) != 0) {
5215 return true;
5216 }
5217 break;
5218 default:
5219 break;
5220 }
5221 //
5222 // Always pass on events defined by external programs.
5223 //
5224 if (type > AWTEvent.RESERVED_ID_MAX) {
5225 return true;
5226 }
5227 return false;
5228 }
5229
5230 /**
5231 * @deprecated As of JDK version 1.1,
5232 * replaced by dispatchEvent(AWTEvent).
5233 */
5234 @Deprecated
5235 public boolean postEvent(Event e) {
5236 ComponentPeer peer = this.peer;
5237
5238 if (handleEvent(e)) {
5239 e.consume();
5240 return true;
5241 }
5242
5243 Component parent = this.parent;
5244 int eventx = e.x;
5245 int eventy = e.y;
5246 if (parent != null) {
5247 e.translate(x, y);
5248 if (parent.postEvent(e)) {
5249 e.consume();
5250 return true;
5251 }
5252 // restore coords
5253 e.x = eventx;
5254 e.y = eventy;
5255 }
5256 return false;
5257 }
5258
5259 // Event source interfaces
5260
5261 /**
5262 * Adds the specified component listener to receive component events from
5263 * this component.
5264 * If listener <code>l</code> is <code>null</code>,
5265 * no exception is thrown and no action is performed.
5266 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5267 * >AWT Threading Issues</a> for details on AWT's threading model.
5268 *
5269 * @param l the component listener
5270 * @see java.awt.event.ComponentEvent
5271 * @see java.awt.event.ComponentListener
5272 * @see #removeComponentListener
5273 * @see #getComponentListeners
5274 * @since 1.1
5275 */
5276 public synchronized void addComponentListener(ComponentListener l) {
5277 if (l == null) {
5278 return;
5279 }
5280 componentListener = AWTEventMulticaster.add(componentListener, l);
5281 newEventsOnly = true;
5282 }
5283
5284 /**
5285 * Removes the specified component listener so that it no longer
5286 * receives component events from this component. This method performs
5287 * no function, nor does it throw an exception, if the listener
5288 * specified by the argument was not previously added to this component.
5289 * If listener <code>l</code> is <code>null</code>,
5290 * no exception is thrown and no action is performed.
5291 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5292 * >AWT Threading Issues</a> for details on AWT's threading model.
5293 * @param l the component listener
5294 * @see java.awt.event.ComponentEvent
5295 * @see java.awt.event.ComponentListener
5296 * @see #addComponentListener
5297 * @see #getComponentListeners
5298 * @since 1.1
5299 */
5300 public synchronized void removeComponentListener(ComponentListener l) {
5301 if (l == null) {
5302 return;
5303 }
5304 componentListener = AWTEventMulticaster.remove(componentListener, l);
5305 }
5306
5307 /**
5308 * Returns an array of all the component listeners
5309 * registered on this component.
5310 *
5311 * @return all <code>ComponentListener</code>s of this component
5312 * or an empty array if no component
5313 * listeners are currently registered
5314 *
5315 * @see #addComponentListener
5316 * @see #removeComponentListener
5317 * @since 1.4
5318 */
5319 public synchronized ComponentListener[] getComponentListeners() {
5320 return getListeners(ComponentListener.class);
5321 }
5322
5323 /**
5324 * Adds the specified focus listener to receive focus events from
5325 * this component when this component gains input focus.
5326 * If listener <code>l</code> is <code>null</code>,
5327 * no exception is thrown and no action is performed.
5328 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5329 * >AWT Threading Issues</a> for details on AWT's threading model.
5330 *
5331 * @param l the focus listener
5332 * @see java.awt.event.FocusEvent
5333 * @see java.awt.event.FocusListener
5334 * @see #removeFocusListener
5335 * @see #getFocusListeners
5336 * @since 1.1
5337 */
5338 public synchronized void addFocusListener(FocusListener l) {
5339 if (l == null) {
5340 return;
5341 }
5342 focusListener = AWTEventMulticaster.add(focusListener, l);
5343 newEventsOnly = true;
5344
5345 // if this is a lightweight component, enable focus events
5346 // in the native container.
5347 if (peer instanceof LightweightPeer) {
5348 parent.proxyEnableEvents(AWTEvent.FOCUS_EVENT_MASK);
5349 }
5350 }
5351
5352 /**
5353 * Removes the specified focus listener so that it no longer
5354 * receives focus events from this component. This method performs
5355 * no function, nor does it throw an exception, if the listener
5356 * specified by the argument was not previously added to this component.
5357 * If listener <code>l</code> is <code>null</code>,
5358 * no exception is thrown and no action is performed.
5359 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5360 * >AWT Threading Issues</a> for details on AWT's threading model.
5361 *
5362 * @param l the focus listener
5363 * @see java.awt.event.FocusEvent
5364 * @see java.awt.event.FocusListener
5365 * @see #addFocusListener
5366 * @see #getFocusListeners
5367 * @since 1.1
5368 */
5369 public synchronized void removeFocusListener(FocusListener l) {
5370 if (l == null) {
5371 return;
5372 }
5373 focusListener = AWTEventMulticaster.remove(focusListener, l);
5374 }
5375
5376 /**
5377 * Returns an array of all the focus listeners
5378 * registered on this component.
5379 *
5380 * @return all of this component's <code>FocusListener</code>s
5381 * or an empty array if no component
5382 * listeners are currently registered
5383 *
5384 * @see #addFocusListener
5385 * @see #removeFocusListener
5386 * @since 1.4
5387 */
5388 public synchronized FocusListener[] getFocusListeners() {
5389 return getListeners(FocusListener.class);
5390 }
5391
5392 /**
5393 * Adds the specified hierarchy listener to receive hierarchy changed
5394 * events from this component when the hierarchy to which this container
5395 * belongs changes.
5396 * If listener <code>l</code> is <code>null</code>,
5397 * no exception is thrown and no action is performed.
5398 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5399 * >AWT Threading Issues</a> for details on AWT's threading model.
5400 *
5401 * @param l the hierarchy listener
5402 * @see java.awt.event.HierarchyEvent
5403 * @see java.awt.event.HierarchyListener
5404 * @see #removeHierarchyListener
5405 * @see #getHierarchyListeners
5406 * @since 1.3
5407 */
5408 public void addHierarchyListener(HierarchyListener l) {
5409 if (l == null) {
5410 return;
5411 }
5412 boolean notifyAncestors;
5413 synchronized (this) {
5414 notifyAncestors =
5415 (hierarchyListener == null &&
5416 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0);
5417 hierarchyListener = AWTEventMulticaster.add(hierarchyListener, l);
5418 notifyAncestors = (notifyAncestors && hierarchyListener != null);
5419 newEventsOnly = true;
5420 }
5421 if (notifyAncestors) {
5422 synchronized (getTreeLock()) {
5423 adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK,
5424 1);
5425 }
5426 }
5427 }
5428
5429 /**
5430 * Removes the specified hierarchy listener so that it no longer
5431 * receives hierarchy changed events from this component. This method
5432 * performs no function, nor does it throw an exception, if the listener
5433 * specified by the argument was not previously added to this component.
5434 * If listener <code>l</code> is <code>null</code>,
5435 * no exception is thrown and no action is performed.
5436 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5437 * >AWT Threading Issues</a> for details on AWT's threading model.
5438 *
5439 * @param l the hierarchy listener
5440 * @see java.awt.event.HierarchyEvent
5441 * @see java.awt.event.HierarchyListener
5442 * @see #addHierarchyListener
5443 * @see #getHierarchyListeners
5444 * @since 1.3
5445 */
5446 public void removeHierarchyListener(HierarchyListener l) {
5447 if (l == null) {
5448 return;
5449 }
5450 boolean notifyAncestors;
5451 synchronized (this) {
5452 notifyAncestors =
5453 (hierarchyListener != null &&
5454 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0);
5455 hierarchyListener =
5456 AWTEventMulticaster.remove(hierarchyListener, l);
5457 notifyAncestors = (notifyAncestors && hierarchyListener == null);
5458 }
5459 if (notifyAncestors) {
5460 synchronized (getTreeLock()) {
5461 adjustListeningChildrenOnParent(AWTEvent.HIERARCHY_EVENT_MASK,
5462 -1);
5463 }
5464 }
5465 }
5466
5467 /**
5468 * Returns an array of all the hierarchy listeners
5469 * registered on this component.
5470 *
5471 * @return all of this component's <code>HierarchyListener</code>s
5472 * or an empty array if no hierarchy
5473 * listeners are currently registered
5474 *
5475 * @see #addHierarchyListener
5476 * @see #removeHierarchyListener
5477 * @since 1.4
5478 */
5479 public synchronized HierarchyListener[] getHierarchyListeners() {
5480 return getListeners(HierarchyListener.class);
5481 }
5482
5483 /**
5484 * Adds the specified hierarchy bounds listener to receive hierarchy
5485 * bounds events from this component when the hierarchy to which this
5486 * container belongs changes.
5487 * If listener <code>l</code> is <code>null</code>,
5488 * no exception is thrown and no action is performed.
5489 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5490 * >AWT Threading Issues</a> for details on AWT's threading model.
5491 *
5492 * @param l the hierarchy bounds listener
5493 * @see java.awt.event.HierarchyEvent
5494 * @see java.awt.event.HierarchyBoundsListener
5495 * @see #removeHierarchyBoundsListener
5496 * @see #getHierarchyBoundsListeners
5497 * @since 1.3
5498 */
5499 public void addHierarchyBoundsListener(HierarchyBoundsListener l) {
5500 if (l == null) {
5501 return;
5502 }
5503 boolean notifyAncestors;
5504 synchronized (this) {
5505 notifyAncestors =
5506 (hierarchyBoundsListener == null &&
5507 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0);
5508 hierarchyBoundsListener =
5509 AWTEventMulticaster.add(hierarchyBoundsListener, l);
5510 notifyAncestors = (notifyAncestors &&
5511 hierarchyBoundsListener != null);
5512 newEventsOnly = true;
5513 }
5514 if (notifyAncestors) {
5515 synchronized (getTreeLock()) {
5516 adjustListeningChildrenOnParent(
5517 AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, 1);
5518 }
5519 }
5520 }
5521
5522 /**
5523 * Removes the specified hierarchy bounds listener so that it no longer
5524 * receives hierarchy bounds events from this component. This method
5525 * performs no function, nor does it throw an exception, if the listener
5526 * specified by the argument was not previously added to this component.
5527 * If listener <code>l</code> is <code>null</code>,
5528 * no exception is thrown and no action is performed.
5529 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5530 * >AWT Threading Issues</a> for details on AWT's threading model.
5531 *
5532 * @param l the hierarchy bounds listener
5533 * @see java.awt.event.HierarchyEvent
5534 * @see java.awt.event.HierarchyBoundsListener
5535 * @see #addHierarchyBoundsListener
5536 * @see #getHierarchyBoundsListeners
5537 * @since 1.3
5538 */
5539 public void removeHierarchyBoundsListener(HierarchyBoundsListener l) {
5540 if (l == null) {
5541 return;
5542 }
5543 boolean notifyAncestors;
5544 synchronized (this) {
5545 notifyAncestors =
5546 (hierarchyBoundsListener != null &&
5547 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0);
5548 hierarchyBoundsListener =
5549 AWTEventMulticaster.remove(hierarchyBoundsListener, l);
5550 notifyAncestors = (notifyAncestors &&
5551 hierarchyBoundsListener == null);
5552 }
5553 if (notifyAncestors) {
5554 synchronized (getTreeLock()) {
5555 adjustListeningChildrenOnParent(
5556 AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK, -1);
5557 }
5558 }
5559 }
5560
5561 // Should only be called while holding the tree lock
5562 int numListening(long mask) {
5563 // One mask or the other, but not neither or both.
5564 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) {
5565 if ((mask != AWTEvent.HIERARCHY_EVENT_MASK) &&
5566 (mask != AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK))
5567 {
5568 eventLog.fine("Assertion failed");
5569 }
5570 }
5571 if ((mask == AWTEvent.HIERARCHY_EVENT_MASK &&
5572 (hierarchyListener != null ||
5573 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0)) ||
5574 (mask == AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK &&
5575 (hierarchyBoundsListener != null ||
5576 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0))) {
5577 return 1;
5578 } else {
5579 return 0;
5580 }
5581 }
5582
5583 // Should only be called while holding tree lock
5584 int countHierarchyMembers() {
5585 return 1;
5586 }
5587 // Should only be called while holding the tree lock
5588 int createHierarchyEvents(int id, Component changed,
5589 Container changedParent, long changeFlags,
5590 boolean enabledOnToolkit) {
5591 switch (id) {
5592 case HierarchyEvent.HIERARCHY_CHANGED:
5593 if (hierarchyListener != null ||
5594 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
5595 enabledOnToolkit) {
5596 HierarchyEvent e = new HierarchyEvent(this, id, changed,
5597 changedParent,
5598 changeFlags);
5599 dispatchEvent(e);
5600 return 1;
5601 }
5602 break;
5603 case HierarchyEvent.ANCESTOR_MOVED:
5604 case HierarchyEvent.ANCESTOR_RESIZED:
5605 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) {
5606 if (changeFlags != 0) {
5607 eventLog.fine("Assertion (changeFlags == 0) failed");
5608 }
5609 }
5610 if (hierarchyBoundsListener != null ||
5611 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 ||
5612 enabledOnToolkit) {
5613 HierarchyEvent e = new HierarchyEvent(this, id, changed,
5614 changedParent);
5615 dispatchEvent(e);
5616 return 1;
5617 }
5618 break;
5619 default:
5620 // assert false
5621 if (eventLog.isLoggable(PlatformLogger.Level.FINE)) {
5622 eventLog.fine("This code must never be reached");
5623 }
5624 break;
5625 }
5626 return 0;
5627 }
5628
5629 /**
5630 * Returns an array of all the hierarchy bounds listeners
5631 * registered on this component.
5632 *
5633 * @return all of this component's <code>HierarchyBoundsListener</code>s
5634 * or an empty array if no hierarchy bounds
5635 * listeners are currently registered
5636 *
5637 * @see #addHierarchyBoundsListener
5638 * @see #removeHierarchyBoundsListener
5639 * @since 1.4
5640 */
5641 public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners() {
5642 return getListeners(HierarchyBoundsListener.class);
5643 }
5644
5645 /*
5646 * Should only be called while holding the tree lock.
5647 * It's added only for overriding in java.awt.Window
5648 * because parent in Window is owner.
5649 */
5650 void adjustListeningChildrenOnParent(long mask, int num) {
5651 if (parent != null) {
5652 parent.adjustListeningChildren(mask, num);
5653 }
5654 }
5655
5656 /**
5657 * Adds the specified key listener to receive key events from
5658 * this component.
5659 * If l is null, no exception is thrown and no action is performed.
5660 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5661 * >AWT Threading Issues</a> for details on AWT's threading model.
5662 *
5663 * @param l the key listener.
5664 * @see java.awt.event.KeyEvent
5665 * @see java.awt.event.KeyListener
5666 * @see #removeKeyListener
5667 * @see #getKeyListeners
5668 * @since 1.1
5669 */
5670 public synchronized void addKeyListener(KeyListener l) {
5671 if (l == null) {
5672 return;
5673 }
5674 keyListener = AWTEventMulticaster.add(keyListener, l);
5675 newEventsOnly = true;
5676
5677 // if this is a lightweight component, enable key events
5678 // in the native container.
5679 if (peer instanceof LightweightPeer) {
5680 parent.proxyEnableEvents(AWTEvent.KEY_EVENT_MASK);
5681 }
5682 }
5683
5684 /**
5685 * Removes the specified key listener so that it no longer
5686 * receives key events from this component. This method performs
5687 * no function, nor does it throw an exception, if the listener
5688 * specified by the argument was not previously added to this component.
5689 * If listener <code>l</code> is <code>null</code>,
5690 * no exception is thrown and no action is performed.
5691 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5692 * >AWT Threading Issues</a> for details on AWT's threading model.
5693 *
5694 * @param l the key listener
5695 * @see java.awt.event.KeyEvent
5696 * @see java.awt.event.KeyListener
5697 * @see #addKeyListener
5698 * @see #getKeyListeners
5699 * @since 1.1
5700 */
5701 public synchronized void removeKeyListener(KeyListener l) {
5702 if (l == null) {
5703 return;
5704 }
5705 keyListener = AWTEventMulticaster.remove(keyListener, l);
5706 }
5707
5708 /**
5709 * Returns an array of all the key listeners
5710 * registered on this component.
5711 *
5712 * @return all of this component's <code>KeyListener</code>s
5713 * or an empty array if no key
5714 * listeners are currently registered
5715 *
5716 * @see #addKeyListener
5717 * @see #removeKeyListener
5718 * @since 1.4
5719 */
5720 public synchronized KeyListener[] getKeyListeners() {
5721 return getListeners(KeyListener.class);
5722 }
5723
5724 /**
5725 * Adds the specified mouse listener to receive mouse events from
5726 * this component.
5727 * If listener <code>l</code> is <code>null</code>,
5728 * no exception is thrown and no action is performed.
5729 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5730 * >AWT Threading Issues</a> for details on AWT's threading model.
5731 *
5732 * @param l the mouse listener
5733 * @see java.awt.event.MouseEvent
5734 * @see java.awt.event.MouseListener
5735 * @see #removeMouseListener
5736 * @see #getMouseListeners
5737 * @since 1.1
5738 */
5739 public synchronized void addMouseListener(MouseListener l) {
5740 if (l == null) {
5741 return;
5742 }
5743 mouseListener = AWTEventMulticaster.add(mouseListener,l);
5744 newEventsOnly = true;
5745
5746 // if this is a lightweight component, enable mouse events
5747 // in the native container.
5748 if (peer instanceof LightweightPeer) {
5749 parent.proxyEnableEvents(AWTEvent.MOUSE_EVENT_MASK);
5750 }
5751 }
5752
5753 /**
5754 * Removes the specified mouse listener so that it no longer
5755 * receives mouse events from this component. This method performs
5756 * no function, nor does it throw an exception, if the listener
5757 * specified by the argument was not previously added to this component.
5758 * If listener <code>l</code> is <code>null</code>,
5759 * no exception is thrown and no action is performed.
5760 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5761 * >AWT Threading Issues</a> for details on AWT's threading model.
5762 *
5763 * @param l the mouse listener
5764 * @see java.awt.event.MouseEvent
5765 * @see java.awt.event.MouseListener
5766 * @see #addMouseListener
5767 * @see #getMouseListeners
5768 * @since 1.1
5769 */
5770 public synchronized void removeMouseListener(MouseListener l) {
5771 if (l == null) {
5772 return;
5773 }
5774 mouseListener = AWTEventMulticaster.remove(mouseListener, l);
5775 }
5776
5777 /**
5778 * Returns an array of all the mouse listeners
5779 * registered on this component.
5780 *
5781 * @return all of this component's <code>MouseListener</code>s
5782 * or an empty array if no mouse
5783 * listeners are currently registered
5784 *
5785 * @see #addMouseListener
5786 * @see #removeMouseListener
5787 * @since 1.4
5788 */
5789 public synchronized MouseListener[] getMouseListeners() {
5790 return getListeners(MouseListener.class);
5791 }
5792
5793 /**
5794 * Adds the specified mouse motion listener to receive mouse motion
5795 * events from this component.
5796 * If listener <code>l</code> is <code>null</code>,
5797 * no exception is thrown and no action is performed.
5798 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5799 * >AWT Threading Issues</a> for details on AWT's threading model.
5800 *
5801 * @param l the mouse motion listener
5802 * @see java.awt.event.MouseEvent
5803 * @see java.awt.event.MouseMotionListener
5804 * @see #removeMouseMotionListener
5805 * @see #getMouseMotionListeners
5806 * @since 1.1
5807 */
5808 public synchronized void addMouseMotionListener(MouseMotionListener l) {
5809 if (l == null) {
5810 return;
5811 }
5812 mouseMotionListener = AWTEventMulticaster.add(mouseMotionListener,l);
5813 newEventsOnly = true;
5814
5815 // if this is a lightweight component, enable mouse events
5816 // in the native container.
5817 if (peer instanceof LightweightPeer) {
5818 parent.proxyEnableEvents(AWTEvent.MOUSE_MOTION_EVENT_MASK);
5819 }
5820 }
5821
5822 /**
5823 * Removes the specified mouse motion listener so that it no longer
5824 * receives mouse motion events from this component. This method performs
5825 * no function, nor does it throw an exception, if the listener
5826 * specified by the argument was not previously added to this component.
5827 * If listener <code>l</code> is <code>null</code>,
5828 * no exception is thrown and no action is performed.
5829 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5830 * >AWT Threading Issues</a> for details on AWT's threading model.
5831 *
5832 * @param l the mouse motion listener
5833 * @see java.awt.event.MouseEvent
5834 * @see java.awt.event.MouseMotionListener
5835 * @see #addMouseMotionListener
5836 * @see #getMouseMotionListeners
5837 * @since 1.1
5838 */
5839 public synchronized void removeMouseMotionListener(MouseMotionListener l) {
5840 if (l == null) {
5841 return;
5842 }
5843 mouseMotionListener = AWTEventMulticaster.remove(mouseMotionListener, l);
5844 }
5845
5846 /**
5847 * Returns an array of all the mouse motion listeners
5848 * registered on this component.
5849 *
5850 * @return all of this component's <code>MouseMotionListener</code>s
5851 * or an empty array if no mouse motion
5852 * listeners are currently registered
5853 *
5854 * @see #addMouseMotionListener
5855 * @see #removeMouseMotionListener
5856 * @since 1.4
5857 */
5858 public synchronized MouseMotionListener[] getMouseMotionListeners() {
5859 return getListeners(MouseMotionListener.class);
5860 }
5861
5862 /**
5863 * Adds the specified mouse wheel listener to receive mouse wheel events
5864 * from this component. Containers also receive mouse wheel events from
5865 * sub-components.
5866 * <p>
5867 * For information on how mouse wheel events are dispatched, see
5868 * the class description for {@link MouseWheelEvent}.
5869 * <p>
5870 * If l is <code>null</code>, no exception is thrown and no
5871 * action is performed.
5872 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5873 * >AWT Threading Issues</a> for details on AWT's threading model.
5874 *
5875 * @param l the mouse wheel listener
5876 * @see java.awt.event.MouseWheelEvent
5877 * @see java.awt.event.MouseWheelListener
5878 * @see #removeMouseWheelListener
5879 * @see #getMouseWheelListeners
5880 * @since 1.4
5881 */
5882 public synchronized void addMouseWheelListener(MouseWheelListener l) {
5883 if (l == null) {
5884 return;
5885 }
5886 mouseWheelListener = AWTEventMulticaster.add(mouseWheelListener,l);
5887 newEventsOnly = true;
5888
5889 // if this is a lightweight component, enable mouse events
5890 // in the native container.
5891 if (peer instanceof LightweightPeer) {
5892 parent.proxyEnableEvents(AWTEvent.MOUSE_WHEEL_EVENT_MASK);
5893 }
5894 }
5895
5896 /**
5897 * Removes the specified mouse wheel listener so that it no longer
5898 * receives mouse wheel events from this component. This method performs
5899 * no function, nor does it throw an exception, if the listener
5900 * specified by the argument was not previously added to this component.
5901 * If l is null, no exception is thrown and no action is performed.
5902 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5903 * >AWT Threading Issues</a> for details on AWT's threading model.
5904 *
5905 * @param l the mouse wheel listener.
5906 * @see java.awt.event.MouseWheelEvent
5907 * @see java.awt.event.MouseWheelListener
5908 * @see #addMouseWheelListener
5909 * @see #getMouseWheelListeners
5910 * @since 1.4
5911 */
5912 public synchronized void removeMouseWheelListener(MouseWheelListener l) {
5913 if (l == null) {
5914 return;
5915 }
5916 mouseWheelListener = AWTEventMulticaster.remove(mouseWheelListener, l);
5917 }
5918
5919 /**
5920 * Returns an array of all the mouse wheel listeners
5921 * registered on this component.
5922 *
5923 * @return all of this component's <code>MouseWheelListener</code>s
5924 * or an empty array if no mouse wheel
5925 * listeners are currently registered
5926 *
5927 * @see #addMouseWheelListener
5928 * @see #removeMouseWheelListener
5929 * @since 1.4
5930 */
5931 public synchronized MouseWheelListener[] getMouseWheelListeners() {
5932 return getListeners(MouseWheelListener.class);
5933 }
5934
5935 /**
5936 * Adds the specified input method listener to receive
5937 * input method events from this component. A component will
5938 * only receive input method events from input methods
5939 * if it also overrides <code>getInputMethodRequests</code> to return an
5940 * <code>InputMethodRequests</code> instance.
5941 * If listener <code>l</code> is <code>null</code>,
5942 * no exception is thrown and no action is performed.
5943 * <p>Refer to <a href="{@docRoot}/java/awt/doc-files/AWTThreadIssues.html#ListenersThreads"
5944 * >AWT Threading Issues</a> for details on AWT's threading model.
5945 *
5946 * @param l the input method listener
5947 * @see java.awt.event.InputMethodEvent
5948 * @see java.awt.event.InputMethodListener
5949 * @see #removeInputMethodListener
5950 * @see #getInputMethodListeners
5951 * @see #getInputMethodRequests
5952 * @since 1.2
5953 */
5954 public synchronized void addInputMethodListener(InputMethodListener l) {
5955 if (l == null) {
5956 return;
5957 }
5958 inputMethodListener = AWTEventMulticaster.add(inputMethodListener, l);
5959 newEventsOnly = true;
5960 }
5961
5962 /**
5963 * Removes the specified input method listener so that it no longer
5964 * receives input method events from this component. This method performs
5965 * no function, nor does it throw an exception, if the listener
5966 * specified by the argument was not previously added to this component.
5967 * If listener <code>l</code> is <code>null</code>,
5968 * no exception is thrown and no action is performed.
5969 * <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
5970 * >AWT Threading Issues</a> for details on AWT's threading model.
5971 *
5972 * @param l the input method listener
5973 * @see java.awt.event.InputMethodEvent
5974 * @see java.awt.event.InputMethodListener
5975 * @see #addInputMethodListener
5976 * @see #getInputMethodListeners
5977 * @since 1.2
5978 */
5979 public synchronized void removeInputMethodListener(InputMethodListener l) {
5980 if (l == null) {
5981 return;
5982 }
5983 inputMethodListener = AWTEventMulticaster.remove(inputMethodListener, l);
5984 }
5985
5986 /**
5987 * Returns an array of all the input method listeners
5988 * registered on this component.
5989 *
5990 * @return all of this component's <code>InputMethodListener</code>s
5991 * or an empty array if no input method
5992 * listeners are currently registered
5993 *
5994 * @see #addInputMethodListener
5995 * @see #removeInputMethodListener
5996 * @since 1.4
5997 */
5998 public synchronized InputMethodListener[] getInputMethodListeners() {
5999 return getListeners(InputMethodListener.class);
6000 }
6001
6002 /**
6003 * Returns an array of all the objects currently registered
6004 * as <code><em>Foo</em>Listener</code>s
6005 * upon this <code>Component</code>.
6006 * <code><em>Foo</em>Listener</code>s are registered using the
6007 * <code>add<em>Foo</em>Listener</code> method.
6008 *
6009 * <p>
6010 * You can specify the <code>listenerType</code> argument
6011 * with a class literal, such as
6012 * <code><em>Foo</em>Listener.class</code>.
6013 * For example, you can query a
6014 * <code>Component</code> <code>c</code>
6015 * for its mouse listeners with the following code:
6016 *
6017 * <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre>
6018 *
6019 * If no such listeners exist, this method returns an empty array.
6020 *
6021 * @param <T> the type of the listeners
6022 * @param listenerType the type of listeners requested; this parameter
6023 * should specify an interface that descends from
6024 * <code>java.util.EventListener</code>
6025 * @return an array of all objects registered as
6026 * <code><em>Foo</em>Listener</code>s on this component,
6027 * or an empty array if no such listeners have been added
6028 * @exception ClassCastException if <code>listenerType</code>
6029 * doesn't specify a class or interface that implements
6030 * <code>java.util.EventListener</code>
6031 * @throws NullPointerException if {@code listenerType} is {@code null}
6032 * @see #getComponentListeners
6033 * @see #getFocusListeners
6034 * @see #getHierarchyListeners
6035 * @see #getHierarchyBoundsListeners
6036 * @see #getKeyListeners
6037 * @see #getMouseListeners
6038 * @see #getMouseMotionListeners
6039 * @see #getMouseWheelListeners
6040 * @see #getInputMethodListeners
6041 * @see #getPropertyChangeListeners
6042 *
6043 * @since 1.3
6044 */
6045 @SuppressWarnings("unchecked")
6046 public <T extends EventListener> T[] getListeners(Class<T> listenerType) {
6047 EventListener l = null;
6048 if (listenerType == ComponentListener.class) {
6049 l = componentListener;
6050 } else if (listenerType == FocusListener.class) {
6051 l = focusListener;
6052 } else if (listenerType == HierarchyListener.class) {
6053 l = hierarchyListener;
6054 } else if (listenerType == HierarchyBoundsListener.class) {
6055 l = hierarchyBoundsListener;
6056 } else if (listenerType == KeyListener.class) {
6057 l = keyListener;
6058 } else if (listenerType == MouseListener.class) {
6059 l = mouseListener;
6060 } else if (listenerType == MouseMotionListener.class) {
6061 l = mouseMotionListener;
6062 } else if (listenerType == MouseWheelListener.class) {
6063 l = mouseWheelListener;
6064 } else if (listenerType == InputMethodListener.class) {
6065 l = inputMethodListener;
6066 } else if (listenerType == PropertyChangeListener.class) {
6067 return (T[])getPropertyChangeListeners();
6068 }
6069 return AWTEventMulticaster.getListeners(l, listenerType);
6070 }
6071
6072 /**
6073 * Gets the input method request handler which supports
6074 * requests from input methods for this component. A component
6075 * that supports on-the-spot text input must override this
6076 * method to return an <code>InputMethodRequests</code> instance.
6077 * At the same time, it also has to handle input method events.
6078 *
6079 * @return the input method request handler for this component,
6080 * <code>null</code> by default
6081 * @see #addInputMethodListener
6082 * @since 1.2
6083 */
6084 public InputMethodRequests getInputMethodRequests() {
6085 return null;
6086 }
6087
6088 /**
6089 * Gets the input context used by this component for handling
6090 * the communication with input methods when text is entered
6091 * in this component. By default, the input context used for
6092 * the parent component is returned. Components may
6093 * override this to return a private input context.
6094 *
6095 * @return the input context used by this component;
6096 * <code>null</code> if no context can be determined
6097 * @since 1.2
6098 */
6099 public InputContext getInputContext() {
6100 Container parent = this.parent;
6101 if (parent == null) {
6102 return null;
6103 } else {
6104 return parent.getInputContext();
6105 }
6106 }
6107
6108 /**
6109 * Enables the events defined by the specified event mask parameter
6110 * to be delivered to this component.
6111 * <p>
6112 * Event types are automatically enabled when a listener for
6113 * that event type is added to the component.
6114 * <p>
6115 * This method only needs to be invoked by subclasses of
6116 * <code>Component</code> which desire to have the specified event
6117 * types delivered to <code>processEvent</code> regardless of whether
6118 * or not a listener is registered.
6119 * @param eventsToEnable the event mask defining the event types
6120 * @see #processEvent
6121 * @see #disableEvents
6122 * @see AWTEvent
6123 * @since 1.1
6124 */
6125 protected final void enableEvents(long eventsToEnable) {
6126 long notifyAncestors = 0;
6127 synchronized (this) {
6128 if ((eventsToEnable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 &&
6129 hierarchyListener == null &&
6130 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) == 0) {
6131 notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK;
6132 }
6133 if ((eventsToEnable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0 &&
6134 hierarchyBoundsListener == null &&
6135 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) == 0) {
6136 notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK;
6137 }
6138 eventMask |= eventsToEnable;
6139 newEventsOnly = true;
6140 }
6141
6142 // if this is a lightweight component, enable mouse events
6143 // in the native container.
6144 if (peer instanceof LightweightPeer) {
6145 parent.proxyEnableEvents(eventMask);
6146 }
6147 if (notifyAncestors != 0) {
6148 synchronized (getTreeLock()) {
6149 adjustListeningChildrenOnParent(notifyAncestors, 1);
6150 }
6151 }
6152 }
6153
6154 /**
6155 * Disables the events defined by the specified event mask parameter
6156 * from being delivered to this component.
6157 * @param eventsToDisable the event mask defining the event types
6158 * @see #enableEvents
6159 * @since 1.1
6160 */
6161 protected final void disableEvents(long eventsToDisable) {
6162 long notifyAncestors = 0;
6163 synchronized (this) {
6164 if ((eventsToDisable & AWTEvent.HIERARCHY_EVENT_MASK) != 0 &&
6165 hierarchyListener == null &&
6166 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0) {
6167 notifyAncestors |= AWTEvent.HIERARCHY_EVENT_MASK;
6168 }
6169 if ((eventsToDisable & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK)!=0 &&
6170 hierarchyBoundsListener == null &&
6171 (eventMask & AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK) != 0) {
6172 notifyAncestors |= AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK;
6173 }
6174 eventMask &= ~eventsToDisable;
6175 }
6176 if (notifyAncestors != 0) {
6177 synchronized (getTreeLock()) {
6178 adjustListeningChildrenOnParent(notifyAncestors, -1);
6179 }
6180 }
6181 }
6182
6183 transient sun.awt.EventQueueItem[] eventCache;
6184
6185 /**
6186 * @see #isCoalescingEnabled
6187 * @see #checkCoalescing
6188 */
6189 transient private boolean coalescingEnabled = checkCoalescing();
6190
6191 /**
6192 * Weak map of known coalesceEvent overriders.
6193 * Value indicates whether overriden.
6194 * Bootstrap classes are not included.
6195 */
6196 private static final Map<Class<?>, Boolean> coalesceMap =
6197 new java.util.WeakHashMap<Class<?>, Boolean>();
6198
6199 /**
6200 * Indicates whether this class overrides coalesceEvents.
6201 * It is assumed that all classes that are loaded from the bootstrap
6202 * do not.
6203 * The bootstrap class loader is assumed to be represented by null.
6204 * We do not check that the method really overrides
6205 * (it might be static, private or package private).
6206 */
6207 private boolean checkCoalescing() {
6208 if (getClass().getClassLoader()==null) {
6209 return false;
6210 }
6211 final Class<? extends Component> clazz = getClass();
6212 synchronized (coalesceMap) {
6213 // Check cache.
6214 Boolean value = coalesceMap.get(clazz);
6215 if (value != null) {
6216 return value;
6217 }
6218
6219 // Need to check non-bootstraps.
6220 Boolean enabled = java.security.AccessController.doPrivileged(
6221 new java.security.PrivilegedAction<Boolean>() {
6222 public Boolean run() {
6223 return isCoalesceEventsOverriden(clazz);
6224 }
6225 }
6226 );
6227 coalesceMap.put(clazz, enabled);
6228 return enabled;
6229 }
6230 }
6231
6232 /**
6233 * Parameter types of coalesceEvents(AWTEvent,AWTEVent).
6234 */
6235 private static final Class<?>[] coalesceEventsParams = {
6236 AWTEvent.class, AWTEvent.class
6237 };
6238
6239 /**
6240 * Indicates whether a class or its superclasses override coalesceEvents.
6241 * Must be called with lock on coalesceMap and privileged.
6242 * @see checkCoalescing
6243 */
6244 private static boolean isCoalesceEventsOverriden(Class<?> clazz) {
6245 assert Thread.holdsLock(coalesceMap);
6246
6247 // First check superclass - we may not need to bother ourselves.
6248 Class<?> superclass = clazz.getSuperclass();
6249 if (superclass == null) {
6250 // Only occurs on implementations that
6251 // do not use null to represent the bootstrap class loader.
6252 return false;
6253 }
6254 if (superclass.getClassLoader() != null) {
6255 Boolean value = coalesceMap.get(superclass);
6256 if (value == null) {
6257 // Not done already - recurse.
6258 if (isCoalesceEventsOverriden(superclass)) {
6259 coalesceMap.put(superclass, true);
6260 return true;
6261 }
6262 } else if (value) {
6263 return true;
6264 }
6265 }
6266
6267 try {
6268 // Throws if not overriden.
6269 clazz.getDeclaredMethod(
6270 "coalesceEvents", coalesceEventsParams
6271 );
6272 return true;
6273 } catch (NoSuchMethodException e) {
6274 // Not present in this class.
6275 return false;
6276 }
6277 }
6278
6279 /**
6280 * Indicates whether coalesceEvents may do something.
6281 */
6282 final boolean isCoalescingEnabled() {
6283 return coalescingEnabled;
6284 }
6285
6286
6287 /**
6288 * Potentially coalesce an event being posted with an existing
6289 * event. This method is called by <code>EventQueue.postEvent</code>
6290 * if an event with the same ID as the event to be posted is found in
6291 * the queue (both events must have this component as their source).
6292 * This method either returns a coalesced event which replaces
6293 * the existing event (and the new event is then discarded), or
6294 * <code>null</code> to indicate that no combining should be done
6295 * (add the second event to the end of the queue). Either event
6296 * parameter may be modified and returned, as the other one is discarded
6297 * unless <code>null</code> is returned.
6298 * <p>
6299 * This implementation of <code>coalesceEvents</code> coalesces
6300 * two event types: mouse move (and drag) events,
6301 * and paint (and update) events.
6302 * For mouse move events the last event is always returned, causing
6303 * intermediate moves to be discarded. For paint events, the new
6304 * event is coalesced into a complex <code>RepaintArea</code> in the peer.
6305 * The new <code>AWTEvent</code> is always returned.
6306 *
6307 * @param existingEvent the event already on the <code>EventQueue</code>
6308 * @param newEvent the event being posted to the
6309 * <code>EventQueue</code>
6310 * @return a coalesced event, or <code>null</code> indicating that no
6311 * coalescing was done
6312 */
6313 protected AWTEvent coalesceEvents(AWTEvent existingEvent,
6314 AWTEvent newEvent) {
6315 return null;
6316 }
6317
6318 /**
6319 * Processes events occurring on this component. By default this
6320 * method calls the appropriate
6321 * <code>process<event type>Event</code>
6322 * method for the given class of event.
6323 * <p>Note that if the event parameter is <code>null</code>
6324 * the behavior is unspecified and may result in an
6325 * exception.
6326 *
6327 * @param e the event
6328 * @see #processComponentEvent
6329 * @see #processFocusEvent
6330 * @see #processKeyEvent
6331 * @see #processMouseEvent
6332 * @see #processMouseMotionEvent
6333 * @see #processInputMethodEvent
6334 * @see #processHierarchyEvent
6335 * @see #processMouseWheelEvent
6336 * @since 1.1
6337 */
6338 protected void processEvent(AWTEvent e) {
6339 if (e instanceof FocusEvent) {
6340 processFocusEvent((FocusEvent)e);
6341
6342 } else if (e instanceof MouseEvent) {
6343 switch(e.getID()) {
6344 case MouseEvent.MOUSE_PRESSED:
6345 case MouseEvent.MOUSE_RELEASED:
6346 case MouseEvent.MOUSE_CLICKED:
6347 case MouseEvent.MOUSE_ENTERED:
6348 case MouseEvent.MOUSE_EXITED:
6349 processMouseEvent((MouseEvent)e);
6350 break;
6351 case MouseEvent.MOUSE_MOVED:
6352 case MouseEvent.MOUSE_DRAGGED:
6353 processMouseMotionEvent((MouseEvent)e);
6354 break;
6355 case MouseEvent.MOUSE_WHEEL:
6356 processMouseWheelEvent((MouseWheelEvent)e);
6357 break;
6358 }
6359
6360 } else if (e instanceof KeyEvent) {
6361 processKeyEvent((KeyEvent)e);
6362
6363 } else if (e instanceof ComponentEvent) {
6364 processComponentEvent((ComponentEvent)e);
6365 } else if (e instanceof InputMethodEvent) {
6366 processInputMethodEvent((InputMethodEvent)e);
6367 } else if (e instanceof HierarchyEvent) {
6368 switch (e.getID()) {
6369 case HierarchyEvent.HIERARCHY_CHANGED:
6370 processHierarchyEvent((HierarchyEvent)e);
6371 break;
6372 case HierarchyEvent.ANCESTOR_MOVED:
6373 case HierarchyEvent.ANCESTOR_RESIZED:
6374 processHierarchyBoundsEvent((HierarchyEvent)e);
6375 break;
6376 }
6377 }
6378 }
6379
6380 /**
6381 * Processes component events occurring on this component by
6382 * dispatching them to any registered
6383 * <code>ComponentListener</code> objects.
6384 * <p>
6385 * This method is not called unless component events are
6386 * enabled for this component. Component events are enabled
6387 * when one of the following occurs:
6388 * <ul>
6389 * <li>A <code>ComponentListener</code> object is registered
6390 * via <code>addComponentListener</code>.
6391 * <li>Component events are enabled via <code>enableEvents</code>.
6392 * </ul>
6393 * <p>Note that if the event parameter is <code>null</code>
6394 * the behavior is unspecified and may result in an
6395 * exception.
6396 *
6397 * @param e the component event
6398 * @see java.awt.event.ComponentEvent
6399 * @see java.awt.event.ComponentListener
6400 * @see #addComponentListener
6401 * @see #enableEvents
6402 * @since 1.1
6403 */
6404 protected void processComponentEvent(ComponentEvent e) {
6405 ComponentListener listener = componentListener;
6406 if (listener != null) {
6407 int id = e.getID();
6408 switch(id) {
6409 case ComponentEvent.COMPONENT_RESIZED:
6410 listener.componentResized(e);
6411 break;
6412 case ComponentEvent.COMPONENT_MOVED:
6413 listener.componentMoved(e);
6414 break;
6415 case ComponentEvent.COMPONENT_SHOWN:
6416 listener.componentShown(e);
6417 break;
6418 case ComponentEvent.COMPONENT_HIDDEN:
6419 listener.componentHidden(e);
6420 break;
6421 }
6422 }
6423 }
6424
6425 /**
6426 * Processes focus events occurring on this component by
6427 * dispatching them to any registered
6428 * <code>FocusListener</code> objects.
6429 * <p>
6430 * This method is not called unless focus events are
6431 * enabled for this component. Focus events are enabled
6432 * when one of the following occurs:
6433 * <ul>
6434 * <li>A <code>FocusListener</code> object is registered
6435 * via <code>addFocusListener</code>.
6436 * <li>Focus events are enabled via <code>enableEvents</code>.
6437 * </ul>
6438 * <p>
6439 * If focus events are enabled for a <code>Component</code>,
6440 * the current <code>KeyboardFocusManager</code> determines
6441 * whether or not a focus event should be dispatched to
6442 * registered <code>FocusListener</code> objects. If the
6443 * events are to be dispatched, the <code>KeyboardFocusManager</code>
6444 * calls the <code>Component</code>'s <code>dispatchEvent</code>
6445 * method, which results in a call to the <code>Component</code>'s
6446 * <code>processFocusEvent</code> method.
6447 * <p>
6448 * If focus events are enabled for a <code>Component</code>, calling
6449 * the <code>Component</code>'s <code>dispatchEvent</code> method
6450 * with a <code>FocusEvent</code> as the argument will result in a
6451 * call to the <code>Component</code>'s <code>processFocusEvent</code>
6452 * method regardless of the current <code>KeyboardFocusManager</code>.
6453 *
6454 * <p>Note that if the event parameter is <code>null</code>
6455 * the behavior is unspecified and may result in an
6456 * exception.
6457 *
6458 * @param e the focus event
6459 * @see java.awt.event.FocusEvent
6460 * @see java.awt.event.FocusListener
6461 * @see java.awt.KeyboardFocusManager
6462 * @see #addFocusListener
6463 * @see #enableEvents
6464 * @see #dispatchEvent
6465 * @since 1.1
6466 */
6467 protected void processFocusEvent(FocusEvent e) {
6468 FocusListener listener = focusListener;
6469 if (listener != null) {
6470 int id = e.getID();
6471 switch(id) {
6472 case FocusEvent.FOCUS_GAINED:
6473 listener.focusGained(e);
6474 break;
6475 case FocusEvent.FOCUS_LOST:
6476 listener.focusLost(e);
6477 break;
6478 }
6479 }
6480 }
6481
6482 /**
6483 * Processes key events occurring on this component by
6484 * dispatching them to any registered
6485 * <code>KeyListener</code> objects.
6486 * <p>
6487 * This method is not called unless key events are
6488 * enabled for this component. Key events are enabled
6489 * when one of the following occurs:
6490 * <ul>
6491 * <li>A <code>KeyListener</code> object is registered
6492 * via <code>addKeyListener</code>.
6493 * <li>Key events are enabled via <code>enableEvents</code>.
6494 * </ul>
6495 *
6496 * <p>
6497 * If key events are enabled for a <code>Component</code>,
6498 * the current <code>KeyboardFocusManager</code> determines
6499 * whether or not a key event should be dispatched to
6500 * registered <code>KeyListener</code> objects. The
6501 * <code>DefaultKeyboardFocusManager</code> will not dispatch
6502 * key events to a <code>Component</code> that is not the focus
6503 * owner or is not showing.
6504 * <p>
6505 * As of J2SE 1.4, <code>KeyEvent</code>s are redirected to
6506 * the focus owner. Please see the
6507 * <a href="doc-files/FocusSpec.html">Focus Specification</a>
6508 * for further information.
6509 * <p>
6510 * Calling a <code>Component</code>'s <code>dispatchEvent</code>
6511 * method with a <code>KeyEvent</code> as the argument will
6512 * result in a call to the <code>Component</code>'s
6513 * <code>processKeyEvent</code> method regardless of the
6514 * current <code>KeyboardFocusManager</code> as long as the
6515 * component is showing, focused, and enabled, and key events
6516 * are enabled on it.
6517 * <p>If the event parameter is <code>null</code>
6518 * the behavior is unspecified and may result in an
6519 * exception.
6520 *
6521 * @param e the key event
6522 * @see java.awt.event.KeyEvent
6523 * @see java.awt.event.KeyListener
6524 * @see java.awt.KeyboardFocusManager
6525 * @see java.awt.DefaultKeyboardFocusManager
6526 * @see #processEvent
6527 * @see #dispatchEvent
6528 * @see #addKeyListener
6529 * @see #enableEvents
6530 * @see #isShowing
6531 * @since 1.1
6532 */
6533 protected void processKeyEvent(KeyEvent e) {
6534 KeyListener listener = keyListener;
6535 if (listener != null) {
6536 int id = e.getID();
6537 switch(id) {
6538 case KeyEvent.KEY_TYPED:
6539 listener.keyTyped(e);
6540 break;
6541 case KeyEvent.KEY_PRESSED:
6542 listener.keyPressed(e);
6543 break;
6544 case KeyEvent.KEY_RELEASED:
6545 listener.keyReleased(e);
6546 break;
6547 }
6548 }
6549 }
6550
6551 /**
6552 * Processes mouse events occurring on this component by
6553 * dispatching them to any registered
6554 * <code>MouseListener</code> objects.
6555 * <p>
6556 * This method is not called unless mouse events are
6557 * enabled for this component. Mouse events are enabled
6558 * when one of the following occurs:
6559 * <ul>
6560 * <li>A <code>MouseListener</code> object is registered
6561 * via <code>addMouseListener</code>.
6562 * <li>Mouse events are enabled via <code>enableEvents</code>.
6563 * </ul>
6564 * <p>Note that if the event parameter is <code>null</code>
6565 * the behavior is unspecified and may result in an
6566 * exception.
6567 *
6568 * @param e the mouse event
6569 * @see java.awt.event.MouseEvent
6570 * @see java.awt.event.MouseListener
6571 * @see #addMouseListener
6572 * @see #enableEvents
6573 * @since 1.1
6574 */
6575 protected void processMouseEvent(MouseEvent e) {
6576 MouseListener listener = mouseListener;
6577 if (listener != null) {
6578 int id = e.getID();
6579 switch(id) {
6580 case MouseEvent.MOUSE_PRESSED:
6581 listener.mousePressed(e);
6582 break;
6583 case MouseEvent.MOUSE_RELEASED:
6584 listener.mouseReleased(e);
6585 break;
6586 case MouseEvent.MOUSE_CLICKED:
6587 listener.mouseClicked(e);
6588 break;
6589 case MouseEvent.MOUSE_EXITED:
6590 listener.mouseExited(e);
6591 break;
6592 case MouseEvent.MOUSE_ENTERED:
6593 listener.mouseEntered(e);
6594 break;
6595 }
6596 }
6597 }
6598
6599 /**
6600 * Processes mouse motion events occurring on this component by
6601 * dispatching them to any registered
6602 * <code>MouseMotionListener</code> objects.
6603 * <p>
6604 * This method is not called unless mouse motion events are
6605 * enabled for this component. Mouse motion events are enabled
6606 * when one of the following occurs:
6607 * <ul>
6608 * <li>A <code>MouseMotionListener</code> object is registered
6609 * via <code>addMouseMotionListener</code>.
6610 * <li>Mouse motion events are enabled via <code>enableEvents</code>.
6611 * </ul>
6612 * <p>Note that if the event parameter is <code>null</code>
6613 * the behavior is unspecified and may result in an
6614 * exception.
6615 *
6616 * @param e the mouse motion event
6617 * @see java.awt.event.MouseEvent
6618 * @see java.awt.event.MouseMotionListener
6619 * @see #addMouseMotionListener
6620 * @see #enableEvents
6621 * @since 1.1
6622 */
6623 protected void processMouseMotionEvent(MouseEvent e) {
6624 MouseMotionListener listener = mouseMotionListener;
6625 if (listener != null) {
6626 int id = e.getID();
6627 switch(id) {
6628 case MouseEvent.MOUSE_MOVED:
6629 listener.mouseMoved(e);
6630 break;
6631 case MouseEvent.MOUSE_DRAGGED:
6632 listener.mouseDragged(e);
6633 break;
6634 }
6635 }
6636 }
6637
6638 /**
6639 * Processes mouse wheel events occurring on this component by
6640 * dispatching them to any registered
6641 * <code>MouseWheelListener</code> objects.
6642 * <p>
6643 * This method is not called unless mouse wheel events are
6644 * enabled for this component. Mouse wheel events are enabled
6645 * when one of the following occurs:
6646 * <ul>
6647 * <li>A <code>MouseWheelListener</code> object is registered
6648 * via <code>addMouseWheelListener</code>.
6649 * <li>Mouse wheel events are enabled via <code>enableEvents</code>.
6650 * </ul>
6651 * <p>
6652 * For information on how mouse wheel events are dispatched, see
6653 * the class description for {@link MouseWheelEvent}.
6654 * <p>
6655 * Note that if the event parameter is <code>null</code>
6656 * the behavior is unspecified and may result in an
6657 * exception.
6658 *
6659 * @param e the mouse wheel event
6660 * @see java.awt.event.MouseWheelEvent
6661 * @see java.awt.event.MouseWheelListener
6662 * @see #addMouseWheelListener
6663 * @see #enableEvents
6664 * @since 1.4
6665 */
6666 protected void processMouseWheelEvent(MouseWheelEvent e) {
6667 MouseWheelListener listener = mouseWheelListener;
6668 if (listener != null) {
6669 int id = e.getID();
6670 switch(id) {
6671 case MouseEvent.MOUSE_WHEEL:
6672 listener.mouseWheelMoved(e);
6673 break;
6674 }
6675 }
6676 }
6677
6678 boolean postsOldMouseEvents() {
6679 return false;
6680 }
6681
6682 /**
6683 * Processes input method events occurring on this component by
6684 * dispatching them to any registered
6685 * <code>InputMethodListener</code> objects.
6686 * <p>
6687 * This method is not called unless input method events
6688 * are enabled for this component. Input method events are enabled
6689 * when one of the following occurs:
6690 * <ul>
6691 * <li>An <code>InputMethodListener</code> object is registered
6692 * via <code>addInputMethodListener</code>.
6693 * <li>Input method events are enabled via <code>enableEvents</code>.
6694 * </ul>
6695 * <p>Note that if the event parameter is <code>null</code>
6696 * the behavior is unspecified and may result in an
6697 * exception.
6698 *
6699 * @param e the input method event
6700 * @see java.awt.event.InputMethodEvent
6701 * @see java.awt.event.InputMethodListener
6702 * @see #addInputMethodListener
6703 * @see #enableEvents
6704 * @since 1.2
6705 */
6706 protected void processInputMethodEvent(InputMethodEvent e) {
6707 InputMethodListener listener = inputMethodListener;
6708 if (listener != null) {
6709 int id = e.getID();
6710 switch (id) {
6711 case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
6712 listener.inputMethodTextChanged(e);
6713 break;
6714 case InputMethodEvent.CARET_POSITION_CHANGED:
6715 listener.caretPositionChanged(e);
6716 break;
6717 }
6718 }
6719 }
6720
6721 /**
6722 * Processes hierarchy events occurring on this component by
6723 * dispatching them to any registered
6724 * <code>HierarchyListener</code> objects.
6725 * <p>
6726 * This method is not called unless hierarchy events
6727 * are enabled for this component. Hierarchy events are enabled
6728 * when one of the following occurs:
6729 * <ul>
6730 * <li>An <code>HierarchyListener</code> object is registered
6731 * via <code>addHierarchyListener</code>.
6732 * <li>Hierarchy events are enabled via <code>enableEvents</code>.
6733 * </ul>
6734 * <p>Note that if the event parameter is <code>null</code>
6735 * the behavior is unspecified and may result in an
6736 * exception.
6737 *
6738 * @param e the hierarchy event
6739 * @see java.awt.event.HierarchyEvent
6740 * @see java.awt.event.HierarchyListener
6741 * @see #addHierarchyListener
6742 * @see #enableEvents
6743 * @since 1.3
6744 */
6745 protected void processHierarchyEvent(HierarchyEvent e) {
6746 HierarchyListener listener = hierarchyListener;
6747 if (listener != null) {
6748 int id = e.getID();
6749 switch (id) {
6750 case HierarchyEvent.HIERARCHY_CHANGED:
6751 listener.hierarchyChanged(e);
6752 break;
6753 }
6754 }
6755 }
6756
6757 /**
6758 * Processes hierarchy bounds events occurring on this component by
6759 * dispatching them to any registered
6760 * <code>HierarchyBoundsListener</code> objects.
6761 * <p>
6762 * This method is not called unless hierarchy bounds events
6763 * are enabled for this component. Hierarchy bounds events are enabled
6764 * when one of the following occurs:
6765 * <ul>
6766 * <li>An <code>HierarchyBoundsListener</code> object is registered
6767 * via <code>addHierarchyBoundsListener</code>.
6768 * <li>Hierarchy bounds events are enabled via <code>enableEvents</code>.
6769 * </ul>
6770 * <p>Note that if the event parameter is <code>null</code>
6771 * the behavior is unspecified and may result in an
6772 * exception.
6773 *
6774 * @param e the hierarchy event
6775 * @see java.awt.event.HierarchyEvent
6776 * @see java.awt.event.HierarchyBoundsListener
6777 * @see #addHierarchyBoundsListener
6778 * @see #enableEvents
6779 * @since 1.3
6780 */
6781 protected void processHierarchyBoundsEvent(HierarchyEvent e) {
6782 HierarchyBoundsListener listener = hierarchyBoundsListener;
6783 if (listener != null) {
6784 int id = e.getID();
6785 switch (id) {
6786 case HierarchyEvent.ANCESTOR_MOVED:
6787 listener.ancestorMoved(e);
6788 break;
6789 case HierarchyEvent.ANCESTOR_RESIZED:
6790 listener.ancestorResized(e);
6791 break;
6792 }
6793 }
6794 }
6795
6796 /**
6797 * @param evt the event to handle
6798 * @return {@code true} if the event was handled, {@code false} otherwise
6799 * @deprecated As of JDK version 1.1
6800 * replaced by processEvent(AWTEvent).
6801 */
6802 @Deprecated
6803 public boolean handleEvent(Event evt) {
6804 switch (evt.id) {
6805 case Event.MOUSE_ENTER:
6806 return mouseEnter(evt, evt.x, evt.y);
6807
6808 case Event.MOUSE_EXIT:
6809 return mouseExit(evt, evt.x, evt.y);
6810
6811 case Event.MOUSE_MOVE:
6812 return mouseMove(evt, evt.x, evt.y);
6813
6814 case Event.MOUSE_DOWN:
6815 return mouseDown(evt, evt.x, evt.y);
6816
6817 case Event.MOUSE_DRAG:
6818 return mouseDrag(evt, evt.x, evt.y);
6819
6820 case Event.MOUSE_UP:
6821 return mouseUp(evt, evt.x, evt.y);
6822
6823 case Event.KEY_PRESS:
6824 case Event.KEY_ACTION:
6825 return keyDown(evt, evt.key);
6826
6827 case Event.KEY_RELEASE:
6828 case Event.KEY_ACTION_RELEASE:
6829 return keyUp(evt, evt.key);
6830
6831 case Event.ACTION_EVENT:
6832 return action(evt, evt.arg);
6833 case Event.GOT_FOCUS:
6834 return gotFocus(evt, evt.arg);
6835 case Event.LOST_FOCUS:
6836 return lostFocus(evt, evt.arg);
6837 }
6838 return false;
6839 }
6840
6841 /**
6842 * @param evt the event to handle
6843 * @param x the x coordinate
6844 * @param y the y coordinate
6845 * @return {@code false}
6846 * @deprecated As of JDK version 1.1,
6847 * replaced by processMouseEvent(MouseEvent).
6848 */
6849 @Deprecated
6850 public boolean mouseDown(Event evt, int x, int y) {
6851 return false;
6852 }
6853
6854 /**
6855 * @param evt the event to handle
6856 * @param x the x coordinate
6857 * @param y the y coordinate
6858 * @return {@code false}
6859 * @deprecated As of JDK version 1.1,
6860 * replaced by processMouseMotionEvent(MouseEvent).
6861 */
6862 @Deprecated
6863 public boolean mouseDrag(Event evt, int x, int y) {
6864 return false;
6865 }
6866
6867 /**
6868 * @param evt the event to handle
6869 * @param x the x coordinate
6870 * @param y the y coordinate
6871 * @return {@code false}
6872 * @deprecated As of JDK version 1.1,
6873 * replaced by processMouseEvent(MouseEvent).
6874 */
6875 @Deprecated
6876 public boolean mouseUp(Event evt, int x, int y) {
6877 return false;
6878 }
6879
6880 /**
6881 * @param evt the event to handle
6882 * @param x the x coordinate
6883 * @param y the y coordinate
6884 * @return {@code false}
6885 * @deprecated As of JDK version 1.1,
6886 * replaced by processMouseMotionEvent(MouseEvent).
6887 */
6888 @Deprecated
6889 public boolean mouseMove(Event evt, int x, int y) {
6890 return false;
6891 }
6892
6893 /**
6894 * @param evt the event to handle
6895 * @param x the x coordinate
6896 * @param y the y coordinate
6897 * @return {@code false}
6898 * @deprecated As of JDK version 1.1,
6899 * replaced by processMouseEvent(MouseEvent).
6900 */
6901 @Deprecated
6902 public boolean mouseEnter(Event evt, int x, int y) {
6903 return false;
6904 }
6905
6906 /**
6907 * @param evt the event to handle
6908 * @param x the x coordinate
6909 * @param y the y coordinate
6910 * @return {@code false}
6911 * @deprecated As of JDK version 1.1,
6912 * replaced by processMouseEvent(MouseEvent).
6913 */
6914 @Deprecated
6915 public boolean mouseExit(Event evt, int x, int y) {
6916 return false;
6917 }
6918
6919 /**
6920 * @param evt the event to handle
6921 * @param key the key pressed
6922 * @return {@code false}
6923 * @deprecated As of JDK version 1.1,
6924 * replaced by processKeyEvent(KeyEvent).
6925 */
6926 @Deprecated
6927 public boolean keyDown(Event evt, int key) {
6928 return false;
6929 }
6930
6931 /**
6932 * @param evt the event to handle
6933 * @param key the key pressed
6934 * @return {@code false}
6935 * @deprecated As of JDK version 1.1,
6936 * replaced by processKeyEvent(KeyEvent).
6937 */
6938 @Deprecated
6939 public boolean keyUp(Event evt, int key) {
6940 return false;
6941 }
6942
6943 /**
6944 * @param evt the event to handle
6945 * @param what the object acted on
6946 * @return {@code false}
6947 * @deprecated As of JDK version 1.1,
6948 * should register this component as ActionListener on component
6949 * which fires action events.
6950 */
6951 @Deprecated
6952 public boolean action(Event evt, Object what) {
6953 return false;
6954 }
6955
6956 /**
6957 * Makes this <code>Component</code> displayable by connecting it to a
6958 * native screen resource.
6959 * This method is called internally by the toolkit and should
6960 * not be called directly by programs.
6961 * <p>
6962 * This method changes layout-related information, and therefore,
6963 * invalidates the component hierarchy.
6964 *
6965 * @see #isDisplayable
6966 * @see #removeNotify
6967 * @see #invalidate
6968 * @since 1.0
6969 */
6970 public void addNotify() {
6971 synchronized (getTreeLock()) {
6972 ComponentPeer peer = this.peer;
6973 if (peer == null || peer instanceof LightweightPeer){
6974 if (peer == null) {
6975 // Update both the Component's peer variable and the local
6976 // variable we use for thread safety.
6977 this.peer = peer = getComponentFactory().createComponent(this);
6978 }
6979
6980 // This is a lightweight component which means it won't be
6981 // able to get window-related events by itself. If any
6982 // have been enabled, then the nearest native container must
6983 // be enabled.
6984 if (parent != null) {
6985 long mask = 0;
6986 if ((mouseListener != null) || ((eventMask & AWTEvent.MOUSE_EVENT_MASK) != 0)) {
6987 mask |= AWTEvent.MOUSE_EVENT_MASK;
6988 }
6989 if ((mouseMotionListener != null) ||
6990 ((eventMask & AWTEvent.MOUSE_MOTION_EVENT_MASK) != 0)) {
6991 mask |= AWTEvent.MOUSE_MOTION_EVENT_MASK;
6992 }
6993 if ((mouseWheelListener != null ) ||
6994 ((eventMask & AWTEvent.MOUSE_WHEEL_EVENT_MASK) != 0)) {
6995 mask |= AWTEvent.MOUSE_WHEEL_EVENT_MASK;
6996 }
6997 if (focusListener != null || (eventMask & AWTEvent.FOCUS_EVENT_MASK) != 0) {
6998 mask |= AWTEvent.FOCUS_EVENT_MASK;
6999 }
7000 if (keyListener != null || (eventMask & AWTEvent.KEY_EVENT_MASK) != 0) {
7001 mask |= AWTEvent.KEY_EVENT_MASK;
7002 }
7003 if (mask != 0) {
7004 parent.proxyEnableEvents(mask);
7005 }
7006 }
7007 } else {
7008 // It's native. If the parent is lightweight it will need some
7009 // help.
7010 Container parent = getContainer();
7011 if (parent != null && parent.isLightweight()) {
7012 relocateComponent();
7013 if (!parent.isRecursivelyVisibleUpToHeavyweightContainer())
7014 {
7015 peer.setVisible(false);
7016 }
7017 }
7018 }
7019 invalidate();
7020
7021 int npopups = (popups != null? popups.size() : 0);
7022 for (int i = 0 ; i < npopups ; i++) {
7023 PopupMenu popup = popups.elementAt(i);
7024 popup.addNotify();
7025 }
7026
7027 if (dropTarget != null) dropTarget.addNotify();
7028
7029 peerFont = getFont();
7030
7031 if (getContainer() != null && !isAddNotifyComplete) {
7032 getContainer().increaseComponentCount(this);
7033 }
7034
7035
7036 // Update stacking order
7037 updateZOrder();
7038
7039 if (!isAddNotifyComplete) {
7040 mixOnShowing();
7041 }
7042
7043 isAddNotifyComplete = true;
7044
7045 if (hierarchyListener != null ||
7046 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
7047 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) {
7048 HierarchyEvent e =
7049 new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED,
7050 this, parent,
7051 HierarchyEvent.DISPLAYABILITY_CHANGED |
7052 ((isRecursivelyVisible())
7053 ? HierarchyEvent.SHOWING_CHANGED
7054 : 0));
7055 dispatchEvent(e);
7056 }
7057 }
7058 }
7059
7060 /**
7061 * Makes this <code>Component</code> undisplayable by destroying it native
7062 * screen resource.
7063 * <p>
7064 * This method is called by the toolkit internally and should
7065 * not be called directly by programs. Code overriding
7066 * this method should call <code>super.removeNotify</code> as
7067 * the first line of the overriding method.
7068 *
7069 * @see #isDisplayable
7070 * @see #addNotify
7071 * @since 1.0
7072 */
7073 public void removeNotify() {
7074 KeyboardFocusManager.clearMostRecentFocusOwner(this);
7075 if (KeyboardFocusManager.getCurrentKeyboardFocusManager().
7076 getPermanentFocusOwner() == this)
7077 {
7078 KeyboardFocusManager.getCurrentKeyboardFocusManager().
7079 setGlobalPermanentFocusOwner(null);
7080 }
7081
7082 synchronized (getTreeLock()) {
7083 if (isFocusOwner() && KeyboardFocusManager.isAutoFocusTransferEnabledFor(this)) {
7084 transferFocus(true);
7085 }
7086
7087 if (getContainer() != null && isAddNotifyComplete) {
7088 getContainer().decreaseComponentCount(this);
7089 }
7090
7091 int npopups = (popups != null? popups.size() : 0);
7092 for (int i = 0 ; i < npopups ; i++) {
7093 PopupMenu popup = popups.elementAt(i);
7094 popup.removeNotify();
7095 }
7096 // If there is any input context for this component, notify
7097 // that this component is being removed. (This has to be done
7098 // before hiding peer.)
7099 if ((eventMask & AWTEvent.INPUT_METHODS_ENABLED_MASK) != 0) {
7100 InputContext inputContext = getInputContext();
7101 if (inputContext != null) {
7102 inputContext.removeNotify(this);
7103 }
7104 }
7105
7106 ComponentPeer p = peer;
7107 if (p != null) {
7108 boolean isLightweight = isLightweight();
7109
7110 if (bufferStrategy instanceof FlipBufferStrategy) {
7111 ((FlipBufferStrategy)bufferStrategy).destroyBuffers();
7112 }
7113
7114 if (dropTarget != null) dropTarget.removeNotify();
7115
7116 // Hide peer first to stop system events such as cursor moves.
7117 if (visible) {
7118 p.setVisible(false);
7119 }
7120
7121 peer = null; // Stop peer updates.
7122 peerFont = null;
7123
7124 Toolkit.getEventQueue().removeSourceEvents(this, false);
7125 KeyboardFocusManager.getCurrentKeyboardFocusManager().
7126 discardKeyEvents(this);
7127
7128 p.dispose();
7129
7130 mixOnHiding(isLightweight);
7131
7132 isAddNotifyComplete = false;
7133 // Nullifying compoundShape means that the component has normal shape
7134 // (or has no shape at all).
7135 this.compoundShape = null;
7136 }
7137
7138 if (hierarchyListener != null ||
7139 (eventMask & AWTEvent.HIERARCHY_EVENT_MASK) != 0 ||
7140 Toolkit.enabledOnToolkit(AWTEvent.HIERARCHY_EVENT_MASK)) {
7141 HierarchyEvent e =
7142 new HierarchyEvent(this, HierarchyEvent.HIERARCHY_CHANGED,
7143 this, parent,
7144 HierarchyEvent.DISPLAYABILITY_CHANGED |
7145 ((isRecursivelyVisible())
7146 ? HierarchyEvent.SHOWING_CHANGED
7147 : 0));
7148 dispatchEvent(e);
7149 }
7150 }
7151 }
7152
7153 /**
7154 * @param evt the event to handle
7155 * @param what the object focused
7156 * @return {@code false}
7157 * @deprecated As of JDK version 1.1,
7158 * replaced by processFocusEvent(FocusEvent).
7159 */
7160 @Deprecated
7161 public boolean gotFocus(Event evt, Object what) {
7162 return false;
7163 }
7164
7165 /**
7166 * @param evt the event to handle
7167 * @param what the object focused
7168 * @return {@code false}
7169 * @deprecated As of JDK version 1.1,
7170 * replaced by processFocusEvent(FocusEvent).
7171 */
7172 @Deprecated
7173 public boolean lostFocus(Event evt, Object what) {
7174 return false;
7175 }
7176
7177 /**
7178 * Returns whether this <code>Component</code> can become the focus
7179 * owner.
7180 *
7181 * @return <code>true</code> if this <code>Component</code> is
7182 * focusable; <code>false</code> otherwise
7183 * @see #setFocusable
7184 * @since 1.1
7185 * @deprecated As of 1.4, replaced by <code>isFocusable()</code>.
7186 */
7187 @Deprecated
7188 public boolean isFocusTraversable() {
7189 if (isFocusTraversableOverridden == FOCUS_TRAVERSABLE_UNKNOWN) {
7190 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_DEFAULT;
7191 }
7192 return focusable;
7193 }
7194
7195 /**
7196 * Returns whether this Component can be focused.
7197 *
7198 * @return <code>true</code> if this Component is focusable;
7199 * <code>false</code> otherwise.
7200 * @see #setFocusable
7201 * @since 1.4
7202 */
7203 public boolean isFocusable() {
7204 return isFocusTraversable();
7205 }
7206
7207 /**
7208 * Sets the focusable state of this Component to the specified value. This
7209 * value overrides the Component's default focusability.
7210 *
7211 * @param focusable indicates whether this Component is focusable
7212 * @see #isFocusable
7213 * @since 1.4
7214 * @beaninfo
7215 * bound: true
7216 */
7217 public void setFocusable(boolean focusable) {
7218 boolean oldFocusable;
7219 synchronized (this) {
7220 oldFocusable = this.focusable;
7221 this.focusable = focusable;
7222 }
7223 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_SET;
7224
7225 firePropertyChange("focusable", oldFocusable, focusable);
7226 if (oldFocusable && !focusable) {
7227 if (isFocusOwner() && KeyboardFocusManager.isAutoFocusTransferEnabled()) {
7228 transferFocus(true);
7229 }
7230 KeyboardFocusManager.clearMostRecentFocusOwner(this);
7231 }
7232 }
7233
7234 final boolean isFocusTraversableOverridden() {
7235 return (isFocusTraversableOverridden != FOCUS_TRAVERSABLE_DEFAULT);
7236 }
7237
7238 /**
7239 * Sets the focus traversal keys for a given traversal operation for this
7240 * Component.
7241 * <p>
7242 * The default values for a Component's focus traversal keys are
7243 * implementation-dependent. Sun recommends that all implementations for a
7244 * particular native platform use the same default values. The
7245 * recommendations for Windows and Unix are listed below. These
7246 * recommendations are used in the Sun AWT implementations.
7247 *
7248 * <table border=1 summary="Recommended default values for a Component's focus traversal keys">
7249 * <tr>
7250 * <th>Identifier</th>
7251 * <th>Meaning</th>
7252 * <th>Default</th>
7253 * </tr>
7254 * <tr>
7255 * <td>KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS</td>
7256 * <td>Normal forward keyboard traversal</td>
7257 * <td>TAB on KEY_PRESSED, CTRL-TAB on KEY_PRESSED</td>
7258 * </tr>
7259 * <tr>
7260 * <td>KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS</td>
7261 * <td>Normal reverse keyboard traversal</td>
7262 * <td>SHIFT-TAB on KEY_PRESSED, CTRL-SHIFT-TAB on KEY_PRESSED</td>
7263 * </tr>
7264 * <tr>
7265 * <td>KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS</td>
7266 * <td>Go up one focus traversal cycle</td>
7267 * <td>none</td>
7268 * </tr>
7269 * </table>
7270 *
7271 * To disable a traversal key, use an empty Set; Collections.EMPTY_SET is
7272 * recommended.
7273 * <p>
7274 * Using the AWTKeyStroke API, client code can specify on which of two
7275 * specific KeyEvents, KEY_PRESSED or KEY_RELEASED, the focus traversal
7276 * operation will occur. Regardless of which KeyEvent is specified,
7277 * however, all KeyEvents related to the focus traversal key, including the
7278 * associated KEY_TYPED event, will be consumed, and will not be dispatched
7279 * to any Component. It is a runtime error to specify a KEY_TYPED event as
7280 * mapping to a focus traversal operation, or to map the same event to
7281 * multiple default focus traversal operations.
7282 * <p>
7283 * If a value of null is specified for the Set, this Component inherits the
7284 * Set from its parent. If all ancestors of this Component have null
7285 * specified for the Set, then the current KeyboardFocusManager's default
7286 * Set is used.
7287 * <p>
7288 * This method may throw a {@code ClassCastException} if any {@code Object}
7289 * in {@code keystrokes} is not an {@code AWTKeyStroke}.
7290 *
7291 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7292 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7293 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
7294 * @param keystrokes the Set of AWTKeyStroke for the specified operation
7295 * @see #getFocusTraversalKeys
7296 * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
7297 * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
7298 * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
7299 * @throws IllegalArgumentException if id is not one of
7300 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7301 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7302 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or if keystrokes
7303 * contains null, or if any keystroke represents a KEY_TYPED event,
7304 * or if any keystroke already maps to another focus traversal
7305 * operation for this Component
7306 * @since 1.4
7307 * @beaninfo
7308 * bound: true
7309 */
7310 public void setFocusTraversalKeys(int id,
7311 Set<? extends AWTKeyStroke> keystrokes)
7312 {
7313 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
7314 throw new IllegalArgumentException("invalid focus traversal key identifier");
7315 }
7316
7317 setFocusTraversalKeys_NoIDCheck(id, keystrokes);
7318 }
7319
7320 /**
7321 * Returns the Set of focus traversal keys for a given traversal operation
7322 * for this Component. (See
7323 * <code>setFocusTraversalKeys</code> for a full description of each key.)
7324 * <p>
7325 * If a Set of traversal keys has not been explicitly defined for this
7326 * Component, then this Component's parent's Set is returned. If no Set
7327 * has been explicitly defined for any of this Component's ancestors, then
7328 * the current KeyboardFocusManager's default Set is returned.
7329 *
7330 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7331 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7332 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
7333 * @return the Set of AWTKeyStrokes for the specified operation. The Set
7334 * will be unmodifiable, and may be empty. null will never be
7335 * returned.
7336 * @see #setFocusTraversalKeys
7337 * @see KeyboardFocusManager#FORWARD_TRAVERSAL_KEYS
7338 * @see KeyboardFocusManager#BACKWARD_TRAVERSAL_KEYS
7339 * @see KeyboardFocusManager#UP_CYCLE_TRAVERSAL_KEYS
7340 * @throws IllegalArgumentException if id is not one of
7341 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7342 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7343 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
7344 * @since 1.4
7345 */
7346 public Set<AWTKeyStroke> getFocusTraversalKeys(int id) {
7347 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
7348 throw new IllegalArgumentException("invalid focus traversal key identifier");
7349 }
7350
7351 return getFocusTraversalKeys_NoIDCheck(id);
7352 }
7353
7354 // We define these methods so that Container does not need to repeat this
7355 // code. Container cannot call super.<method> because Container allows
7356 // DOWN_CYCLE_TRAVERSAL_KEY while Component does not. The Component method
7357 // would erroneously generate an IllegalArgumentException for
7358 // DOWN_CYCLE_TRAVERSAL_KEY.
7359 final void setFocusTraversalKeys_NoIDCheck(int id, Set<? extends AWTKeyStroke> keystrokes) {
7360 Set<AWTKeyStroke> oldKeys;
7361
7362 synchronized (this) {
7363 if (focusTraversalKeys == null) {
7364 initializeFocusTraversalKeys();
7365 }
7366
7367 if (keystrokes != null) {
7368 for (AWTKeyStroke keystroke : keystrokes ) {
7369
7370 if (keystroke == null) {
7371 throw new IllegalArgumentException("cannot set null focus traversal key");
7372 }
7373
7374 if (keystroke.getKeyChar() != KeyEvent.CHAR_UNDEFINED) {
7375 throw new IllegalArgumentException("focus traversal keys cannot map to KEY_TYPED events");
7376 }
7377
7378 for (int i = 0; i < focusTraversalKeys.length; i++) {
7379 if (i == id) {
7380 continue;
7381 }
7382
7383 if (getFocusTraversalKeys_NoIDCheck(i).contains(keystroke))
7384 {
7385 throw new IllegalArgumentException("focus traversal keys must be unique for a Component");
7386 }
7387 }
7388 }
7389 }
7390
7391 oldKeys = focusTraversalKeys[id];
7392 focusTraversalKeys[id] = (keystrokes != null)
7393 ? Collections.unmodifiableSet(new HashSet<AWTKeyStroke>(keystrokes))
7394 : null;
7395 }
7396
7397 firePropertyChange(focusTraversalKeyPropertyNames[id], oldKeys,
7398 keystrokes);
7399 }
7400 final Set<AWTKeyStroke> getFocusTraversalKeys_NoIDCheck(int id) {
7401 // Okay to return Set directly because it is an unmodifiable view
7402 @SuppressWarnings("unchecked")
7403 Set<AWTKeyStroke> keystrokes = (focusTraversalKeys != null)
7404 ? focusTraversalKeys[id]
7405 : null;
7406
7407 if (keystrokes != null) {
7408 return keystrokes;
7409 } else {
7410 Container parent = this.parent;
7411 if (parent != null) {
7412 return parent.getFocusTraversalKeys(id);
7413 } else {
7414 return KeyboardFocusManager.getCurrentKeyboardFocusManager().
7415 getDefaultFocusTraversalKeys(id);
7416 }
7417 }
7418 }
7419
7420 /**
7421 * Returns whether the Set of focus traversal keys for the given focus
7422 * traversal operation has been explicitly defined for this Component. If
7423 * this method returns <code>false</code>, this Component is inheriting the
7424 * Set from an ancestor, or from the current KeyboardFocusManager.
7425 *
7426 * @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7427 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7428 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
7429 * @return <code>true</code> if the Set of focus traversal keys for the
7430 * given focus traversal operation has been explicitly defined for
7431 * this Component; <code>false</code> otherwise.
7432 * @throws IllegalArgumentException if id is not one of
7433 * KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
7434 * KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or
7435 * KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS
7436 * @since 1.4
7437 */
7438 public boolean areFocusTraversalKeysSet(int id) {
7439 if (id < 0 || id >= KeyboardFocusManager.TRAVERSAL_KEY_LENGTH - 1) {
7440 throw new IllegalArgumentException("invalid focus traversal key identifier");
7441 }
7442
7443 return (focusTraversalKeys != null && focusTraversalKeys[id] != null);
7444 }
7445
7446 /**
7447 * Sets whether focus traversal keys are enabled for this Component.
7448 * Components for which focus traversal keys are disabled receive key
7449 * events for focus traversal keys. Components for which focus traversal
7450 * keys are enabled do not see these events; instead, the events are
7451 * automatically converted to traversal operations.
7452 *
7453 * @param focusTraversalKeysEnabled whether focus traversal keys are
7454 * enabled for this Component
7455 * @see #getFocusTraversalKeysEnabled
7456 * @see #setFocusTraversalKeys
7457 * @see #getFocusTraversalKeys
7458 * @since 1.4
7459 * @beaninfo
7460 * bound: true
7461 */
7462 public void setFocusTraversalKeysEnabled(boolean
7463 focusTraversalKeysEnabled) {
7464 boolean oldFocusTraversalKeysEnabled;
7465 synchronized (this) {
7466 oldFocusTraversalKeysEnabled = this.focusTraversalKeysEnabled;
7467 this.focusTraversalKeysEnabled = focusTraversalKeysEnabled;
7468 }
7469 firePropertyChange("focusTraversalKeysEnabled",
7470 oldFocusTraversalKeysEnabled,
7471 focusTraversalKeysEnabled);
7472 }
7473
7474 /**
7475 * Returns whether focus traversal keys are enabled for this Component.
7476 * Components for which focus traversal keys are disabled receive key
7477 * events for focus traversal keys. Components for which focus traversal
7478 * keys are enabled do not see these events; instead, the events are
7479 * automatically converted to traversal operations.
7480 *
7481 * @return whether focus traversal keys are enabled for this Component
7482 * @see #setFocusTraversalKeysEnabled
7483 * @see #setFocusTraversalKeys
7484 * @see #getFocusTraversalKeys
7485 * @since 1.4
7486 */
7487 public boolean getFocusTraversalKeysEnabled() {
7488 return focusTraversalKeysEnabled;
7489 }
7490
7491 /**
7492 * Requests that this Component get the input focus, and that this
7493 * Component's top-level ancestor become the focused Window. This
7494 * component must be displayable, focusable, visible and all of
7495 * its ancestors (with the exception of the top-level Window) must
7496 * be visible for the request to be granted. Every effort will be
7497 * made to honor the request; however, in some cases it may be
7498 * impossible to do so. Developers must never assume that this
7499 * Component is the focus owner until this Component receives a
7500 * FOCUS_GAINED event. If this request is denied because this
7501 * Component's top-level Window cannot become the focused Window,
7502 * the request will be remembered and will be granted when the
7503 * Window is later focused by the user.
7504 * <p>
7505 * This method cannot be used to set the focus owner to no Component at
7506 * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner()</code>
7507 * instead.
7508 * <p>
7509 * Because the focus behavior of this method is platform-dependent,
7510 * developers are strongly encouraged to use
7511 * <code>requestFocusInWindow</code> when possible.
7512 *
7513 * <p>Note: Not all focus transfers result from invoking this method. As
7514 * such, a component may receive focus without this or any of the other
7515 * {@code requestFocus} methods of {@code Component} being invoked.
7516 *
7517 * @see #requestFocusInWindow
7518 * @see java.awt.event.FocusEvent
7519 * @see #addFocusListener
7520 * @see #isFocusable
7521 * @see #isDisplayable
7522 * @see KeyboardFocusManager#clearGlobalFocusOwner
7523 * @since 1.0
7524 */
7525 public void requestFocus() {
7526 requestFocusHelper(false, true);
7527 }
7528
7529 boolean requestFocus(CausedFocusEvent.Cause cause) {
7530 return requestFocusHelper(false, true, cause);
7531 }
7532
7533 /**
7534 * Requests that this <code>Component</code> get the input focus,
7535 * and that this <code>Component</code>'s top-level ancestor
7536 * become the focused <code>Window</code>. This component must be
7537 * displayable, focusable, visible and all of its ancestors (with
7538 * the exception of the top-level Window) must be visible for the
7539 * request to be granted. Every effort will be made to honor the
7540 * request; however, in some cases it may be impossible to do
7541 * so. Developers must never assume that this component is the
7542 * focus owner until this component receives a FOCUS_GAINED
7543 * event. If this request is denied because this component's
7544 * top-level window cannot become the focused window, the request
7545 * will be remembered and will be granted when the window is later
7546 * focused by the user.
7547 * <p>
7548 * This method returns a boolean value. If <code>false</code> is returned,
7549 * the request is <b>guaranteed to fail</b>. If <code>true</code> is
7550 * returned, the request will succeed <b>unless</b> it is vetoed, or an
7551 * extraordinary event, such as disposal of the component's peer, occurs
7552 * before the request can be granted by the native windowing system. Again,
7553 * while a return value of <code>true</code> indicates that the request is
7554 * likely to succeed, developers must never assume that this component is
7555 * the focus owner until this component receives a FOCUS_GAINED event.
7556 * <p>
7557 * This method cannot be used to set the focus owner to no component at
7558 * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner</code>
7559 * instead.
7560 * <p>
7561 * Because the focus behavior of this method is platform-dependent,
7562 * developers are strongly encouraged to use
7563 * <code>requestFocusInWindow</code> when possible.
7564 * <p>
7565 * Every effort will be made to ensure that <code>FocusEvent</code>s
7566 * generated as a
7567 * result of this request will have the specified temporary value. However,
7568 * because specifying an arbitrary temporary state may not be implementable
7569 * on all native windowing systems, correct behavior for this method can be
7570 * guaranteed only for lightweight <code>Component</code>s.
7571 * This method is not intended
7572 * for general use, but exists instead as a hook for lightweight component
7573 * libraries, such as Swing.
7574 *
7575 * <p>Note: Not all focus transfers result from invoking this method. As
7576 * such, a component may receive focus without this or any of the other
7577 * {@code requestFocus} methods of {@code Component} being invoked.
7578 *
7579 * @param temporary true if the focus change is temporary,
7580 * such as when the window loses the focus; for
7581 * more information on temporary focus changes see the
7582 *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
7583 * @return <code>false</code> if the focus change request is guaranteed to
7584 * fail; <code>true</code> if it is likely to succeed
7585 * @see java.awt.event.FocusEvent
7586 * @see #addFocusListener
7587 * @see #isFocusable
7588 * @see #isDisplayable
7589 * @see KeyboardFocusManager#clearGlobalFocusOwner
7590 * @since 1.4
7591 */
7592 protected boolean requestFocus(boolean temporary) {
7593 return requestFocusHelper(temporary, true);
7594 }
7595
7596 boolean requestFocus(boolean temporary, CausedFocusEvent.Cause cause) {
7597 return requestFocusHelper(temporary, true, cause);
7598 }
7599 /**
7600 * Requests that this Component get the input focus, if this
7601 * Component's top-level ancestor is already the focused
7602 * Window. This component must be displayable, focusable, visible
7603 * and all of its ancestors (with the exception of the top-level
7604 * Window) must be visible for the request to be granted. Every
7605 * effort will be made to honor the request; however, in some
7606 * cases it may be impossible to do so. Developers must never
7607 * assume that this Component is the focus owner until this
7608 * Component receives a FOCUS_GAINED event.
7609 * <p>
7610 * This method returns a boolean value. If <code>false</code> is returned,
7611 * the request is <b>guaranteed to fail</b>. If <code>true</code> is
7612 * returned, the request will succeed <b>unless</b> it is vetoed, or an
7613 * extraordinary event, such as disposal of the Component's peer, occurs
7614 * before the request can be granted by the native windowing system. Again,
7615 * while a return value of <code>true</code> indicates that the request is
7616 * likely to succeed, developers must never assume that this Component is
7617 * the focus owner until this Component receives a FOCUS_GAINED event.
7618 * <p>
7619 * This method cannot be used to set the focus owner to no Component at
7620 * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner()</code>
7621 * instead.
7622 * <p>
7623 * The focus behavior of this method can be implemented uniformly across
7624 * platforms, and thus developers are strongly encouraged to use this
7625 * method over <code>requestFocus</code> when possible. Code which relies
7626 * on <code>requestFocus</code> may exhibit different focus behavior on
7627 * different platforms.
7628 *
7629 * <p>Note: Not all focus transfers result from invoking this method. As
7630 * such, a component may receive focus without this or any of the other
7631 * {@code requestFocus} methods of {@code Component} being invoked.
7632 *
7633 * @return <code>false</code> if the focus change request is guaranteed to
7634 * fail; <code>true</code> if it is likely to succeed
7635 * @see #requestFocus
7636 * @see java.awt.event.FocusEvent
7637 * @see #addFocusListener
7638 * @see #isFocusable
7639 * @see #isDisplayable
7640 * @see KeyboardFocusManager#clearGlobalFocusOwner
7641 * @since 1.4
7642 */
7643 public boolean requestFocusInWindow() {
7644 return requestFocusHelper(false, false);
7645 }
7646
7647 boolean requestFocusInWindow(CausedFocusEvent.Cause cause) {
7648 return requestFocusHelper(false, false, cause);
7649 }
7650
7651 /**
7652 * Requests that this <code>Component</code> get the input focus,
7653 * if this <code>Component</code>'s top-level ancestor is already
7654 * the focused <code>Window</code>. This component must be
7655 * displayable, focusable, visible and all of its ancestors (with
7656 * the exception of the top-level Window) must be visible for the
7657 * request to be granted. Every effort will be made to honor the
7658 * request; however, in some cases it may be impossible to do
7659 * so. Developers must never assume that this component is the
7660 * focus owner until this component receives a FOCUS_GAINED event.
7661 * <p>
7662 * This method returns a boolean value. If <code>false</code> is returned,
7663 * the request is <b>guaranteed to fail</b>. If <code>true</code> is
7664 * returned, the request will succeed <b>unless</b> it is vetoed, or an
7665 * extraordinary event, such as disposal of the component's peer, occurs
7666 * before the request can be granted by the native windowing system. Again,
7667 * while a return value of <code>true</code> indicates that the request is
7668 * likely to succeed, developers must never assume that this component is
7669 * the focus owner until this component receives a FOCUS_GAINED event.
7670 * <p>
7671 * This method cannot be used to set the focus owner to no component at
7672 * all. Use <code>KeyboardFocusManager.clearGlobalFocusOwner</code>
7673 * instead.
7674 * <p>
7675 * The focus behavior of this method can be implemented uniformly across
7676 * platforms, and thus developers are strongly encouraged to use this
7677 * method over <code>requestFocus</code> when possible. Code which relies
7678 * on <code>requestFocus</code> may exhibit different focus behavior on
7679 * different platforms.
7680 * <p>
7681 * Every effort will be made to ensure that <code>FocusEvent</code>s
7682 * generated as a
7683 * result of this request will have the specified temporary value. However,
7684 * because specifying an arbitrary temporary state may not be implementable
7685 * on all native windowing systems, correct behavior for this method can be
7686 * guaranteed only for lightweight components. This method is not intended
7687 * for general use, but exists instead as a hook for lightweight component
7688 * libraries, such as Swing.
7689 *
7690 * <p>Note: Not all focus transfers result from invoking this method. As
7691 * such, a component may receive focus without this or any of the other
7692 * {@code requestFocus} methods of {@code Component} being invoked.
7693 *
7694 * @param temporary true if the focus change is temporary,
7695 * such as when the window loses the focus; for
7696 * more information on temporary focus changes see the
7697 *<a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
7698 * @return <code>false</code> if the focus change request is guaranteed to
7699 * fail; <code>true</code> if it is likely to succeed
7700 * @see #requestFocus
7701 * @see java.awt.event.FocusEvent
7702 * @see #addFocusListener
7703 * @see #isFocusable
7704 * @see #isDisplayable
7705 * @see KeyboardFocusManager#clearGlobalFocusOwner
7706 * @since 1.4
7707 */
7708 protected boolean requestFocusInWindow(boolean temporary) {
7709 return requestFocusHelper(temporary, false);
7710 }
7711
7712 boolean requestFocusInWindow(boolean temporary, CausedFocusEvent.Cause cause) {
7713 return requestFocusHelper(temporary, false, cause);
7714 }
7715
7716 final boolean requestFocusHelper(boolean temporary,
7717 boolean focusedWindowChangeAllowed) {
7718 return requestFocusHelper(temporary, focusedWindowChangeAllowed, CausedFocusEvent.Cause.UNKNOWN);
7719 }
7720
7721 final boolean requestFocusHelper(boolean temporary,
7722 boolean focusedWindowChangeAllowed,
7723 CausedFocusEvent.Cause cause)
7724 {
7725 // 1) Check if the event being dispatched is a system-generated mouse event.
7726 AWTEvent currentEvent = EventQueue.getCurrentEvent();
7727 if (currentEvent instanceof MouseEvent &&
7728 SunToolkit.isSystemGenerated(currentEvent))
7729 {
7730 // 2) Sanity check: if the mouse event component source belongs to the same containing window.
7731 Component source = ((MouseEvent)currentEvent).getComponent();
7732 if (source == null || source.getContainingWindow() == getContainingWindow()) {
7733 focusLog.finest("requesting focus by mouse event \"in window\"");
7734
7735 // If both the conditions are fulfilled the focus request should be strictly
7736 // bounded by the toplevel window. It's assumed that the mouse event activates
7737 // the window (if it wasn't active) and this makes it possible for a focus
7738 // request with a strong in-window requirement to change focus in the bounds
7739 // of the toplevel. If, by any means, due to asynchronous nature of the event
7740 // dispatching mechanism, the window happens to be natively inactive by the time
7741 // this focus request is eventually handled, it should not re-activate the
7742 // toplevel. Otherwise the result may not meet user expectations. See 6981400.
7743 focusedWindowChangeAllowed = false;
7744 }
7745 }
7746 if (!isRequestFocusAccepted(temporary, focusedWindowChangeAllowed, cause)) {
7747 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7748 focusLog.finest("requestFocus is not accepted");
7749 }
7750 return false;
7751 }
7752 // Update most-recent map
7753 KeyboardFocusManager.setMostRecentFocusOwner(this);
7754
7755 Component window = this;
7756 while ( (window != null) && !(window instanceof Window)) {
7757 if (!window.isVisible()) {
7758 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7759 focusLog.finest("component is recursively invisible");
7760 }
7761 return false;
7762 }
7763 window = window.parent;
7764 }
7765
7766 ComponentPeer peer = this.peer;
7767 Component heavyweight = (peer instanceof LightweightPeer)
7768 ? getNativeContainer() : this;
7769 if (heavyweight == null || !heavyweight.isVisible()) {
7770 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7771 focusLog.finest("Component is not a part of visible hierarchy");
7772 }
7773 return false;
7774 }
7775 peer = heavyweight.peer;
7776 if (peer == null) {
7777 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7778 focusLog.finest("Peer is null");
7779 }
7780 return false;
7781 }
7782
7783 // Focus this Component
7784 long time = 0;
7785 if (EventQueue.isDispatchThread()) {
7786 time = Toolkit.getEventQueue().getMostRecentKeyEventTime();
7787 } else {
7788 // A focus request made from outside EDT should not be associated with any event
7789 // and so its time stamp is simply set to the current time.
7790 time = System.currentTimeMillis();
7791 }
7792
7793 boolean success = peer.requestFocus
7794 (this, temporary, focusedWindowChangeAllowed, time, cause);
7795 if (!success) {
7796 KeyboardFocusManager.getCurrentKeyboardFocusManager
7797 (appContext).dequeueKeyEvents(time, this);
7798 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7799 focusLog.finest("Peer request failed");
7800 }
7801 } else {
7802 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7803 focusLog.finest("Pass for " + this);
7804 }
7805 }
7806 return success;
7807 }
7808
7809 private boolean isRequestFocusAccepted(boolean temporary,
7810 boolean focusedWindowChangeAllowed,
7811 CausedFocusEvent.Cause cause)
7812 {
7813 if (!isFocusable() || !isVisible()) {
7814 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7815 focusLog.finest("Not focusable or not visible");
7816 }
7817 return false;
7818 }
7819
7820 ComponentPeer peer = this.peer;
7821 if (peer == null) {
7822 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7823 focusLog.finest("peer is null");
7824 }
7825 return false;
7826 }
7827
7828 Window window = getContainingWindow();
7829 if (window == null || !window.isFocusableWindow()) {
7830 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7831 focusLog.finest("Component doesn't have toplevel");
7832 }
7833 return false;
7834 }
7835
7836 // We have passed all regular checks for focus request,
7837 // now let's call RequestFocusController and see what it says.
7838 Component focusOwner = KeyboardFocusManager.getMostRecentFocusOwner(window);
7839 if (focusOwner == null) {
7840 // sometimes most recent focus owner may be null, but focus owner is not
7841 // e.g. we reset most recent focus owner if user removes focus owner
7842 focusOwner = KeyboardFocusManager.getCurrentKeyboardFocusManager().getFocusOwner();
7843 if (focusOwner != null && focusOwner.getContainingWindow() != window) {
7844 focusOwner = null;
7845 }
7846 }
7847
7848 if (focusOwner == this || focusOwner == null) {
7849 // Controller is supposed to verify focus transfers and for this it
7850 // should know both from and to components. And it shouldn't verify
7851 // transfers from when these components are equal.
7852 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7853 focusLog.finest("focus owner is null or this");
7854 }
7855 return true;
7856 }
7857
7858 if (CausedFocusEvent.Cause.ACTIVATION == cause) {
7859 // we shouldn't call RequestFocusController in case we are
7860 // in activation. We do request focus on component which
7861 // has got temporary focus lost and then on component which is
7862 // most recent focus owner. But most recent focus owner can be
7863 // changed by requestFocusXXX() call only, so this transfer has
7864 // been already approved.
7865 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7866 focusLog.finest("cause is activation");
7867 }
7868 return true;
7869 }
7870
7871 boolean ret = Component.requestFocusController.acceptRequestFocus(focusOwner,
7872 this,
7873 temporary,
7874 focusedWindowChangeAllowed,
7875 cause);
7876 if (focusLog.isLoggable(PlatformLogger.Level.FINEST)) {
7877 focusLog.finest("RequestFocusController returns {0}", ret);
7878 }
7879
7880 return ret;
7881 }
7882
7883 private static RequestFocusController requestFocusController = new DummyRequestFocusController();
7884
7885 // Swing access this method through reflection to implement InputVerifier's functionality.
7886 // Perhaps, we should make this method public (later ;)
7887 private static class DummyRequestFocusController implements RequestFocusController {
7888 public boolean acceptRequestFocus(Component from, Component to,
7889 boolean temporary, boolean focusedWindowChangeAllowed,
7890 CausedFocusEvent.Cause cause)
7891 {
7892 return true;
7893 }
7894 };
7895
7896 synchronized static void setRequestFocusController(RequestFocusController requestController)
7897 {
7898 if (requestController == null) {
7899 requestFocusController = new DummyRequestFocusController();
7900 } else {
7901 requestFocusController = requestController;
7902 }
7903 }
7904
7905 /**
7906 * Returns the Container which is the focus cycle root of this Component's
7907 * focus traversal cycle. Each focus traversal cycle has only a single
7908 * focus cycle root and each Component which is not a Container belongs to
7909 * only a single focus traversal cycle. Containers which are focus cycle
7910 * roots belong to two cycles: one rooted at the Container itself, and one
7911 * rooted at the Container's nearest focus-cycle-root ancestor. For such
7912 * Containers, this method will return the Container's nearest focus-cycle-
7913 * root ancestor.
7914 *
7915 * @return this Component's nearest focus-cycle-root ancestor
7916 * @see Container#isFocusCycleRoot()
7917 * @since 1.4
7918 */
7919 public Container getFocusCycleRootAncestor() {
7920 Container rootAncestor = this.parent;
7921 while (rootAncestor != null && !rootAncestor.isFocusCycleRoot()) {
7922 rootAncestor = rootAncestor.parent;
7923 }
7924 return rootAncestor;
7925 }
7926
7927 /**
7928 * Returns whether the specified Container is the focus cycle root of this
7929 * Component's focus traversal cycle. Each focus traversal cycle has only
7930 * a single focus cycle root and each Component which is not a Container
7931 * belongs to only a single focus traversal cycle.
7932 *
7933 * @param container the Container to be tested
7934 * @return <code>true</code> if the specified Container is a focus-cycle-
7935 * root of this Component; <code>false</code> otherwise
7936 * @see Container#isFocusCycleRoot()
7937 * @since 1.4
7938 */
7939 public boolean isFocusCycleRoot(Container container) {
7940 Container rootAncestor = getFocusCycleRootAncestor();
7941 return (rootAncestor == container);
7942 }
7943
7944 Container getTraversalRoot() {
7945 return getFocusCycleRootAncestor();
7946 }
7947
7948 /**
7949 * Transfers the focus to the next component, as though this Component were
7950 * the focus owner.
7951 * @see #requestFocus()
7952 * @since 1.1
7953 */
7954 public void transferFocus() {
7955 nextFocus();
7956 }
7957
7958 /**
7959 * @deprecated As of JDK version 1.1,
7960 * replaced by transferFocus().
7961 */
7962 @Deprecated
7963 public void nextFocus() {
7964 transferFocus(false);
7965 }
7966
7967 boolean transferFocus(boolean clearOnFailure) {
7968 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
7969 focusLog.finer("clearOnFailure = " + clearOnFailure);
7970 }
7971 Component toFocus = getNextFocusCandidate();
7972 boolean res = false;
7973 if (toFocus != null && !toFocus.isFocusOwner() && toFocus != this) {
7974 res = toFocus.requestFocusInWindow(CausedFocusEvent.Cause.TRAVERSAL_FORWARD);
7975 }
7976 if (clearOnFailure && !res) {
7977 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
7978 focusLog.finer("clear global focus owner");
7979 }
7980 KeyboardFocusManager.getCurrentKeyboardFocusManager().clearGlobalFocusOwnerPriv();
7981 }
7982 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
7983 focusLog.finer("returning result: " + res);
7984 }
7985 return res;
7986 }
7987
7988 final Component getNextFocusCandidate() {
7989 Container rootAncestor = getTraversalRoot();
7990 Component comp = this;
7991 while (rootAncestor != null &&
7992 !(rootAncestor.isShowing() && rootAncestor.canBeFocusOwner()))
7993 {
7994 comp = rootAncestor;
7995 rootAncestor = comp.getFocusCycleRootAncestor();
7996 }
7997 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
7998 focusLog.finer("comp = " + comp + ", root = " + rootAncestor);
7999 }
8000 Component candidate = null;
8001 if (rootAncestor != null) {
8002 FocusTraversalPolicy policy = rootAncestor.getFocusTraversalPolicy();
8003 Component toFocus = policy.getComponentAfter(rootAncestor, comp);
8004 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
8005 focusLog.finer("component after is " + toFocus);
8006 }
8007 if (toFocus == null) {
8008 toFocus = policy.getDefaultComponent(rootAncestor);
8009 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
8010 focusLog.finer("default component is " + toFocus);
8011 }
8012 }
8013 if (toFocus == null) {
8014 Applet applet = EmbeddedFrame.getAppletIfAncestorOf(this);
8015 if (applet != null) {
8016 toFocus = applet;
8017 }
8018 }
8019 candidate = toFocus;
8020 }
8021 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
8022 focusLog.finer("Focus transfer candidate: " + candidate);
8023 }
8024 return candidate;
8025 }
8026
8027 /**
8028 * Transfers the focus to the previous component, as though this Component
8029 * were the focus owner.
8030 * @see #requestFocus()
8031 * @since 1.4
8032 */
8033 public void transferFocusBackward() {
8034 transferFocusBackward(false);
8035 }
8036
8037 boolean transferFocusBackward(boolean clearOnFailure) {
8038 Container rootAncestor = getTraversalRoot();
8039 Component comp = this;
8040 while (rootAncestor != null &&
8041 !(rootAncestor.isShowing() && rootAncestor.canBeFocusOwner()))
8042 {
8043 comp = rootAncestor;
8044 rootAncestor = comp.getFocusCycleRootAncestor();
8045 }
8046 boolean res = false;
8047 if (rootAncestor != null) {
8048 FocusTraversalPolicy policy = rootAncestor.getFocusTraversalPolicy();
8049 Component toFocus = policy.getComponentBefore(rootAncestor, comp);
8050 if (toFocus == null) {
8051 toFocus = policy.getDefaultComponent(rootAncestor);
8052 }
8053 if (toFocus != null) {
8054 res = toFocus.requestFocusInWindow(CausedFocusEvent.Cause.TRAVERSAL_BACKWARD);
8055 }
8056 }
8057 if (clearOnFailure && !res) {
8058 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
8059 focusLog.finer("clear global focus owner");
8060 }
8061 KeyboardFocusManager.getCurrentKeyboardFocusManager().clearGlobalFocusOwnerPriv();
8062 }
8063 if (focusLog.isLoggable(PlatformLogger.Level.FINER)) {
8064 focusLog.finer("returning result: " + res);
8065 }
8066 return res;
8067 }
8068
8069 /**
8070 * Transfers the focus up one focus traversal cycle. Typically, the focus
8071 * owner is set to this Component's focus cycle root, and the current focus
8072 * cycle root is set to the new focus owner's focus cycle root. If,
8073 * however, this Component's focus cycle root is a Window, then the focus
8074 * owner is set to the focus cycle root's default Component to focus, and
8075 * the current focus cycle root is unchanged.
8076 *
8077 * @see #requestFocus()
8078 * @see Container#isFocusCycleRoot()
8079 * @see Container#setFocusCycleRoot(boolean)
8080 * @since 1.4
8081 */
8082 public void transferFocusUpCycle() {
8083 Container rootAncestor;
8084 for (rootAncestor = getFocusCycleRootAncestor();
8085 rootAncestor != null && !(rootAncestor.isShowing() &&
8086 rootAncestor.isFocusable() &&
8087 rootAncestor.isEnabled());
8088 rootAncestor = rootAncestor.getFocusCycleRootAncestor()) {
8089 }
8090
8091 if (rootAncestor != null) {
8092 Container rootAncestorRootAncestor =
8093 rootAncestor.getFocusCycleRootAncestor();
8094 Container fcr = (rootAncestorRootAncestor != null) ?
8095 rootAncestorRootAncestor : rootAncestor;
8096
8097 KeyboardFocusManager.getCurrentKeyboardFocusManager().
8098 setGlobalCurrentFocusCycleRootPriv(fcr);
8099 rootAncestor.requestFocus(CausedFocusEvent.Cause.TRAVERSAL_UP);
8100 } else {
8101 Window window = getContainingWindow();
8102
8103 if (window != null) {
8104 Component toFocus = window.getFocusTraversalPolicy().
8105 getDefaultComponent(window);
8106 if (toFocus != null) {
8107 KeyboardFocusManager.getCurrentKeyboardFocusManager().
8108 setGlobalCurrentFocusCycleRootPriv(window);
8109 toFocus.requestFocus(CausedFocusEvent.Cause.TRAVERSAL_UP);
8110 }
8111 }
8112 }
8113 }
8114
8115 /**
8116 * Returns <code>true</code> if this <code>Component</code> is the
8117 * focus owner. This method is obsolete, and has been replaced by
8118 * <code>isFocusOwner()</code>.
8119 *
8120 * @return <code>true</code> if this <code>Component</code> is the
8121 * focus owner; <code>false</code> otherwise
8122 * @since 1.2
8123 */
8124 public boolean hasFocus() {
8125 return (KeyboardFocusManager.getCurrentKeyboardFocusManager().
8126 getFocusOwner() == this);
8127 }
8128
8129 /**
8130 * Returns <code>true</code> if this <code>Component</code> is the
8131 * focus owner.
8132 *
8133 * @return <code>true</code> if this <code>Component</code> is the
8134 * focus owner; <code>false</code> otherwise
8135 * @since 1.4
8136 */
8137 public boolean isFocusOwner() {
8138 return hasFocus();
8139 }
8140
8141 /*
8142 * Used to disallow auto-focus-transfer on disposal of the focus owner
8143 * in the process of disposing its parent container.
8144 */
8145 private boolean autoFocusTransferOnDisposal = true;
8146
8147 void setAutoFocusTransferOnDisposal(boolean value) {
8148 autoFocusTransferOnDisposal = value;
8149 }
8150
8151 boolean isAutoFocusTransferOnDisposal() {
8152 return autoFocusTransferOnDisposal;
8153 }
8154
8155 /**
8156 * Adds the specified popup menu to the component.
8157 * @param popup the popup menu to be added to the component.
8158 * @see #remove(MenuComponent)
8159 * @exception NullPointerException if {@code popup} is {@code null}
8160 * @since 1.1
8161 */
8162 public void add(PopupMenu popup) {
8163 synchronized (getTreeLock()) {
8164 if (popup.parent != null) {
8165 popup.parent.remove(popup);
8166 }
8167 if (popups == null) {
8168 popups = new Vector<PopupMenu>();
8169 }
8170 popups.addElement(popup);
8171 popup.parent = this;
8172
8173 if (peer != null) {
8174 if (popup.peer == null) {
8175 popup.addNotify();
8176 }
8177 }
8178 }
8179 }
8180
8181 /**
8182 * Removes the specified popup menu from the component.
8183 * @param popup the popup menu to be removed
8184 * @see #add(PopupMenu)
8185 * @since 1.1
8186 */
8187 @SuppressWarnings("unchecked")
8188 public void remove(MenuComponent popup) {
8189 synchronized (getTreeLock()) {
8190 if (popups == null) {
8191 return;
8192 }
8193 int index = popups.indexOf(popup);
8194 if (index >= 0) {
8195 PopupMenu pmenu = (PopupMenu)popup;
8196 if (pmenu.peer != null) {
8197 pmenu.removeNotify();
8198 }
8199 pmenu.parent = null;
8200 popups.removeElementAt(index);
8201 if (popups.size() == 0) {
8202 popups = null;
8203 }
8204 }
8205 }
8206 }
8207
8208 /**
8209 * Returns a string representing the state of this component. This
8210 * method is intended to be used only for debugging purposes, and the
8211 * content and format of the returned string may vary between
8212 * implementations. The returned string may be empty but may not be
8213 * <code>null</code>.
8214 *
8215 * @return a string representation of this component's state
8216 * @since 1.0
8217 */
8218 protected String paramString() {
8219 final String thisName = Objects.toString(getName(), "");
8220 final String invalid = isValid() ? "" : ",invalid";
8221 final String hidden = visible ? "" : ",hidden";
8222 final String disabled = enabled ? "" : ",disabled";
8223 return thisName + ',' + x + ',' + y + ',' + width + 'x' + height
8224 + invalid + hidden + disabled;
8225 }
8226
8227 /**
8228 * Returns a string representation of this component and its values.
8229 * @return a string representation of this component
8230 * @since 1.0
8231 */
8232 public String toString() {
8233 return getClass().getName() + '[' + paramString() + ']';
8234 }
8235
8236 /**
8237 * Prints a listing of this component to the standard system output
8238 * stream <code>System.out</code>.
8239 * @see java.lang.System#out
8240 * @since 1.0
8241 */
8242 public void list() {
8243 list(System.out, 0);
8244 }
8245
8246 /**
8247 * Prints a listing of this component to the specified output
8248 * stream.
8249 * @param out a print stream
8250 * @throws NullPointerException if {@code out} is {@code null}
8251 * @since 1.0
8252 */
8253 public void list(PrintStream out) {
8254 list(out, 0);
8255 }
8256
8257 /**
8258 * Prints out a list, starting at the specified indentation, to the
8259 * specified print stream.
8260 * @param out a print stream
8261 * @param indent number of spaces to indent
8262 * @see java.io.PrintStream#println(java.lang.Object)
8263 * @throws NullPointerException if {@code out} is {@code null}
8264 * @since 1.0
8265 */
8266 public void list(PrintStream out, int indent) {
8267 for (int i = 0 ; i < indent ; i++) {
8268 out.print(" ");
8269 }
8270 out.println(this);
8271 }
8272
8273 /**
8274 * Prints a listing to the specified print writer.
8275 * @param out the print writer to print to
8276 * @throws NullPointerException if {@code out} is {@code null}
8277 * @since 1.1
8278 */
8279 public void list(PrintWriter out) {
8280 list(out, 0);
8281 }
8282
8283 /**
8284 * Prints out a list, starting at the specified indentation, to
8285 * the specified print writer.
8286 * @param out the print writer to print to
8287 * @param indent the number of spaces to indent
8288 * @throws NullPointerException if {@code out} is {@code null}
8289 * @see java.io.PrintStream#println(java.lang.Object)
8290 * @since 1.1
8291 */
8292 public void list(PrintWriter out, int indent) {
8293 for (int i = 0 ; i < indent ; i++) {
8294 out.print(" ");
8295 }
8296 out.println(this);
8297 }
8298
8299 /*
8300 * Fetches the native container somewhere higher up in the component
8301 * tree that contains this component.
8302 */
8303 final Container getNativeContainer() {
8304 Container p = getContainer();
8305 while (p != null && p.peer instanceof LightweightPeer) {
8306 p = p.getContainer();
8307 }
8308 return p;
8309 }
8310
8311 /**
8312 * Adds a PropertyChangeListener to the listener list. The listener is
8313 * registered for all bound properties of this class, including the
8314 * following:
8315 * <ul>
8316 * <li>this Component's font ("font")</li>
8317 * <li>this Component's background color ("background")</li>
8318 * <li>this Component's foreground color ("foreground")</li>
8319 * <li>this Component's focusability ("focusable")</li>
8320 * <li>this Component's focus traversal keys enabled state
8321 * ("focusTraversalKeysEnabled")</li>
8322 * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS
8323 * ("forwardFocusTraversalKeys")</li>
8324 * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS
8325 * ("backwardFocusTraversalKeys")</li>
8326 * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS
8327 * ("upCycleFocusTraversalKeys")</li>
8328 * <li>this Component's preferred size ("preferredSize")</li>
8329 * <li>this Component's minimum size ("minimumSize")</li>
8330 * <li>this Component's maximum size ("maximumSize")</li>
8331 * <li>this Component's name ("name")</li>
8332 * </ul>
8333 * Note that if this <code>Component</code> is inheriting a bound property, then no
8334 * event will be fired in response to a change in the inherited property.
8335 * <p>
8336 * If <code>listener</code> is <code>null</code>,
8337 * no exception is thrown and no action is performed.
8338 *
8339 * @param listener the property change listener to be added
8340 *
8341 * @see #removePropertyChangeListener
8342 * @see #getPropertyChangeListeners
8343 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8344 */
8345 public void addPropertyChangeListener(
8346 PropertyChangeListener listener) {
8347 synchronized (getObjectLock()) {
8348 if (listener == null) {
8349 return;
8350 }
8351 if (changeSupport == null) {
8352 changeSupport = new PropertyChangeSupport(this);
8353 }
8354 changeSupport.addPropertyChangeListener(listener);
8355 }
8356 }
8357
8358 /**
8359 * Removes a PropertyChangeListener from the listener list. This method
8360 * should be used to remove PropertyChangeListeners that were registered
8361 * for all bound properties of this class.
8362 * <p>
8363 * If listener is null, no exception is thrown and no action is performed.
8364 *
8365 * @param listener the PropertyChangeListener to be removed
8366 *
8367 * @see #addPropertyChangeListener
8368 * @see #getPropertyChangeListeners
8369 * @see #removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)
8370 */
8371 public void removePropertyChangeListener(
8372 PropertyChangeListener listener) {
8373 synchronized (getObjectLock()) {
8374 if (listener == null || changeSupport == null) {
8375 return;
8376 }
8377 changeSupport.removePropertyChangeListener(listener);
8378 }
8379 }
8380
8381 /**
8382 * Returns an array of all the property change listeners
8383 * registered on this component.
8384 *
8385 * @return all of this component's <code>PropertyChangeListener</code>s
8386 * or an empty array if no property change
8387 * listeners are currently registered
8388 *
8389 * @see #addPropertyChangeListener
8390 * @see #removePropertyChangeListener
8391 * @see #getPropertyChangeListeners(java.lang.String)
8392 * @see java.beans.PropertyChangeSupport#getPropertyChangeListeners
8393 * @since 1.4
8394 */
8395 public PropertyChangeListener[] getPropertyChangeListeners() {
8396 synchronized (getObjectLock()) {
8397 if (changeSupport == null) {
8398 return new PropertyChangeListener[0];
8399 }
8400 return changeSupport.getPropertyChangeListeners();
8401 }
8402 }
8403
8404 /**
8405 * Adds a PropertyChangeListener to the listener list for a specific
8406 * property. The specified property may be user-defined, or one of the
8407 * following:
8408 * <ul>
8409 * <li>this Component's font ("font")</li>
8410 * <li>this Component's background color ("background")</li>
8411 * <li>this Component's foreground color ("foreground")</li>
8412 * <li>this Component's focusability ("focusable")</li>
8413 * <li>this Component's focus traversal keys enabled state
8414 * ("focusTraversalKeysEnabled")</li>
8415 * <li>this Component's Set of FORWARD_TRAVERSAL_KEYS
8416 * ("forwardFocusTraversalKeys")</li>
8417 * <li>this Component's Set of BACKWARD_TRAVERSAL_KEYS
8418 * ("backwardFocusTraversalKeys")</li>
8419 * <li>this Component's Set of UP_CYCLE_TRAVERSAL_KEYS
8420 * ("upCycleFocusTraversalKeys")</li>
8421 * </ul>
8422 * Note that if this <code>Component</code> is inheriting a bound property, then no
8423 * event will be fired in response to a change in the inherited property.
8424 * <p>
8425 * If <code>propertyName</code> or <code>listener</code> is <code>null</code>,
8426 * no exception is thrown and no action is taken.
8427 *
8428 * @param propertyName one of the property names listed above
8429 * @param listener the property change listener to be added
8430 *
8431 * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8432 * @see #getPropertyChangeListeners(java.lang.String)
8433 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8434 */
8435 public void addPropertyChangeListener(
8436 String propertyName,
8437 PropertyChangeListener listener) {
8438 synchronized (getObjectLock()) {
8439 if (listener == null) {
8440 return;
8441 }
8442 if (changeSupport == null) {
8443 changeSupport = new PropertyChangeSupport(this);
8444 }
8445 changeSupport.addPropertyChangeListener(propertyName, listener);
8446 }
8447 }
8448
8449 /**
8450 * Removes a <code>PropertyChangeListener</code> from the listener
8451 * list for a specific property. This method should be used to remove
8452 * <code>PropertyChangeListener</code>s
8453 * that were registered for a specific bound property.
8454 * <p>
8455 * If <code>propertyName</code> or <code>listener</code> is <code>null</code>,
8456 * no exception is thrown and no action is taken.
8457 *
8458 * @param propertyName a valid property name
8459 * @param listener the PropertyChangeListener to be removed
8460 *
8461 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8462 * @see #getPropertyChangeListeners(java.lang.String)
8463 * @see #removePropertyChangeListener(java.beans.PropertyChangeListener)
8464 */
8465 public void removePropertyChangeListener(
8466 String propertyName,
8467 PropertyChangeListener listener) {
8468 synchronized (getObjectLock()) {
8469 if (listener == null || changeSupport == null) {
8470 return;
8471 }
8472 changeSupport.removePropertyChangeListener(propertyName, listener);
8473 }
8474 }
8475
8476 /**
8477 * Returns an array of all the listeners which have been associated
8478 * with the named property.
8479 *
8480 * @param propertyName the property name
8481 * @return all of the <code>PropertyChangeListener</code>s associated with
8482 * the named property; if no such listeners have been added or
8483 * if <code>propertyName</code> is <code>null</code>, an empty
8484 * array is returned
8485 *
8486 * @see #addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8487 * @see #removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
8488 * @see #getPropertyChangeListeners
8489 * @since 1.4
8490 */
8491 public PropertyChangeListener[] getPropertyChangeListeners(String propertyName) {
8492 synchronized (getObjectLock()) {
8493 if (changeSupport == null) {
8494 return new PropertyChangeListener[0];
8495 }
8496 return changeSupport.getPropertyChangeListeners(propertyName);
8497 }
8498 }
8499
8500 /**
8501 * Support for reporting bound property changes for Object properties.
8502 * This method can be called when a bound property has changed and it will
8503 * send the appropriate PropertyChangeEvent to any registered
8504 * PropertyChangeListeners.
8505 *
8506 * @param propertyName the property whose value has changed
8507 * @param oldValue the property's previous value
8508 * @param newValue the property's new value
8509 */
8510 protected void firePropertyChange(String propertyName,
8511 Object oldValue, Object newValue) {
8512 PropertyChangeSupport changeSupport;
8513 synchronized (getObjectLock()) {
8514 changeSupport = this.changeSupport;
8515 }
8516 if (changeSupport == null ||
8517 (oldValue != null && newValue != null && oldValue.equals(newValue))) {
8518 return;
8519 }
8520 changeSupport.firePropertyChange(propertyName, oldValue, newValue);
8521 }
8522
8523 /**
8524 * Support for reporting bound property changes for boolean properties.
8525 * This method can be called when a bound property has changed and it will
8526 * send the appropriate PropertyChangeEvent to any registered
8527 * PropertyChangeListeners.
8528 *
8529 * @param propertyName the property whose value has changed
8530 * @param oldValue the property's previous value
8531 * @param newValue the property's new value
8532 * @since 1.4
8533 */
8534 protected void firePropertyChange(String propertyName,
8535 boolean oldValue, boolean newValue) {
8536 PropertyChangeSupport changeSupport = this.changeSupport;
8537 if (changeSupport == null || oldValue == newValue) {
8538 return;
8539 }
8540 changeSupport.firePropertyChange(propertyName, oldValue, newValue);
8541 }
8542
8543 /**
8544 * Support for reporting bound property changes for integer properties.
8545 * This method can be called when a bound property has changed and it will
8546 * send the appropriate PropertyChangeEvent to any registered
8547 * PropertyChangeListeners.
8548 *
8549 * @param propertyName the property whose value has changed
8550 * @param oldValue the property's previous value
8551 * @param newValue the property's new value
8552 * @since 1.4
8553 */
8554 protected void firePropertyChange(String propertyName,
8555 int oldValue, int newValue) {
8556 PropertyChangeSupport changeSupport = this.changeSupport;
8557 if (changeSupport == null || oldValue == newValue) {
8558 return;
8559 }
8560 changeSupport.firePropertyChange(propertyName, oldValue, newValue);
8561 }
8562
8563 /**
8564 * Reports a bound property change.
8565 *
8566 * @param propertyName the programmatic name of the property
8567 * that was changed
8568 * @param oldValue the old value of the property (as a byte)
8569 * @param newValue the new value of the property (as a byte)
8570 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8571 * java.lang.Object)
8572 * @since 1.5
8573 */
8574 public void firePropertyChange(String propertyName, byte oldValue, byte newValue) {
8575 if (changeSupport == null || oldValue == newValue) {
8576 return;
8577 }
8578 firePropertyChange(propertyName, Byte.valueOf(oldValue), Byte.valueOf(newValue));
8579 }
8580
8581 /**
8582 * Reports a bound property change.
8583 *
8584 * @param propertyName the programmatic name of the property
8585 * that was changed
8586 * @param oldValue the old value of the property (as a char)
8587 * @param newValue the new value of the property (as a char)
8588 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8589 * java.lang.Object)
8590 * @since 1.5
8591 */
8592 public void firePropertyChange(String propertyName, char oldValue, char newValue) {
8593 if (changeSupport == null || oldValue == newValue) {
8594 return;
8595 }
8596 firePropertyChange(propertyName, Character.valueOf(oldValue), Character.valueOf(newValue));
8597 }
8598
8599 /**
8600 * Reports a bound property change.
8601 *
8602 * @param propertyName the programmatic name of the property
8603 * that was changed
8604 * @param oldValue the old value of the property (as a short)
8605 * @param newValue the new value of the property (as a short)
8606 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8607 * java.lang.Object)
8608 * @since 1.5
8609 */
8610 public void firePropertyChange(String propertyName, short oldValue, short newValue) {
8611 if (changeSupport == null || oldValue == newValue) {
8612 return;
8613 }
8614 firePropertyChange(propertyName, Short.valueOf(oldValue), Short.valueOf(newValue));
8615 }
8616
8617
8618 /**
8619 * Reports a bound property change.
8620 *
8621 * @param propertyName the programmatic name of the property
8622 * that was changed
8623 * @param oldValue the old value of the property (as a long)
8624 * @param newValue the new value of the property (as a long)
8625 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8626 * java.lang.Object)
8627 * @since 1.5
8628 */
8629 public void firePropertyChange(String propertyName, long oldValue, long newValue) {
8630 if (changeSupport == null || oldValue == newValue) {
8631 return;
8632 }
8633 firePropertyChange(propertyName, Long.valueOf(oldValue), Long.valueOf(newValue));
8634 }
8635
8636 /**
8637 * Reports a bound property change.
8638 *
8639 * @param propertyName the programmatic name of the property
8640 * that was changed
8641 * @param oldValue the old value of the property (as a float)
8642 * @param newValue the new value of the property (as a float)
8643 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8644 * java.lang.Object)
8645 * @since 1.5
8646 */
8647 public void firePropertyChange(String propertyName, float oldValue, float newValue) {
8648 if (changeSupport == null || oldValue == newValue) {
8649 return;
8650 }
8651 firePropertyChange(propertyName, Float.valueOf(oldValue), Float.valueOf(newValue));
8652 }
8653
8654 /**
8655 * Reports a bound property change.
8656 *
8657 * @param propertyName the programmatic name of the property
8658 * that was changed
8659 * @param oldValue the old value of the property (as a double)
8660 * @param newValue the new value of the property (as a double)
8661 * @see #firePropertyChange(java.lang.String, java.lang.Object,
8662 * java.lang.Object)
8663 * @since 1.5
8664 */
8665 public void firePropertyChange(String propertyName, double oldValue, double newValue) {
8666 if (changeSupport == null || oldValue == newValue) {
8667 return;
8668 }
8669 firePropertyChange(propertyName, Double.valueOf(oldValue), Double.valueOf(newValue));
8670 }
8671
8672
8673 // Serialization support.
8674
8675 /**
8676 * Component Serialized Data Version.
8677 *
8678 * @serial
8679 */
8680 private int componentSerializedDataVersion = 4;
8681
8682 /**
8683 * This hack is for Swing serialization. It will invoke
8684 * the Swing package private method <code>compWriteObjectNotify</code>.
8685 */
8686 private void doSwingSerialization() {
8687 Package swingPackage = Package.getPackage("javax.swing");
8688 // For Swing serialization to correctly work Swing needs to
8689 // be notified before Component does it's serialization. This
8690 // hack accommodates this.
8691 //
8692 // Swing classes MUST be loaded by the bootstrap class loader,
8693 // otherwise we don't consider them.
8694 for (Class<?> klass = Component.this.getClass(); klass != null;
8695 klass = klass.getSuperclass()) {
8696 if (klass.getPackage() == swingPackage &&
8697 klass.getClassLoader() == null) {
8698 final Class<?> swingClass = klass;
8699 // Find the first override of the compWriteObjectNotify method
8700 Method[] methods = AccessController.doPrivileged(
8701 new PrivilegedAction<Method[]>() {
8702 public Method[] run() {
8703 return swingClass.getDeclaredMethods();
8704 }
8705 });
8706 for (int counter = methods.length - 1; counter >= 0;
8707 counter--) {
8708 final Method method = methods[counter];
8709 if (method.getName().equals("compWriteObjectNotify")){
8710 // We found it, use doPrivileged to make it accessible
8711 // to use.
8712 AccessController.doPrivileged(new PrivilegedAction<Void>() {
8713 public Void run() {
8714 method.setAccessible(true);
8715 return null;
8716 }
8717 });
8718 // Invoke the method
8719 try {
8720 method.invoke(this, (Object[]) null);
8721 } catch (IllegalAccessException iae) {
8722 } catch (InvocationTargetException ite) {
8723 }
8724 // We're done, bail.
8725 return;
8726 }
8727 }
8728 }
8729 }
8730 }
8731
8732 /**
8733 * Writes default serializable fields to stream. Writes
8734 * a variety of serializable listeners as optional data.
8735 * The non-serializable listeners are detected and
8736 * no attempt is made to serialize them.
8737 *
8738 * @param s the <code>ObjectOutputStream</code> to write
8739 * @serialData <code>null</code> terminated sequence of
8740 * 0 or more pairs; the pair consists of a <code>String</code>
8741 * and an <code>Object</code>; the <code>String</code> indicates
8742 * the type of object and is one of the following (as of 1.4):
8743 * <code>componentListenerK</code> indicating an
8744 * <code>ComponentListener</code> object;
8745 * <code>focusListenerK</code> indicating an
8746 * <code>FocusListener</code> object;
8747 * <code>keyListenerK</code> indicating an
8748 * <code>KeyListener</code> object;
8749 * <code>mouseListenerK</code> indicating an
8750 * <code>MouseListener</code> object;
8751 * <code>mouseMotionListenerK</code> indicating an
8752 * <code>MouseMotionListener</code> object;
8753 * <code>inputMethodListenerK</code> indicating an
8754 * <code>InputMethodListener</code> object;
8755 * <code>hierarchyListenerK</code> indicating an
8756 * <code>HierarchyListener</code> object;
8757 * <code>hierarchyBoundsListenerK</code> indicating an
8758 * <code>HierarchyBoundsListener</code> object;
8759 * <code>mouseWheelListenerK</code> indicating an
8760 * <code>MouseWheelListener</code> object
8761 * @serialData an optional <code>ComponentOrientation</code>
8762 * (after <code>inputMethodListener</code>, as of 1.2)
8763 *
8764 * @see AWTEventMulticaster#save(java.io.ObjectOutputStream, java.lang.String, java.util.EventListener)
8765 * @see #componentListenerK
8766 * @see #focusListenerK
8767 * @see #keyListenerK
8768 * @see #mouseListenerK
8769 * @see #mouseMotionListenerK
8770 * @see #inputMethodListenerK
8771 * @see #hierarchyListenerK
8772 * @see #hierarchyBoundsListenerK
8773 * @see #mouseWheelListenerK
8774 * @see #readObject(ObjectInputStream)
8775 */
8776 private void writeObject(ObjectOutputStream s)
8777 throws IOException
8778 {
8779 doSwingSerialization();
8780
8781 s.defaultWriteObject();
8782
8783 AWTEventMulticaster.save(s, componentListenerK, componentListener);
8784 AWTEventMulticaster.save(s, focusListenerK, focusListener);
8785 AWTEventMulticaster.save(s, keyListenerK, keyListener);
8786 AWTEventMulticaster.save(s, mouseListenerK, mouseListener);
8787 AWTEventMulticaster.save(s, mouseMotionListenerK, mouseMotionListener);
8788 AWTEventMulticaster.save(s, inputMethodListenerK, inputMethodListener);
8789
8790 s.writeObject(null);
8791 s.writeObject(componentOrientation);
8792
8793 AWTEventMulticaster.save(s, hierarchyListenerK, hierarchyListener);
8794 AWTEventMulticaster.save(s, hierarchyBoundsListenerK,
8795 hierarchyBoundsListener);
8796 s.writeObject(null);
8797
8798 AWTEventMulticaster.save(s, mouseWheelListenerK, mouseWheelListener);
8799 s.writeObject(null);
8800
8801 }
8802
8803 /**
8804 * Reads the <code>ObjectInputStream</code> and if it isn't
8805 * <code>null</code> adds a listener to receive a variety
8806 * of events fired by the component.
8807 * Unrecognized keys or values will be ignored.
8808 *
8809 * @param s the <code>ObjectInputStream</code> to read
8810 * @see #writeObject(ObjectOutputStream)
8811 */
8812 private void readObject(ObjectInputStream s)
8813 throws ClassNotFoundException, IOException
8814 {
8815 objectLock = new Object();
8816
8817 acc = AccessController.getContext();
8818
8819 s.defaultReadObject();
8820
8821 appContext = AppContext.getAppContext();
8822 coalescingEnabled = checkCoalescing();
8823 if (componentSerializedDataVersion < 4) {
8824 // These fields are non-transient and rely on default
8825 // serialization. However, the default values are insufficient,
8826 // so we need to set them explicitly for object data streams prior
8827 // to 1.4.
8828 focusable = true;
8829 isFocusTraversableOverridden = FOCUS_TRAVERSABLE_UNKNOWN;
8830 initializeFocusTraversalKeys();
8831 focusTraversalKeysEnabled = true;
8832 }
8833
8834 Object keyOrNull;
8835 while(null != (keyOrNull = s.readObject())) {
8836 String key = ((String)keyOrNull).intern();
8837
8838 if (componentListenerK == key)
8839 addComponentListener((ComponentListener)(s.readObject()));
8840
8841 else if (focusListenerK == key)
8842 addFocusListener((FocusListener)(s.readObject()));
8843
8844 else if (keyListenerK == key)
8845 addKeyListener((KeyListener)(s.readObject()));
8846
8847 else if (mouseListenerK == key)
8848 addMouseListener((MouseListener)(s.readObject()));
8849
8850 else if (mouseMotionListenerK == key)
8851 addMouseMotionListener((MouseMotionListener)(s.readObject()));
8852
8853 else if (inputMethodListenerK == key)
8854 addInputMethodListener((InputMethodListener)(s.readObject()));
8855
8856 else // skip value for unrecognized key
8857 s.readObject();
8858
8859 }
8860
8861 // Read the component's orientation if it's present
8862 Object orient = null;
8863
8864 try {
8865 orient = s.readObject();
8866 } catch (java.io.OptionalDataException e) {
8867 // JDK 1.1 instances will not have this optional data.
8868 // e.eof will be true to indicate that there is no more
8869 // data available for this object.
8870 // If e.eof is not true, throw the exception as it
8871 // might have been caused by reasons unrelated to
8872 // componentOrientation.
8873
8874 if (!e.eof) {
8875 throw (e);
8876 }
8877 }
8878
8879 if (orient != null) {
8880 componentOrientation = (ComponentOrientation)orient;
8881 } else {
8882 componentOrientation = ComponentOrientation.UNKNOWN;
8883 }
8884
8885 try {
8886 while(null != (keyOrNull = s.readObject())) {
8887 String key = ((String)keyOrNull).intern();
8888
8889 if (hierarchyListenerK == key) {
8890 addHierarchyListener((HierarchyListener)(s.readObject()));
8891 }
8892 else if (hierarchyBoundsListenerK == key) {
8893 addHierarchyBoundsListener((HierarchyBoundsListener)
8894 (s.readObject()));
8895 }
8896 else {
8897 // skip value for unrecognized key
8898 s.readObject();
8899 }
8900 }
8901 } catch (java.io.OptionalDataException e) {
8902 // JDK 1.1/1.2 instances will not have this optional data.
8903 // e.eof will be true to indicate that there is no more
8904 // data available for this object.
8905 // If e.eof is not true, throw the exception as it
8906 // might have been caused by reasons unrelated to
8907 // hierarchy and hierarchyBounds listeners.
8908
8909 if (!e.eof) {
8910 throw (e);
8911 }
8912 }
8913
8914 try {
8915 while (null != (keyOrNull = s.readObject())) {
8916 String key = ((String)keyOrNull).intern();
8917
8918 if (mouseWheelListenerK == key) {
8919 addMouseWheelListener((MouseWheelListener)(s.readObject()));
8920 }
8921 else {
8922 // skip value for unrecognized key
8923 s.readObject();
8924 }
8925 }
8926 } catch (java.io.OptionalDataException e) {
8927 // pre-1.3 instances will not have this optional data.
8928 // e.eof will be true to indicate that there is no more
8929 // data available for this object.
8930 // If e.eof is not true, throw the exception as it
8931 // might have been caused by reasons unrelated to
8932 // mouse wheel listeners
8933
8934 if (!e.eof) {
8935 throw (e);
8936 }
8937 }
8938
8939 if (popups != null) {
8940 int npopups = popups.size();
8941 for (int i = 0 ; i < npopups ; i++) {
8942 PopupMenu popup = popups.elementAt(i);
8943 popup.parent = this;
8944 }
8945 }
8946 }
8947
8948 /**
8949 * Sets the language-sensitive orientation that is to be used to order
8950 * the elements or text within this component. Language-sensitive
8951 * <code>LayoutManager</code> and <code>Component</code>
8952 * subclasses will use this property to
8953 * determine how to lay out and draw components.
8954 * <p>
8955 * At construction time, a component's orientation is set to
8956 * <code>ComponentOrientation.UNKNOWN</code>,
8957 * indicating that it has not been specified
8958 * explicitly. The UNKNOWN orientation behaves the same as
8959 * <code>ComponentOrientation.LEFT_TO_RIGHT</code>.
8960 * <p>
8961 * To set the orientation of a single component, use this method.
8962 * To set the orientation of an entire component
8963 * hierarchy, use
8964 * {@link #applyComponentOrientation applyComponentOrientation}.
8965 * <p>
8966 * This method changes layout-related information, and therefore,
8967 * invalidates the component hierarchy.
8968 *
8969 * @param o the orientation to be set
8970 *
8971 * @see ComponentOrientation
8972 * @see #invalidate
8973 *
8974 * @author Laura Werner, IBM
8975 * @beaninfo
8976 * bound: true
8977 */
8978 public void setComponentOrientation(ComponentOrientation o) {
8979 ComponentOrientation oldValue = componentOrientation;
8980 componentOrientation = o;
8981
8982 // This is a bound property, so report the change to
8983 // any registered listeners. (Cheap if there are none.)
8984 firePropertyChange("componentOrientation", oldValue, o);
8985
8986 // This could change the preferred size of the Component.
8987 invalidateIfValid();
8988 }
8989
8990 /**
8991 * Retrieves the language-sensitive orientation that is to be used to order
8992 * the elements or text within this component. <code>LayoutManager</code>
8993 * and <code>Component</code>
8994 * subclasses that wish to respect orientation should call this method to
8995 * get the component's orientation before performing layout or drawing.
8996 *
8997 * @return the orientation to order the elements or text
8998 * @see ComponentOrientation
8999 *
9000 * @author Laura Werner, IBM
9001 */
9002 public ComponentOrientation getComponentOrientation() {
9003 return componentOrientation;
9004 }
9005
9006 /**
9007 * Sets the <code>ComponentOrientation</code> property of this component
9008 * and all components contained within it.
9009 * <p>
9010 * This method changes layout-related information, and therefore,
9011 * invalidates the component hierarchy.
9012 *
9013 *
9014 * @param orientation the new component orientation of this component and
9015 * the components contained within it.
9016 * @exception NullPointerException if <code>orientation</code> is null.
9017 * @see #setComponentOrientation
9018 * @see #getComponentOrientation
9019 * @see #invalidate
9020 * @since 1.4
9021 */
9022 public void applyComponentOrientation(ComponentOrientation orientation) {
9023 if (orientation == null) {
9024 throw new NullPointerException();
9025 }
9026 setComponentOrientation(orientation);
9027 }
9028
9029 final boolean canBeFocusOwner() {
9030 // It is enabled, visible, focusable.
9031 if (isEnabled() && isDisplayable() && isVisible() && isFocusable()) {
9032 return true;
9033 }
9034 return false;
9035 }
9036
9037 /**
9038 * Checks that this component meets the prerequisites to be focus owner:
9039 * - it is enabled, visible, focusable
9040 * - it's parents are all enabled and showing
9041 * - top-level window is focusable
9042 * - if focus cycle root has DefaultFocusTraversalPolicy then it also checks that this policy accepts
9043 * this component as focus owner
9044 * @since 1.5
9045 */
9046 final boolean canBeFocusOwnerRecursively() {
9047 // - it is enabled, visible, focusable
9048 if (!canBeFocusOwner()) {
9049 return false;
9050 }
9051
9052 // - it's parents are all enabled and showing
9053 synchronized(getTreeLock()) {
9054 if (parent != null) {
9055 return parent.canContainFocusOwner(this);
9056 }
9057 }
9058 return true;
9059 }
9060
9061 /**
9062 * Fix the location of the HW component in a LW container hierarchy.
9063 */
9064 final void relocateComponent() {
9065 synchronized (getTreeLock()) {
9066 if (peer == null) {
9067 return;
9068 }
9069 int nativeX = x;
9070 int nativeY = y;
9071 for (Component cont = getContainer();
9072 cont != null && cont.isLightweight();
9073 cont = cont.getContainer())
9074 {
9075 nativeX += cont.x;
9076 nativeY += cont.y;
9077 }
9078 peer.setBounds(nativeX, nativeY, width, height,
9079 ComponentPeer.SET_LOCATION);
9080 }
9081 }
9082
9083 /**
9084 * Returns the <code>Window</code> ancestor of the component.
9085 * @return Window ancestor of the component or component by itself if it is Window;
9086 * null, if component is not a part of window hierarchy
9087 */
9088 Window getContainingWindow() {
9089 return SunToolkit.getContainingWindow(this);
9090 }
9091
9092 /**
9093 * Initialize JNI field and method IDs
9094 */
9095 private static native void initIDs();
9096
9097 /*
9098 * --- Accessibility Support ---
9099 *
9100 * Component will contain all of the methods in interface Accessible,
9101 * though it won't actually implement the interface - that will be up
9102 * to the individual objects which extend Component.
9103 */
9104
9105 /**
9106 * The {@code AccessibleContext} associated with this {@code Component}.
9107 */
9108 protected AccessibleContext accessibleContext = null;
9109
9110 /**
9111 * Gets the <code>AccessibleContext</code> associated
9112 * with this <code>Component</code>.
9113 * The method implemented by this base
9114 * class returns null. Classes that extend <code>Component</code>
9115 * should implement this method to return the
9116 * <code>AccessibleContext</code> associated with the subclass.
9117 *
9118 *
9119 * @return the <code>AccessibleContext</code> of this
9120 * <code>Component</code>
9121 * @since 1.3
9122 */
9123 public AccessibleContext getAccessibleContext() {
9124 return accessibleContext;
9125 }
9126
9127 /**
9128 * Inner class of Component used to provide default support for
9129 * accessibility. This class is not meant to be used directly by
9130 * application developers, but is instead meant only to be
9131 * subclassed by component developers.
9132 * <p>
9133 * The class used to obtain the accessible role for this object.
9134 * @since 1.3
9135 */
9136 protected abstract class AccessibleAWTComponent extends AccessibleContext
9137 implements Serializable, AccessibleComponent {
9138
9139 private static final long serialVersionUID = 642321655757800191L;
9140
9141 /**
9142 * Though the class is abstract, this should be called by
9143 * all sub-classes.
9144 */
9145 protected AccessibleAWTComponent() {
9146 }
9147
9148 /**
9149 * Number of PropertyChangeListener objects registered. It's used
9150 * to add/remove ComponentListener and FocusListener to track
9151 * target Component's state.
9152 */
9153 private volatile transient int propertyListenersCount = 0;
9154
9155 /**
9156 * A component listener to track show/hide/resize events
9157 * and convert them to PropertyChange events.
9158 */
9159 protected ComponentListener accessibleAWTComponentHandler = null;
9160
9161 /**
9162 * A listener to track focus events
9163 * and convert them to PropertyChange events.
9164 */
9165 protected FocusListener accessibleAWTFocusHandler = null;
9166
9167 /**
9168 * Fire PropertyChange listener, if one is registered,
9169 * when shown/hidden..
9170 * @since 1.3
9171 */
9172 protected class AccessibleAWTComponentHandler implements ComponentListener {
9173 public void componentHidden(ComponentEvent e) {
9174 if (accessibleContext != null) {
9175 accessibleContext.firePropertyChange(
9176 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9177 AccessibleState.VISIBLE, null);
9178 }
9179 }
9180
9181 public void componentShown(ComponentEvent e) {
9182 if (accessibleContext != null) {
9183 accessibleContext.firePropertyChange(
9184 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9185 null, AccessibleState.VISIBLE);
9186 }
9187 }
9188
9189 public void componentMoved(ComponentEvent e) {
9190 }
9191
9192 public void componentResized(ComponentEvent e) {
9193 }
9194 } // inner class AccessibleAWTComponentHandler
9195
9196
9197 /**
9198 * Fire PropertyChange listener, if one is registered,
9199 * when focus events happen
9200 * @since 1.3
9201 */
9202 protected class AccessibleAWTFocusHandler implements FocusListener {
9203 public void focusGained(FocusEvent event) {
9204 if (accessibleContext != null) {
9205 accessibleContext.firePropertyChange(
9206 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9207 null, AccessibleState.FOCUSED);
9208 }
9209 }
9210 public void focusLost(FocusEvent event) {
9211 if (accessibleContext != null) {
9212 accessibleContext.firePropertyChange(
9213 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9214 AccessibleState.FOCUSED, null);
9215 }
9216 }
9217 } // inner class AccessibleAWTFocusHandler
9218
9219
9220 /**
9221 * Adds a <code>PropertyChangeListener</code> to the listener list.
9222 *
9223 * @param listener the property change listener to be added
9224 */
9225 public void addPropertyChangeListener(PropertyChangeListener listener) {
9226 if (accessibleAWTComponentHandler == null) {
9227 accessibleAWTComponentHandler = new AccessibleAWTComponentHandler();
9228 }
9229 if (accessibleAWTFocusHandler == null) {
9230 accessibleAWTFocusHandler = new AccessibleAWTFocusHandler();
9231 }
9232 if (propertyListenersCount++ == 0) {
9233 Component.this.addComponentListener(accessibleAWTComponentHandler);
9234 Component.this.addFocusListener(accessibleAWTFocusHandler);
9235 }
9236 super.addPropertyChangeListener(listener);
9237 }
9238
9239 /**
9240 * Remove a PropertyChangeListener from the listener list.
9241 * This removes a PropertyChangeListener that was registered
9242 * for all properties.
9243 *
9244 * @param listener The PropertyChangeListener to be removed
9245 */
9246 public void removePropertyChangeListener(PropertyChangeListener listener) {
9247 if (--propertyListenersCount == 0) {
9248 Component.this.removeComponentListener(accessibleAWTComponentHandler);
9249 Component.this.removeFocusListener(accessibleAWTFocusHandler);
9250 }
9251 super.removePropertyChangeListener(listener);
9252 }
9253
9254 // AccessibleContext methods
9255 //
9256 /**
9257 * Gets the accessible name of this object. This should almost never
9258 * return <code>java.awt.Component.getName()</code>,
9259 * as that generally isn't a localized name,
9260 * and doesn't have meaning for the user. If the
9261 * object is fundamentally a text object (e.g. a menu item), the
9262 * accessible name should be the text of the object (e.g. "save").
9263 * If the object has a tooltip, the tooltip text may also be an
9264 * appropriate String to return.
9265 *
9266 * @return the localized name of the object -- can be
9267 * <code>null</code> if this
9268 * object does not have a name
9269 * @see javax.accessibility.AccessibleContext#setAccessibleName
9270 */
9271 public String getAccessibleName() {
9272 return accessibleName;
9273 }
9274
9275 /**
9276 * Gets the accessible description of this object. This should be
9277 * a concise, localized description of what this object is - what
9278 * is its meaning to the user. If the object has a tooltip, the
9279 * tooltip text may be an appropriate string to return, assuming
9280 * it contains a concise description of the object (instead of just
9281 * the name of the object - e.g. a "Save" icon on a toolbar that
9282 * had "save" as the tooltip text shouldn't return the tooltip
9283 * text as the description, but something like "Saves the current
9284 * text document" instead).
9285 *
9286 * @return the localized description of the object -- can be
9287 * <code>null</code> if this object does not have a description
9288 * @see javax.accessibility.AccessibleContext#setAccessibleDescription
9289 */
9290 public String getAccessibleDescription() {
9291 return accessibleDescription;
9292 }
9293
9294 /**
9295 * Gets the role of this object.
9296 *
9297 * @return an instance of <code>AccessibleRole</code>
9298 * describing the role of the object
9299 * @see javax.accessibility.AccessibleRole
9300 */
9301 public AccessibleRole getAccessibleRole() {
9302 return AccessibleRole.AWT_COMPONENT;
9303 }
9304
9305 /**
9306 * Gets the state of this object.
9307 *
9308 * @return an instance of <code>AccessibleStateSet</code>
9309 * containing the current state set of the object
9310 * @see javax.accessibility.AccessibleState
9311 */
9312 public AccessibleStateSet getAccessibleStateSet() {
9313 return Component.this.getAccessibleStateSet();
9314 }
9315
9316 /**
9317 * Gets the <code>Accessible</code> parent of this object.
9318 * If the parent of this object implements <code>Accessible</code>,
9319 * this method should simply return <code>getParent</code>.
9320 *
9321 * @return the <code>Accessible</code> parent of this
9322 * object -- can be <code>null</code> if this
9323 * object does not have an <code>Accessible</code> parent
9324 */
9325 public Accessible getAccessibleParent() {
9326 if (accessibleParent != null) {
9327 return accessibleParent;
9328 } else {
9329 Container parent = getParent();
9330 if (parent instanceof Accessible) {
9331 return (Accessible) parent;
9332 }
9333 }
9334 return null;
9335 }
9336
9337 /**
9338 * Gets the index of this object in its accessible parent.
9339 *
9340 * @return the index of this object in its parent; or -1 if this
9341 * object does not have an accessible parent
9342 * @see #getAccessibleParent
9343 */
9344 public int getAccessibleIndexInParent() {
9345 return Component.this.getAccessibleIndexInParent();
9346 }
9347
9348 /**
9349 * Returns the number of accessible children in the object. If all
9350 * of the children of this object implement <code>Accessible</code>,
9351 * then this method should return the number of children of this object.
9352 *
9353 * @return the number of accessible children in the object
9354 */
9355 public int getAccessibleChildrenCount() {
9356 return 0; // Components don't have children
9357 }
9358
9359 /**
9360 * Returns the nth <code>Accessible</code> child of the object.
9361 *
9362 * @param i zero-based index of child
9363 * @return the nth <code>Accessible</code> child of the object
9364 */
9365 public Accessible getAccessibleChild(int i) {
9366 return null; // Components don't have children
9367 }
9368
9369 /**
9370 * Returns the locale of this object.
9371 *
9372 * @return the locale of this object
9373 */
9374 public Locale getLocale() {
9375 return Component.this.getLocale();
9376 }
9377
9378 /**
9379 * Gets the <code>AccessibleComponent</code> associated
9380 * with this object if one exists.
9381 * Otherwise return <code>null</code>.
9382 *
9383 * @return the component
9384 */
9385 public AccessibleComponent getAccessibleComponent() {
9386 return this;
9387 }
9388
9389
9390 // AccessibleComponent methods
9391 //
9392 /**
9393 * Gets the background color of this object.
9394 *
9395 * @return the background color, if supported, of the object;
9396 * otherwise, <code>null</code>
9397 */
9398 public Color getBackground() {
9399 return Component.this.getBackground();
9400 }
9401
9402 /**
9403 * Sets the background color of this object.
9404 * (For transparency, see <code>isOpaque</code>.)
9405 *
9406 * @param c the new <code>Color</code> for the background
9407 * @see Component#isOpaque
9408 */
9409 public void setBackground(Color c) {
9410 Component.this.setBackground(c);
9411 }
9412
9413 /**
9414 * Gets the foreground color of this object.
9415 *
9416 * @return the foreground color, if supported, of the object;
9417 * otherwise, <code>null</code>
9418 */
9419 public Color getForeground() {
9420 return Component.this.getForeground();
9421 }
9422
9423 /**
9424 * Sets the foreground color of this object.
9425 *
9426 * @param c the new <code>Color</code> for the foreground
9427 */
9428 public void setForeground(Color c) {
9429 Component.this.setForeground(c);
9430 }
9431
9432 /**
9433 * Gets the <code>Cursor</code> of this object.
9434 *
9435 * @return the <code>Cursor</code>, if supported,
9436 * of the object; otherwise, <code>null</code>
9437 */
9438 public Cursor getCursor() {
9439 return Component.this.getCursor();
9440 }
9441
9442 /**
9443 * Sets the <code>Cursor</code> of this object.
9444 * <p>
9445 * The method may have no visual effect if the Java platform
9446 * implementation and/or the native system do not support
9447 * changing the mouse cursor shape.
9448 * @param cursor the new <code>Cursor</code> for the object
9449 */
9450 public void setCursor(Cursor cursor) {
9451 Component.this.setCursor(cursor);
9452 }
9453
9454 /**
9455 * Gets the <code>Font</code> of this object.
9456 *
9457 * @return the <code>Font</code>, if supported,
9458 * for the object; otherwise, <code>null</code>
9459 */
9460 public Font getFont() {
9461 return Component.this.getFont();
9462 }
9463
9464 /**
9465 * Sets the <code>Font</code> of this object.
9466 *
9467 * @param f the new <code>Font</code> for the object
9468 */
9469 public void setFont(Font f) {
9470 Component.this.setFont(f);
9471 }
9472
9473 /**
9474 * Gets the <code>FontMetrics</code> of this object.
9475 *
9476 * @param f the <code>Font</code>
9477 * @return the <code>FontMetrics</code>, if supported,
9478 * the object; otherwise, <code>null</code>
9479 * @see #getFont
9480 */
9481 public FontMetrics getFontMetrics(Font f) {
9482 if (f == null) {
9483 return null;
9484 } else {
9485 return Component.this.getFontMetrics(f);
9486 }
9487 }
9488
9489 /**
9490 * Determines if the object is enabled.
9491 *
9492 * @return true if object is enabled; otherwise, false
9493 */
9494 public boolean isEnabled() {
9495 return Component.this.isEnabled();
9496 }
9497
9498 /**
9499 * Sets the enabled state of the object.
9500 *
9501 * @param b if true, enables this object; otherwise, disables it
9502 */
9503 public void setEnabled(boolean b) {
9504 boolean old = Component.this.isEnabled();
9505 Component.this.setEnabled(b);
9506 if (b != old) {
9507 if (accessibleContext != null) {
9508 if (b) {
9509 accessibleContext.firePropertyChange(
9510 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9511 null, AccessibleState.ENABLED);
9512 } else {
9513 accessibleContext.firePropertyChange(
9514 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9515 AccessibleState.ENABLED, null);
9516 }
9517 }
9518 }
9519 }
9520
9521 /**
9522 * Determines if the object is visible. Note: this means that the
9523 * object intends to be visible; however, it may not in fact be
9524 * showing on the screen because one of the objects that this object
9525 * is contained by is not visible. To determine if an object is
9526 * showing on the screen, use <code>isShowing</code>.
9527 *
9528 * @return true if object is visible; otherwise, false
9529 */
9530 public boolean isVisible() {
9531 return Component.this.isVisible();
9532 }
9533
9534 /**
9535 * Sets the visible state of the object.
9536 *
9537 * @param b if true, shows this object; otherwise, hides it
9538 */
9539 public void setVisible(boolean b) {
9540 boolean old = Component.this.isVisible();
9541 Component.this.setVisible(b);
9542 if (b != old) {
9543 if (accessibleContext != null) {
9544 if (b) {
9545 accessibleContext.firePropertyChange(
9546 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9547 null, AccessibleState.VISIBLE);
9548 } else {
9549 accessibleContext.firePropertyChange(
9550 AccessibleContext.ACCESSIBLE_STATE_PROPERTY,
9551 AccessibleState.VISIBLE, null);
9552 }
9553 }
9554 }
9555 }
9556
9557 /**
9558 * Determines if the object is showing. This is determined by checking
9559 * the visibility of the object and ancestors of the object. Note:
9560 * this will return true even if the object is obscured by another
9561 * (for example, it happens to be underneath a menu that was pulled
9562 * down).
9563 *
9564 * @return true if object is showing; otherwise, false
9565 */
9566 public boolean isShowing() {
9567 return Component.this.isShowing();
9568 }
9569
9570 /**
9571 * Checks whether the specified point is within this object's bounds,
9572 * where the point's x and y coordinates are defined to be relative to
9573 * the coordinate system of the object.
9574 *
9575 * @param p the <code>Point</code> relative to the
9576 * coordinate system of the object
9577 * @return true if object contains <code>Point</code>; otherwise false
9578 */
9579 public boolean contains(Point p) {
9580 return Component.this.contains(p);
9581 }
9582
9583 /**
9584 * Returns the location of the object on the screen.
9585 *
9586 * @return location of object on screen -- can be
9587 * <code>null</code> if this object is not on the screen
9588 */
9589 public Point getLocationOnScreen() {
9590 synchronized (Component.this.getTreeLock()) {
9591 if (Component.this.isShowing()) {
9592 return Component.this.getLocationOnScreen();
9593 } else {
9594 return null;
9595 }
9596 }
9597 }
9598
9599 /**
9600 * Gets the location of the object relative to the parent in the form
9601 * of a point specifying the object's top-left corner in the screen's
9602 * coordinate space.
9603 *
9604 * @return an instance of Point representing the top-left corner of
9605 * the object's bounds in the coordinate space of the screen;
9606 * <code>null</code> if this object or its parent are not on the screen
9607 */
9608 public Point getLocation() {
9609 return Component.this.getLocation();
9610 }
9611
9612 /**
9613 * Sets the location of the object relative to the parent.
9614 * @param p the coordinates of the object
9615 */
9616 public void setLocation(Point p) {
9617 Component.this.setLocation(p);
9618 }
9619
9620 /**
9621 * Gets the bounds of this object in the form of a Rectangle object.
9622 * The bounds specify this object's width, height, and location
9623 * relative to its parent.
9624 *
9625 * @return a rectangle indicating this component's bounds;
9626 * <code>null</code> if this object is not on the screen
9627 */
9628 public Rectangle getBounds() {
9629 return Component.this.getBounds();
9630 }
9631
9632 /**
9633 * Sets the bounds of this object in the form of a
9634 * <code>Rectangle</code> object.
9635 * The bounds specify this object's width, height, and location
9636 * relative to its parent.
9637 *
9638 * @param r a rectangle indicating this component's bounds
9639 */
9640 public void setBounds(Rectangle r) {
9641 Component.this.setBounds(r);
9642 }
9643
9644 /**
9645 * Returns the size of this object in the form of a
9646 * <code>Dimension</code> object. The height field of the
9647 * <code>Dimension</code> object contains this object's
9648 * height, and the width field of the <code>Dimension</code>
9649 * object contains this object's width.
9650 *
9651 * @return a <code>Dimension</code> object that indicates
9652 * the size of this component; <code>null</code> if
9653 * this object is not on the screen
9654 */
9655 public Dimension getSize() {
9656 return Component.this.getSize();
9657 }
9658
9659 /**
9660 * Resizes this object so that it has width and height.
9661 *
9662 * @param d - the dimension specifying the new size of the object
9663 */
9664 public void setSize(Dimension d) {
9665 Component.this.setSize(d);
9666 }
9667
9668 /**
9669 * Returns the <code>Accessible</code> child,
9670 * if one exists, contained at the local
9671 * coordinate <code>Point</code>. Otherwise returns
9672 * <code>null</code>.
9673 *
9674 * @param p the point defining the top-left corner of
9675 * the <code>Accessible</code>, given in the
9676 * coordinate space of the object's parent
9677 * @return the <code>Accessible</code>, if it exists,
9678 * at the specified location; else <code>null</code>
9679 */
9680 public Accessible getAccessibleAt(Point p) {
9681 return null; // Components don't have children
9682 }
9683
9684 /**
9685 * Returns whether this object can accept focus or not.
9686 *
9687 * @return true if object can accept focus; otherwise false
9688 */
9689 public boolean isFocusTraversable() {
9690 return Component.this.isFocusTraversable();
9691 }
9692
9693 /**
9694 * Requests focus for this object.
9695 */
9696 public void requestFocus() {
9697 Component.this.requestFocus();
9698 }
9699
9700 /**
9701 * Adds the specified focus listener to receive focus events from this
9702 * component.
9703 *
9704 * @param l the focus listener
9705 */
9706 public void addFocusListener(FocusListener l) {
9707 Component.this.addFocusListener(l);
9708 }
9709
9710 /**
9711 * Removes the specified focus listener so it no longer receives focus
9712 * events from this component.
9713 *
9714 * @param l the focus listener
9715 */
9716 public void removeFocusListener(FocusListener l) {
9717 Component.this.removeFocusListener(l);
9718 }
9719
9720 } // inner class AccessibleAWTComponent
9721
9722
9723 /**
9724 * Gets the index of this object in its accessible parent.
9725 * If this object does not have an accessible parent, returns
9726 * -1.
9727 *
9728 * @return the index of this object in its accessible parent
9729 */
9730 int getAccessibleIndexInParent() {
9731 synchronized (getTreeLock()) {
9732 int index = -1;
9733 Container parent = this.getParent();
9734 if (parent != null && parent instanceof Accessible) {
9735 Component ca[] = parent.getComponents();
9736 for (int i = 0; i < ca.length; i++) {
9737 if (ca[i] instanceof Accessible) {
9738 index++;
9739 }
9740 if (this.equals(ca[i])) {
9741 return index;
9742 }
9743 }
9744 }
9745 return -1;
9746 }
9747 }
9748
9749 /**
9750 * Gets the current state set of this object.
9751 *
9752 * @return an instance of <code>AccessibleStateSet</code>
9753 * containing the current state set of the object
9754 * @see AccessibleState
9755 */
9756 AccessibleStateSet getAccessibleStateSet() {
9757 synchronized (getTreeLock()) {
9758 AccessibleStateSet states = new AccessibleStateSet();
9759 if (this.isEnabled()) {
9760 states.add(AccessibleState.ENABLED);
9761 }
9762 if (this.isFocusTraversable()) {
9763 states.add(AccessibleState.FOCUSABLE);
9764 }
9765 if (this.isVisible()) {
9766 states.add(AccessibleState.VISIBLE);
9767 }
9768 if (this.isShowing()) {
9769 states.add(AccessibleState.SHOWING);
9770 }
9771 if (this.isFocusOwner()) {
9772 states.add(AccessibleState.FOCUSED);
9773 }
9774 if (this instanceof Accessible) {
9775 AccessibleContext ac = ((Accessible) this).getAccessibleContext();
9776 if (ac != null) {
9777 Accessible ap = ac.getAccessibleParent();
9778 if (ap != null) {
9779 AccessibleContext pac = ap.getAccessibleContext();
9780 if (pac != null) {
9781 AccessibleSelection as = pac.getAccessibleSelection();
9782 if (as != null) {
9783 states.add(AccessibleState.SELECTABLE);
9784 int i = ac.getAccessibleIndexInParent();
9785 if (i >= 0) {
9786 if (as.isAccessibleChildSelected(i)) {
9787 states.add(AccessibleState.SELECTED);
9788 }
9789 }
9790 }
9791 }
9792 }
9793 }
9794 }
9795 if (Component.isInstanceOf(this, "javax.swing.JComponent")) {
9796 if (((javax.swing.JComponent) this).isOpaque()) {
9797 states.add(AccessibleState.OPAQUE);
9798 }
9799 }
9800 return states;
9801 }
9802 }
9803
9804 /**
9805 * Checks that the given object is instance of the given class.
9806 * @param obj Object to be checked
9807 * @param className The name of the class. Must be fully-qualified class name.
9808 * @return true, if this object is instanceof given class,
9809 * false, otherwise, or if obj or className is null
9810 */
9811 static boolean isInstanceOf(Object obj, String className) {
9812 if (obj == null) return false;
9813 if (className == null) return false;
9814
9815 Class<?> cls = obj.getClass();
9816 while (cls != null) {
9817 if (cls.getName().equals(className)) {
9818 return true;
9819 }
9820 cls = cls.getSuperclass();
9821 }
9822 return false;
9823 }
9824
9825
9826 // ************************** MIXING CODE *******************************
9827
9828 /**
9829 * Check whether we can trust the current bounds of the component.
9830 * The return value of false indicates that the container of the
9831 * component is invalid, and therefore needs to be laid out, which would
9832 * probably mean changing the bounds of its children.
9833 * Null-layout of the container or absence of the container mean
9834 * the bounds of the component are final and can be trusted.
9835 */
9836 final boolean areBoundsValid() {
9837 Container cont = getContainer();
9838 return cont == null || cont.isValid() || cont.getLayout() == null;
9839 }
9840
9841 /**
9842 * Applies the shape to the component
9843 * @param shape Shape to be applied to the component
9844 */
9845 void applyCompoundShape(Region shape) {
9846 checkTreeLock();
9847
9848 if (!areBoundsValid()) {
9849 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
9850 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid());
9851 }
9852 return;
9853 }
9854
9855 if (!isLightweight()) {
9856 ComponentPeer peer = this.peer;
9857 if (peer != null) {
9858 // The Region class has some optimizations. That's why
9859 // we should manually check whether it's empty and
9860 // substitute the object ourselves. Otherwise we end up
9861 // with some incorrect Region object with loX being
9862 // greater than the hiX for instance.
9863 if (shape.isEmpty()) {
9864 shape = Region.EMPTY_REGION;
9865 }
9866
9867
9868 // Note: the shape is not really copied/cloned. We create
9869 // the Region object ourselves, so there's no any possibility
9870 // to modify the object outside of the mixing code.
9871 // Nullifying compoundShape means that the component has normal shape
9872 // (or has no shape at all).
9873 if (shape.equals(getNormalShape())) {
9874 if (this.compoundShape == null) {
9875 return;
9876 }
9877 this.compoundShape = null;
9878 peer.applyShape(null);
9879 } else {
9880 if (shape.equals(getAppliedShape())) {
9881 return;
9882 }
9883 this.compoundShape = shape;
9884 Point compAbsolute = getLocationOnWindow();
9885 if (mixingLog.isLoggable(PlatformLogger.Level.FINER)) {
9886 mixingLog.fine("this = " + this +
9887 "; compAbsolute=" + compAbsolute + "; shape=" + shape);
9888 }
9889 peer.applyShape(shape.getTranslatedRegion(-compAbsolute.x, -compAbsolute.y));
9890 }
9891 }
9892 }
9893 }
9894
9895 /**
9896 * Returns the shape previously set with applyCompoundShape().
9897 * If the component is LW or no shape was applied yet,
9898 * the method returns the normal shape.
9899 */
9900 private Region getAppliedShape() {
9901 checkTreeLock();
9902 //XXX: if we allow LW components to have a shape, this must be changed
9903 return (this.compoundShape == null || isLightweight()) ? getNormalShape() : this.compoundShape;
9904 }
9905
9906 Point getLocationOnWindow() {
9907 checkTreeLock();
9908 Point curLocation = getLocation();
9909
9910 for (Container parent = getContainer();
9911 parent != null && !(parent instanceof Window);
9912 parent = parent.getContainer())
9913 {
9914 curLocation.x += parent.getX();
9915 curLocation.y += parent.getY();
9916 }
9917
9918 return curLocation;
9919 }
9920
9921 /**
9922 * Returns the full shape of the component located in window coordinates
9923 */
9924 final Region getNormalShape() {
9925 checkTreeLock();
9926 //XXX: we may take into account a user-specified shape for this component
9927 Point compAbsolute = getLocationOnWindow();
9928 return
9929 Region.getInstanceXYWH(
9930 compAbsolute.x,
9931 compAbsolute.y,
9932 getWidth(),
9933 getHeight()
9934 );
9935 }
9936
9937 /**
9938 * Returns the "opaque shape" of the component.
9939 *
9940 * The opaque shape of a lightweight components is the actual shape that
9941 * needs to be cut off of the heavyweight components in order to mix this
9942 * lightweight component correctly with them.
9943 *
9944 * The method is overriden in the java.awt.Container to handle non-opaque
9945 * containers containing opaque children.
9946 *
9947 * See 6637655 for details.
9948 */
9949 Region getOpaqueShape() {
9950 checkTreeLock();
9951 if (mixingCutoutRegion != null) {
9952 return mixingCutoutRegion;
9953 } else {
9954 return getNormalShape();
9955 }
9956 }
9957
9958 final int getSiblingIndexAbove() {
9959 checkTreeLock();
9960 Container parent = getContainer();
9961 if (parent == null) {
9962 return -1;
9963 }
9964
9965 int nextAbove = parent.getComponentZOrder(this) - 1;
9966
9967 return nextAbove < 0 ? -1 : nextAbove;
9968 }
9969
9970 final ComponentPeer getHWPeerAboveMe() {
9971 checkTreeLock();
9972
9973 Container cont = getContainer();
9974 int indexAbove = getSiblingIndexAbove();
9975
9976 while (cont != null) {
9977 for (int i = indexAbove; i > -1; i--) {
9978 Component comp = cont.getComponent(i);
9979 if (comp != null && comp.isDisplayable() && !comp.isLightweight()) {
9980 return comp.peer;
9981 }
9982 }
9983 // traversing the hierarchy up to the closest HW container;
9984 // further traversing may return a component that is not actually
9985 // a native sibling of this component and this kind of z-order
9986 // request may not be allowed by the underlying system (6852051).
9987 if (!cont.isLightweight()) {
9988 break;
9989 }
9990
9991 indexAbove = cont.getSiblingIndexAbove();
9992 cont = cont.getContainer();
9993 }
9994
9995 return null;
9996 }
9997
9998 final int getSiblingIndexBelow() {
9999 checkTreeLock();
10000 Container parent = getContainer();
10001 if (parent == null) {
10002 return -1;
10003 }
10004
10005 int nextBelow = parent.getComponentZOrder(this) + 1;
10006
10007 return nextBelow >= parent.getComponentCount() ? -1 : nextBelow;
10008 }
10009
10010 final boolean isNonOpaqueForMixing() {
10011 return mixingCutoutRegion != null &&
10012 mixingCutoutRegion.isEmpty();
10013 }
10014
10015 private Region calculateCurrentShape() {
10016 checkTreeLock();
10017 Region s = getNormalShape();
10018
10019 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10020 mixingLog.fine("this = " + this + "; normalShape=" + s);
10021 }
10022
10023 if (getContainer() != null) {
10024 Component comp = this;
10025 Container cont = comp.getContainer();
10026
10027 while (cont != null) {
10028 for (int index = comp.getSiblingIndexAbove(); index != -1; --index) {
10029 /* It is assumed that:
10030 *
10031 * getComponent(getContainer().getComponentZOrder(comp)) == comp
10032 *
10033 * The assumption has been made according to the current
10034 * implementation of the Container class.
10035 */
10036 Component c = cont.getComponent(index);
10037 if (c.isLightweight() && c.isShowing()) {
10038 s = s.getDifference(c.getOpaqueShape());
10039 }
10040 }
10041
10042 if (cont.isLightweight()) {
10043 s = s.getIntersection(cont.getNormalShape());
10044 } else {
10045 break;
10046 }
10047
10048 comp = cont;
10049 cont = cont.getContainer();
10050 }
10051 }
10052
10053 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10054 mixingLog.fine("currentShape=" + s);
10055 }
10056
10057 return s;
10058 }
10059
10060 void applyCurrentShape() {
10061 checkTreeLock();
10062 if (!areBoundsValid()) {
10063 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10064 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid());
10065 }
10066 return; // Because applyCompoundShape() ignores such components anyway
10067 }
10068 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10069 mixingLog.fine("this = " + this);
10070 }
10071 applyCompoundShape(calculateCurrentShape());
10072 }
10073
10074 final void subtractAndApplyShape(Region s) {
10075 checkTreeLock();
10076
10077 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10078 mixingLog.fine("this = " + this + "; s=" + s);
10079 }
10080
10081 applyCompoundShape(getAppliedShape().getDifference(s));
10082 }
10083
10084 private final void applyCurrentShapeBelowMe() {
10085 checkTreeLock();
10086 Container parent = getContainer();
10087 if (parent != null && parent.isShowing()) {
10088 // First, reapply shapes of my siblings
10089 parent.recursiveApplyCurrentShape(getSiblingIndexBelow());
10090
10091 // Second, if my container is non-opaque, reapply shapes of siblings of my container
10092 Container parent2 = parent.getContainer();
10093 while (!parent.isOpaque() && parent2 != null) {
10094 parent2.recursiveApplyCurrentShape(parent.getSiblingIndexBelow());
10095
10096 parent = parent2;
10097 parent2 = parent.getContainer();
10098 }
10099 }
10100 }
10101
10102 final void subtractAndApplyShapeBelowMe() {
10103 checkTreeLock();
10104 Container parent = getContainer();
10105 if (parent != null && isShowing()) {
10106 Region opaqueShape = getOpaqueShape();
10107
10108 // First, cut my siblings
10109 parent.recursiveSubtractAndApplyShape(opaqueShape, getSiblingIndexBelow());
10110
10111 // Second, if my container is non-opaque, cut siblings of my container
10112 Container parent2 = parent.getContainer();
10113 while (!parent.isOpaque() && parent2 != null) {
10114 parent2.recursiveSubtractAndApplyShape(opaqueShape, parent.getSiblingIndexBelow());
10115
10116 parent = parent2;
10117 parent2 = parent.getContainer();
10118 }
10119 }
10120 }
10121
10122 void mixOnShowing() {
10123 synchronized (getTreeLock()) {
10124 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10125 mixingLog.fine("this = " + this);
10126 }
10127 if (!isMixingNeeded()) {
10128 return;
10129 }
10130 if (isLightweight()) {
10131 subtractAndApplyShapeBelowMe();
10132 } else {
10133 applyCurrentShape();
10134 }
10135 }
10136 }
10137
10138 void mixOnHiding(boolean isLightweight) {
10139 // We cannot be sure that the peer exists at this point, so we need the argument
10140 // to find out whether the hiding component is (well, actually was) a LW or a HW.
10141 synchronized (getTreeLock()) {
10142 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10143 mixingLog.fine("this = " + this + "; isLightweight = " + isLightweight);
10144 }
10145 if (!isMixingNeeded()) {
10146 return;
10147 }
10148 if (isLightweight) {
10149 applyCurrentShapeBelowMe();
10150 }
10151 }
10152 }
10153
10154 void mixOnReshaping() {
10155 synchronized (getTreeLock()) {
10156 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10157 mixingLog.fine("this = " + this);
10158 }
10159 if (!isMixingNeeded()) {
10160 return;
10161 }
10162 if (isLightweight()) {
10163 applyCurrentShapeBelowMe();
10164 } else {
10165 applyCurrentShape();
10166 }
10167 }
10168 }
10169
10170 void mixOnZOrderChanging(int oldZorder, int newZorder) {
10171 synchronized (getTreeLock()) {
10172 boolean becameHigher = newZorder < oldZorder;
10173 Container parent = getContainer();
10174
10175 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10176 mixingLog.fine("this = " + this +
10177 "; oldZorder=" + oldZorder + "; newZorder=" + newZorder + "; parent=" + parent);
10178 }
10179 if (!isMixingNeeded()) {
10180 return;
10181 }
10182 if (isLightweight()) {
10183 if (becameHigher) {
10184 if (parent != null && isShowing()) {
10185 parent.recursiveSubtractAndApplyShape(getOpaqueShape(), getSiblingIndexBelow(), oldZorder);
10186 }
10187 } else {
10188 if (parent != null) {
10189 parent.recursiveApplyCurrentShape(oldZorder, newZorder);
10190 }
10191 }
10192 } else {
10193 if (becameHigher) {
10194 applyCurrentShape();
10195 } else {
10196 if (parent != null) {
10197 Region shape = getAppliedShape();
10198
10199 for (int index = oldZorder; index < newZorder; index++) {
10200 Component c = parent.getComponent(index);
10201 if (c.isLightweight() && c.isShowing()) {
10202 shape = shape.getDifference(c.getOpaqueShape());
10203 }
10204 }
10205 applyCompoundShape(shape);
10206 }
10207 }
10208 }
10209 }
10210 }
10211
10212 void mixOnValidating() {
10213 // This method gets overriden in the Container. Obviously, a plain
10214 // non-container components don't need to handle validation.
10215 }
10216
10217 final boolean isMixingNeeded() {
10218 if (SunToolkit.getSunAwtDisableMixing()) {
10219 if (mixingLog.isLoggable(PlatformLogger.Level.FINEST)) {
10220 mixingLog.finest("this = " + this + "; Mixing disabled via sun.awt.disableMixing");
10221 }
10222 return false;
10223 }
10224 if (!areBoundsValid()) {
10225 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10226 mixingLog.fine("this = " + this + "; areBoundsValid = " + areBoundsValid());
10227 }
10228 return false;
10229 }
10230 Window window = getContainingWindow();
10231 if (window != null) {
10232 if (!window.hasHeavyweightDescendants() || !window.hasLightweightDescendants() || window.isDisposing()) {
10233 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10234 mixingLog.fine("containing window = " + window +
10235 "; has h/w descendants = " + window.hasHeavyweightDescendants() +
10236 "; has l/w descendants = " + window.hasLightweightDescendants() +
10237 "; disposing = " + window.isDisposing());
10238 }
10239 return false;
10240 }
10241 } else {
10242 if (mixingLog.isLoggable(PlatformLogger.Level.FINE)) {
10243 mixingLog.fine("this = " + this + "; containing window is null");
10244 }
10245 return false;
10246 }
10247 return true;
10248 }
10249
10250 // ****************** END OF MIXING CODE ********************************
10251
10252 // Note that the method is overriden in the Window class,
10253 // a window doesn't need to be updated in the Z-order.
10254 void updateZOrder() {
10255 peer.setZOrder(getHWPeerAboveMe());
10256 }
10257
10258 }