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