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