| author | alexp |
| Fri, 06 Nov 2009 22:26:37 +0300 | |
| changeset 4276 | ff9daeaa1e21 |
| parent 3748 | b88af44d77a8 |
| child 5450 | 7232e9363e50 |
| permissions | -rw-r--r-- |
| 3508 | 1 |
/* |
| 3733 | 2 |
* Copyright 2009 Sun Microsystems, Inc. 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. Sun designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or |
|
23 |
* have any questions. |
|
| 3508 | 24 |
*/ |
25 |
||
26 |
package javax.swing.plaf; |
|
27 |
||
28 |
import javax.accessibility.Accessible; |
|
29 |
import javax.swing.*; |
|
30 |
import javax.swing.plaf.ComponentUI; |
|
31 |
import java.awt.*; |
|
32 |
import java.awt.event.*; |
|
33 |
import java.beans.PropertyChangeEvent; |
|
34 |
import java.beans.PropertyChangeSupport; |
|
35 |
import java.beans.PropertyChangeListener; |
|
36 |
import java.io.Serializable; |
|
37 |
||
38 |
/** |
|
39 |
* The base class for all {@link javax.swing.JLayer}'s UI delegates.
|
|
40 |
* <p/> |
|
41 |
* {@link #paint(java.awt.Graphics, javax.swing.JComponent)} method performes the
|
|
42 |
* painting of the {@code JLayer}
|
|
43 |
* and {@link #eventDispatched(AWTEvent, JLayer)} method is notified
|
|
44 |
* about any {@code AWTEvent}s which have been generated by a {@code JLayer}
|
|
45 |
* or any of its subcomponents. |
|
46 |
* <p/> |
|
47 |
* The {@code LayerUI} differs from the UI delegates of the other components,
|
|
48 |
* because it is LookAndFeel independent and is not updated by default when |
|
49 |
* the system LookAndFeel is changed. |
|
50 |
* <p/> |
|
51 |
* The subclasses of {@code LayerUI} can either be stateless and shareable
|
|
52 |
* by multiple {@code JLayer}s or not shareable.
|
|
53 |
* |
|
54 |
* @param <V> one of the super types of {@code JLayer}'s view component
|
|
55 |
* |
|
56 |
* @see JLayer#setUI(LayerUI) |
|
57 |
* @see JLayer#setView(Component) |
|
58 |
* @see JLayer#getView() |
|
59 |
* @since 1.7 |
|
60 |
* |
|
61 |
* @author Alexander Potochkin |
|
62 |
*/ |
|
63 |
public class LayerUI<V extends Component> |
|
64 |
extends ComponentUI implements Serializable {
|
|
65 |
||
66 |
private final PropertyChangeSupport propertyChangeSupport = |
|
67 |
new PropertyChangeSupport(this); |
|
68 |
||
69 |
/** |
|
70 |
* Paints the specified component. |
|
71 |
* Subclasses should override this method and use |
|
72 |
* the specified {@code Graphics} object to
|
|
73 |
* render the content of the component. |
|
| 4276 | 74 |
* <p/> |
75 |
* If {@code g} is not an instance of {@code Graphics2D},
|
|
76 |
* this method is no-op. |
|
| 3508 | 77 |
* |
78 |
* @param g the {@code Graphics} context in which to paint;
|
|
79 |
* @param c the component being painted; |
|
| 4276 | 80 |
* it can be safely cast to {@code JLayer<? extends V>}
|
81 |
* |
|
82 |
* @see #configureGraphics(Graphics2D, JLayer) |
|
83 |
* @see #paintLayer(Graphics2D, JLayer) |
|
| 3508 | 84 |
*/ |
85 |
public void paint(Graphics g, JComponent c) {
|
|
| 4276 | 86 |
if (g instanceof Graphics2D) {
|
87 |
Graphics2D g2 = (Graphics2D) g.create(); |
|
88 |
JLayer<? extends V> l = (JLayer<? extends V>) c; |
|
89 |
configureGraphics(g2, l); |
|
90 |
paintLayer(g2, l); |
|
91 |
g2.dispose(); |
|
92 |
} |
|
93 |
} |
|
94 |
||
95 |
/** |
|
96 |
* This method is called by the {@link #paint} method prior to
|
|
97 |
* {@link #paintLayer} to configure the {@code Graphics2D} object.
|
|
98 |
* The default implementation is empty. |
|
99 |
* |
|
100 |
* @param g2 the {@code Graphics2D} object to configure
|
|
101 |
* @param l the {@code JLayer} being painted
|
|
102 |
* |
|
103 |
* @see #paintLayer(Graphics2D, JLayer) |
|
104 |
*/ |
|
105 |
protected void configureGraphics(Graphics2D g2, JLayer<? extends V> l) {
|
|
106 |
} |
|
107 |
||
108 |
/** |
|
109 |
* Called by the {@link #paint} method,
|
|
110 |
* subclasses should override this method |
|
111 |
* to perform any custom painting operations. |
|
112 |
* <p/> |
|
113 |
* The default implementation paints the passed {@code JLayer} as is.
|
|
114 |
* |
|
115 |
* @param g2 the {@code Graphics2D} context in which to paint
|
|
116 |
* @param l the {@code JLayer} being painted
|
|
117 |
* |
|
118 |
* @see #configureGraphics(Graphics2D, JLayer) |
|
119 |
*/ |
|
120 |
protected void paintLayer(Graphics2D g2, JLayer<? extends V> l) {
|
|
121 |
l.paint(g2); |
|
| 3508 | 122 |
} |
123 |
||
124 |
/** |
|
125 |
* Dispatches {@code AWTEvent}s for {@code JLayer}
|
|
| 4276 | 126 |
* and <b>all its subcomponents</b> to this {@code LayerUI} instance.
|
127 |
* <p/> |
|
128 |
* To enable the {@code AWTEvent}s of a particular type,
|
|
129 |
* you call {@link JLayer#setLayerEventMask}
|
|
| 3508 | 130 |
* in {@link #installUI(javax.swing.JComponent)}
|
131 |
* and set the layer event mask to {@code 0}
|
|
| 4276 | 132 |
* in {@link #uninstallUI(javax.swing.JComponent)} after that.
|
133 |
* By default this method calls the appropriate |
|
134 |
* {@code process<event type>Event}
|
|
135 |
* method for the given class of event. |
|
| 3508 | 136 |
* |
137 |
* @param e the event to be dispatched |
|
138 |
* @param l the layer this LayerUI is set to |
|
139 |
* |
|
140 |
* @see JLayer#setLayerEventMask(long) |
|
| 4276 | 141 |
* @see #installUI(javax.swing.JComponent) |
142 |
* @see #uninstallUI(javax.swing.JComponent) |
|
143 |
* @see #processComponentEvent |
|
144 |
* @see #processFocusEvent |
|
145 |
* @see #processKeyEvent |
|
146 |
* @see #processMouseEvent |
|
147 |
* @see #processMouseMotionEvent |
|
148 |
* @see #processInputMethodEvent |
|
149 |
* @see #processHierarchyEvent |
|
150 |
* @see #processMouseWheelEvent |
|
| 3508 | 151 |
*/ |
152 |
public void eventDispatched(AWTEvent e, JLayer<? extends V> l){
|
|
| 4276 | 153 |
if (e instanceof FocusEvent) {
|
154 |
processFocusEvent((FocusEvent)e, l); |
|
155 |
||
156 |
} else if (e instanceof MouseEvent) {
|
|
157 |
switch(e.getID()) {
|
|
158 |
case MouseEvent.MOUSE_PRESSED: |
|
159 |
case MouseEvent.MOUSE_RELEASED: |
|
160 |
case MouseEvent.MOUSE_CLICKED: |
|
161 |
case MouseEvent.MOUSE_ENTERED: |
|
162 |
case MouseEvent.MOUSE_EXITED: |
|
163 |
processMouseEvent((MouseEvent)e, l); |
|
164 |
break; |
|
165 |
case MouseEvent.MOUSE_MOVED: |
|
166 |
case MouseEvent.MOUSE_DRAGGED: |
|
167 |
processMouseMotionEvent((MouseEvent)e, l); |
|
168 |
break; |
|
169 |
case MouseEvent.MOUSE_WHEEL: |
|
170 |
processMouseWheelEvent((MouseWheelEvent)e, l); |
|
171 |
break; |
|
172 |
} |
|
173 |
} else if (e instanceof KeyEvent) {
|
|
174 |
processKeyEvent((KeyEvent)e, l); |
|
175 |
} else if (e instanceof ComponentEvent) {
|
|
176 |
processComponentEvent((ComponentEvent)e, l); |
|
177 |
} else if (e instanceof InputMethodEvent) {
|
|
178 |
processInputMethodEvent((InputMethodEvent)e, l); |
|
179 |
} else if (e instanceof HierarchyEvent) {
|
|
180 |
switch (e.getID()) {
|
|
181 |
case HierarchyEvent.HIERARCHY_CHANGED: |
|
182 |
processHierarchyEvent((HierarchyEvent)e, l); |
|
183 |
break; |
|
184 |
case HierarchyEvent.ANCESTOR_MOVED: |
|
185 |
case HierarchyEvent.ANCESTOR_RESIZED: |
|
186 |
processHierarchyBoundsEvent((HierarchyEvent)e, l); |
|
187 |
break; |
|
188 |
} |
|
189 |
} |
|
190 |
} |
|
191 |
||
192 |
/** |
|
193 |
* Processes component events occurring on the {@link JLayer}
|
|
194 |
* or any of its subcomponents. |
|
195 |
* <p/> |
|
196 |
* This method is not called unless component events are |
|
197 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
198 |
* Component events are enabled in the overridden {@link #installUI} method
|
|
199 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
200 |
* <pre> |
|
201 |
* public void installUI(JComponent c) {
|
|
202 |
* super.installUI(c); |
|
203 |
* JLayer l = (JLayer) c; |
|
204 |
* l.setLayerEventMask(AWTEvent.COMPONENT_EVENT_MASK); |
|
205 |
* } |
|
206 |
* |
|
207 |
* public void unistallUI(JComponent c) {
|
|
208 |
* super.uninstallUI(c); |
|
209 |
* JLayer l = (JLayer) c; |
|
210 |
* l.setLayerEventMask(0); |
|
211 |
* } |
|
212 |
* </pre> |
|
213 |
* |
|
214 |
* @param e the {@code ComponentEvent} to be processed
|
|
215 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
216 |
* |
|
217 |
* @see JLayer#setLayerEventMask(long) |
|
218 |
* @see #installUI(javax.swing.JComponent) |
|
219 |
* @see #uninstallUI(javax.swing.JComponent) |
|
220 |
*/ |
|
221 |
protected void processComponentEvent(ComponentEvent e, JLayer<? extends V> l) {
|
|
222 |
} |
|
223 |
||
224 |
/** |
|
225 |
* Processes focus events occurring on the {@link JLayer}
|
|
226 |
* or any of its subcomponents. |
|
227 |
* <p/> |
|
228 |
* This method is not called unless focus events are |
|
229 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
230 |
* Focus events are enabled in the overridden {@link #installUI} method
|
|
231 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
232 |
* <pre> |
|
233 |
* public void installUI(JComponent c) {
|
|
234 |
* super.installUI(c); |
|
235 |
* JLayer l = (JLayer) c; |
|
236 |
* l.setLayerEventMask(AWTEvent.FOCUS_EVENT_MASK); |
|
237 |
* } |
|
238 |
* |
|
239 |
* public void unistallUI(JComponent c) {
|
|
240 |
* super.uninstallUI(c); |
|
241 |
* JLayer l = (JLayer) c; |
|
242 |
* l.setLayerEventMask(0); |
|
243 |
* } |
|
244 |
* </pre> |
|
245 |
* |
|
246 |
* @param e the {@code FocusEvent} to be processed
|
|
247 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
248 |
* |
|
249 |
* @see JLayer#setLayerEventMask(long) |
|
250 |
* @see #installUI(javax.swing.JComponent) |
|
251 |
* @see #uninstallUI(javax.swing.JComponent) |
|
252 |
*/ |
|
253 |
protected void processFocusEvent(FocusEvent e, JLayer<? extends V> l) {
|
|
254 |
} |
|
255 |
||
256 |
/** |
|
257 |
* Processes key events occurring on the {@link JLayer}
|
|
258 |
* or any of its subcomponents. |
|
259 |
* <p/> |
|
260 |
* This method is not called unless key events are |
|
261 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
262 |
* Key events are enabled in the overridden {@link #installUI} method
|
|
263 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
264 |
* <pre> |
|
265 |
* public void installUI(JComponent c) {
|
|
266 |
* super.installUI(c); |
|
267 |
* JLayer l = (JLayer) c; |
|
268 |
* l.setLayerEventMask(AWTEvent.KEY_EVENT_MASK); |
|
269 |
* } |
|
270 |
* |
|
271 |
* public void unistallUI(JComponent c) {
|
|
272 |
* super.uninstallUI(c); |
|
273 |
* JLayer l = (JLayer) c; |
|
274 |
* l.setLayerEventMask(0); |
|
275 |
* } |
|
276 |
* </pre> |
|
277 |
* |
|
278 |
* @param e the {@code KeyEvent} to be processed
|
|
279 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
280 |
* |
|
281 |
* @see JLayer#setLayerEventMask(long) |
|
282 |
* @see #installUI(javax.swing.JComponent) |
|
283 |
* @see #uninstallUI(javax.swing.JComponent) |
|
284 |
*/ |
|
285 |
protected void processKeyEvent(KeyEvent e, JLayer<? extends V> l) {
|
|
286 |
} |
|
287 |
||
288 |
/** |
|
289 |
* Processes mouse events occurring on the {@link JLayer}
|
|
290 |
* or any of its subcomponents. |
|
291 |
* <p/> |
|
292 |
* This method is not called unless mouse events are |
|
293 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
294 |
* Mouse events are enabled in the overridden {@link #installUI} method
|
|
295 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
296 |
* <pre> |
|
297 |
* public void installUI(JComponent c) {
|
|
298 |
* super.installUI(c); |
|
299 |
* JLayer l = (JLayer) c; |
|
300 |
* l.setLayerEventMask(AWTEvent.MOUSE_EVENT_MASK); |
|
301 |
* } |
|
302 |
* |
|
303 |
* public void unistallUI(JComponent c) {
|
|
304 |
* super.uninstallUI(c); |
|
305 |
* JLayer l = (JLayer) c; |
|
306 |
* l.setLayerEventMask(0); |
|
307 |
* } |
|
308 |
* </pre> |
|
309 |
* |
|
310 |
* @param e the {@code MouseEvent} to be processed
|
|
311 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
312 |
* |
|
313 |
* @see JLayer#setLayerEventMask(long) |
|
314 |
* @see #installUI(javax.swing.JComponent) |
|
315 |
* @see #uninstallUI(javax.swing.JComponent) |
|
316 |
*/ |
|
317 |
protected void processMouseEvent(MouseEvent e, JLayer<? extends V> l) {
|
|
318 |
} |
|
319 |
||
320 |
/** |
|
321 |
* Processes mouse motion event occurring on the {@link JLayer}
|
|
322 |
* or any of its subcomponents. |
|
323 |
* <p/> |
|
324 |
* This method is not called unless mouse motion events are |
|
325 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
326 |
* Mouse motion events are enabled in the overridden {@link #installUI} method
|
|
327 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
328 |
* <pre> |
|
329 |
* public void installUI(JComponent c) {
|
|
330 |
* super.installUI(c); |
|
331 |
* JLayer l = (JLayer) c; |
|
332 |
* l.setLayerEventMask(AWTEvent.MOUSE_MOTION_EVENT_MASK); |
|
333 |
* } |
|
334 |
* |
|
335 |
* public void unistallUI(JComponent c) {
|
|
336 |
* super.uninstallUI(c); |
|
337 |
* JLayer l = (JLayer) c; |
|
338 |
* l.setLayerEventMask(0); |
|
339 |
* } |
|
340 |
* </pre> |
|
341 |
* |
|
342 |
* @param e the {@code MouseEvent} to be processed
|
|
343 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
344 |
* |
|
345 |
* @see JLayer#setLayerEventMask(long) |
|
346 |
* @see #installUI(javax.swing.JComponent) |
|
347 |
* @see #uninstallUI(javax.swing.JComponent) |
|
348 |
*/ |
|
349 |
protected void processMouseMotionEvent(MouseEvent e, JLayer<? extends V> l) {
|
|
350 |
} |
|
351 |
||
352 |
/** |
|
353 |
* Processes mouse wheel event occurring on the {@link JLayer}
|
|
354 |
* or any of its subcomponents. |
|
355 |
* <p/> |
|
356 |
* This method is not called unless mouse wheel events are |
|
357 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
358 |
* Mouse wheel events are enabled in the overridden {@link #installUI} method
|
|
359 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
360 |
* <pre> |
|
361 |
* public void installUI(JComponent c) {
|
|
362 |
* super.installUI(c); |
|
363 |
* JLayer l = (JLayer) c; |
|
364 |
* l.setLayerEventMask(AWTEvent.MOUSE_WHEEL_EVENT_MASK); |
|
365 |
* } |
|
366 |
* |
|
367 |
* public void unistallUI(JComponent c) {
|
|
368 |
* super.uninstallUI(c); |
|
369 |
* JLayer l = (JLayer) c; |
|
370 |
* l.setLayerEventMask(0); |
|
371 |
* } |
|
372 |
* </pre> |
|
373 |
* |
|
374 |
* @param e the {@code MouseEvent} to be processed
|
|
375 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
376 |
* |
|
377 |
* @see JLayer#setLayerEventMask(long) |
|
378 |
* @see #installUI(javax.swing.JComponent) |
|
379 |
* @see #uninstallUI(javax.swing.JComponent) |
|
380 |
*/ |
|
381 |
protected void processMouseWheelEvent(MouseWheelEvent e, JLayer<? extends V> l) {
|
|
382 |
} |
|
383 |
||
384 |
/** |
|
385 |
* Processes input event occurring on the {@link JLayer}
|
|
386 |
* or any of its subcomponents. |
|
387 |
* <p/> |
|
388 |
* This method is not called unless input events are |
|
389 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
390 |
* Input events are enabled in the overridden {@link #installUI} method
|
|
391 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
392 |
* <pre> |
|
393 |
* public void installUI(JComponent c) {
|
|
394 |
* super.installUI(c); |
|
395 |
* JLayer l = (JLayer) c; |
|
396 |
* l.setLayerEventMask(AWTEvent.INPUT_METHOD_EVENT_MASK); |
|
397 |
* } |
|
398 |
* |
|
399 |
* public void unistallUI(JComponent c) {
|
|
400 |
* super.uninstallUI(c); |
|
401 |
* JLayer l = (JLayer) c; |
|
402 |
* l.setLayerEventMask(0); |
|
403 |
* } |
|
404 |
* </pre> |
|
405 |
* |
|
406 |
* @param e the {@code InputMethodEvent} to be processed
|
|
407 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
408 |
* |
|
409 |
* @see JLayer#setLayerEventMask(long) |
|
410 |
* @see #installUI(javax.swing.JComponent) |
|
411 |
* @see #uninstallUI(javax.swing.JComponent) |
|
412 |
*/ |
|
413 |
protected void processInputMethodEvent(InputMethodEvent e, JLayer<? extends V> l) {
|
|
414 |
} |
|
415 |
||
416 |
/** |
|
417 |
* Processes hierarchy event occurring on the {@link JLayer}
|
|
418 |
* or any of its subcomponents. |
|
419 |
* <p/> |
|
420 |
* This method is not called unless hierarchy events are |
|
421 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
422 |
* Hierarchy events are enabled in the overridden {@link #installUI} method
|
|
423 |
* and should be disabled in the {@link #uninstallUI} method after that.
|
|
424 |
* <pre> |
|
425 |
* public void installUI(JComponent c) {
|
|
426 |
* super.installUI(c); |
|
427 |
* JLayer l = (JLayer) c; |
|
428 |
* l.setLayerEventMask(AWTEvent.HIERARCHY_EVENT_MASK); |
|
429 |
* } |
|
430 |
* |
|
431 |
* public void unistallUI(JComponent c) {
|
|
432 |
* super.uninstallUI(c); |
|
433 |
* JLayer l = (JLayer) c; |
|
434 |
* l.setLayerEventMask(0); |
|
435 |
* } |
|
436 |
* </pre> |
|
437 |
* |
|
438 |
* @param e the {@code HierarchyEvent} to be processed
|
|
439 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
440 |
* |
|
441 |
* @see JLayer#setLayerEventMask(long) |
|
442 |
* @see #installUI(javax.swing.JComponent) |
|
443 |
* @see #uninstallUI(javax.swing.JComponent) |
|
444 |
*/ |
|
445 |
protected void processHierarchyEvent(HierarchyEvent e, JLayer<? extends V> l) {
|
|
446 |
} |
|
447 |
||
448 |
/** |
|
449 |
* Processes hierarchy bounds event occurring on the {@link JLayer}
|
|
450 |
* or any of its subcomponents. |
|
451 |
* <p/> |
|
452 |
* This method is not called unless hierarchy bounds events are |
|
453 |
* enabled for the {@code JLayer} objects, this {@code LayerUI} is set to.
|
|
454 |
* Hierarchy bounds events are enabled in the overridden {@link #installUI}
|
|
455 |
* method and should be disabled in the {@link #uninstallUI} method after that.
|
|
456 |
* <pre> |
|
457 |
* public void installUI(JComponent c) {
|
|
458 |
* super.installUI(c); |
|
459 |
* JLayer l = (JLayer) c; |
|
460 |
* l.setLayerEventMask(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK); |
|
461 |
* } |
|
462 |
* |
|
463 |
* public void unistallUI(JComponent c) {
|
|
464 |
* super.uninstallUI(c); |
|
465 |
* JLayer l = (JLayer) c; |
|
466 |
* l.setLayerEventMask(0); |
|
467 |
* } |
|
468 |
* </pre> |
|
469 |
* |
|
470 |
* @param e the {@code HierarchyEvent} to be processed
|
|
471 |
* @param l the layer this {@code LayerUI} instance is set to
|
|
472 |
* |
|
473 |
* @see JLayer#setLayerEventMask(long) |
|
474 |
* @see #installUI(javax.swing.JComponent) |
|
475 |
* @see #uninstallUI(javax.swing.JComponent) |
|
476 |
*/ |
|
477 |
protected void processHierarchyBoundsEvent(HierarchyEvent e, JLayer<? extends V> l) {
|
|
| 3508 | 478 |
} |
479 |
||
480 |
/** |
|
481 |
* Invoked when {@link javax.swing.JLayer#updateUI()} is called
|
|
482 |
* by the {@code JLayer} this {@code LayerUI} is set to.
|
|
483 |
* |
|
484 |
* @param l the {@code JLayer} which UI is updated
|
|
485 |
*/ |
|
486 |
public void updateUI(JLayer<? extends V> l){
|
|
487 |
} |
|
488 |
||
489 |
/** |
|
490 |
* Configures the {@code JLayer} this {@code LayerUI} is set to.
|
|
491 |
* The default implementation registers the {@code LayerUI}
|
|
492 |
* as a property change listener for the passed {@code JLayer} component.
|
|
493 |
* |
|
494 |
* @param c the {@code JLayer} component where this UI delegate is being installed
|
|
495 |
*/ |
|
496 |
public void installUI(JComponent c) {
|
|
497 |
addPropertyChangeListener((JLayer) c); |
|
498 |
} |
|
499 |
||
500 |
/** |
|
501 |
* Reverses the configuration which was previously set |
|
502 |
* in the {@link #installUI(JComponent)} method.
|
|
503 |
* The default implementation unregisters the property change listener |
|
504 |
* for the passed JLayer component. |
|
505 |
* |
|
506 |
* @param c the component from which this UI delegate is being removed. |
|
507 |
*/ |
|
508 |
public void uninstallUI(JComponent c) {
|
|
509 |
removePropertyChangeListener((JLayer) c); |
|
510 |
} |
|
511 |
||
512 |
/** |
|
513 |
* Adds a PropertyChangeListener to the listener list. The listener is |
|
514 |
* registered for all bound properties of this class. |
|
515 |
* <p/> |
|
516 |
* If {@code listener} is {@code null},
|
|
517 |
* no exception is thrown and no action is performed. |
|
518 |
* |
|
519 |
* @param listener the property change listener to be added |
|
520 |
* @see #removePropertyChangeListener |
|
521 |
* @see #getPropertyChangeListeners |
|
522 |
* @see #addPropertyChangeListener(String, java.beans.PropertyChangeListener) |
|
523 |
*/ |
|
524 |
public void addPropertyChangeListener(PropertyChangeListener listener) {
|
|
525 |
propertyChangeSupport.addPropertyChangeListener(listener); |
|
526 |
} |
|
527 |
||
528 |
/** |
|
529 |
* Removes a PropertyChangeListener from the listener list. This method |
|
530 |
* should be used to remove PropertyChangeListeners that were registered |
|
531 |
* for all bound properties of this class. |
|
532 |
* <p/> |
|
533 |
* If {@code listener} is {@code null},
|
|
534 |
* no exception is thrown and no action is performed. |
|
535 |
* |
|
536 |
* @param listener the PropertyChangeListener to be removed |
|
537 |
* @see #addPropertyChangeListener |
|
538 |
* @see #getPropertyChangeListeners |
|
539 |
* @see #removePropertyChangeListener(String, PropertyChangeListener) |
|
540 |
*/ |
|
541 |
public void removePropertyChangeListener(PropertyChangeListener listener) {
|
|
542 |
propertyChangeSupport.removePropertyChangeListener(listener); |
|
543 |
} |
|
544 |
||
545 |
/** |
|
546 |
* Returns an array of all the property change listeners |
|
547 |
* registered on this component. |
|
548 |
* |
|
549 |
* @return all of this ui's {@code PropertyChangeListener}s
|
|
550 |
* or an empty array if no property change |
|
551 |
* listeners are currently registered |
|
552 |
* @see #addPropertyChangeListener |
|
553 |
* @see #removePropertyChangeListener |
|
554 |
* @see #getPropertyChangeListeners(String) |
|
555 |
*/ |
|
556 |
public PropertyChangeListener[] getPropertyChangeListeners() {
|
|
557 |
return propertyChangeSupport.getPropertyChangeListeners(); |
|
558 |
} |
|
559 |
||
560 |
/** |
|
561 |
* Adds a PropertyChangeListener to the listener list for a specific |
|
562 |
* property. |
|
563 |
* <p/> |
|
564 |
* If {@code propertyName} or {@code listener} is {@code null},
|
|
565 |
* no exception is thrown and no action is taken. |
|
566 |
* |
|
567 |
* @param propertyName one of the property names listed above |
|
568 |
* @param listener the property change listener to be added |
|
569 |
* @see #removePropertyChangeListener(String, PropertyChangeListener) |
|
570 |
* @see #getPropertyChangeListeners(String) |
|
571 |
* @see #addPropertyChangeListener(String, PropertyChangeListener) |
|
572 |
*/ |
|
573 |
public void addPropertyChangeListener(String propertyName, |
|
574 |
PropertyChangeListener listener) {
|
|
575 |
propertyChangeSupport.addPropertyChangeListener(propertyName, listener); |
|
576 |
} |
|
577 |
||
578 |
/** |
|
579 |
* Removes a {@code PropertyChangeListener} from the listener
|
|
580 |
* list for a specific property. This method should be used to remove |
|
581 |
* {@code PropertyChangeListener}s
|
|
582 |
* that were registered for a specific bound property. |
|
583 |
* <p/> |
|
584 |
* If {@code propertyName} or {@code listener} is {@code null},
|
|
585 |
* no exception is thrown and no action is taken. |
|
586 |
* |
|
587 |
* @param propertyName a valid property name |
|
588 |
* @param listener the PropertyChangeListener to be removed |
|
589 |
* @see #addPropertyChangeListener(String, PropertyChangeListener) |
|
590 |
* @see #getPropertyChangeListeners(String) |
|
591 |
* @see #removePropertyChangeListener(PropertyChangeListener) |
|
592 |
*/ |
|
593 |
public void removePropertyChangeListener(String propertyName, |
|
594 |
PropertyChangeListener listener) {
|
|
595 |
propertyChangeSupport.removePropertyChangeListener(propertyName, listener); |
|
596 |
} |
|
597 |
||
598 |
/** |
|
599 |
* Returns an array of all the listeners which have been associated |
|
600 |
* with the named property. |
|
601 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
602 |
* @param propertyName The name of the property being listened to |
| 3508 | 603 |
* @return all of the {@code PropertyChangeListener}s associated with
|
604 |
* the named property; if no such listeners have been added or |
|
605 |
* if {@code propertyName} is {@code null}, an empty
|
|
606 |
* array is returned |
|
607 |
* @see #addPropertyChangeListener(String, PropertyChangeListener) |
|
608 |
* @see #removePropertyChangeListener(String, PropertyChangeListener) |
|
609 |
* @see #getPropertyChangeListeners |
|
610 |
*/ |
|
611 |
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName) {
|
|
612 |
return propertyChangeSupport.getPropertyChangeListeners(propertyName); |
|
613 |
} |
|
614 |
||
615 |
/** |
|
616 |
* Support for reporting bound property changes for Object properties. |
|
617 |
* This method can be called when a bound property has changed and it will |
|
618 |
* send the appropriate PropertyChangeEvent to any registered |
|
619 |
* PropertyChangeListeners. |
|
620 |
* |
|
621 |
* @param propertyName the property whose value has changed |
|
622 |
* @param oldValue the property's previous value |
|
623 |
* @param newValue the property's new value |
|
624 |
*/ |
|
625 |
protected void firePropertyChange(String propertyName, |
|
626 |
Object oldValue, Object newValue) {
|
|
627 |
propertyChangeSupport.firePropertyChange(propertyName, oldValue, newValue); |
|
628 |
} |
|
629 |
||
630 |
/** |
|
| 4276 | 631 |
* Repaints all {@code JLayer} instances this {@code LayerUI} is set to.
|
632 |
* Call this method when the state of this {@code LayerUI} is changed
|
|
633 |
* and the visual appearance of its {@code JLayer} objects needs to be updated.
|
|
634 |
* |
|
635 |
* @see Component#repaint() |
|
636 |
*/ |
|
637 |
protected void repaintLayer() {
|
|
638 |
firePropertyChange("dirty", null, null);
|
|
639 |
} |
|
640 |
||
641 |
/** |
|
| 3508 | 642 |
* Notifies the {@code LayerUI} when any of its property are changed
|
| 4276 | 643 |
* and enables updating every {@code JLayer}
|
644 |
* this {@code LayerUI} instance is set to.
|
|
| 3508 | 645 |
* |
646 |
* @param evt the PropertyChangeEvent generated by this {@code LayerUI}
|
|
647 |
* @param l the {@code JLayer} this LayerUI is set to
|
|
648 |
*/ |
|
649 |
public void applyPropertyChange(PropertyChangeEvent evt, JLayer<? extends V> l) {
|
|
| 4276 | 650 |
if ("dirty".equals(evt.getPropertyName())) {
|
651 |
l.repaint(); |
|
652 |
} |
|
| 3508 | 653 |
} |
654 |
||
655 |
/** |
|
656 |
* Returns the preferred size of the viewport for a view component. |
|
657 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
658 |
* @param l the {@code JLayer} component where this UI delegate is being installed
|
| 3508 | 659 |
* @return the preferred size of the viewport for a view component |
660 |
* @see Scrollable#getPreferredScrollableViewportSize() |
|
661 |
*/ |
|
662 |
public Dimension getPreferredScrollableViewportSize(JLayer<? extends V> l) {
|
|
663 |
if (l.getView() instanceof Scrollable) {
|
|
664 |
return ((Scrollable)l.getView()).getPreferredScrollableViewportSize(); |
|
665 |
} |
|
666 |
return l.getPreferredSize(); |
|
667 |
} |
|
668 |
||
669 |
/** |
|
670 |
* Returns a scroll increment, which is required for components |
|
671 |
* that display logical rows or columns in order to completely expose |
|
672 |
* one block of rows or columns, depending on the value of orientation. |
|
673 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
674 |
* @param l the {@code JLayer} component where this UI delegate is being installed
|
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
675 |
* @param visibleRect The view area visible within the viewport |
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
676 |
* @param orientation Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. |
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
677 |
* @param direction Less than zero to scroll up/left, greater than zero for down/right. |
| 3508 | 678 |
* @return the "block" increment for scrolling in the specified direction |
679 |
* @see Scrollable#getScrollableBlockIncrement(Rectangle, int, int) |
|
680 |
*/ |
|
681 |
public int getScrollableBlockIncrement(JLayer<? extends V> l, |
|
682 |
Rectangle visibleRect, |
|
683 |
int orientation, int direction) {
|
|
684 |
if (l.getView() instanceof Scrollable) {
|
|
685 |
return ((Scrollable)l.getView()).getScrollableBlockIncrement( |
|
686 |
visibleRect,orientation, direction); |
|
687 |
} |
|
688 |
return (orientation == SwingConstants.VERTICAL) ? visibleRect.height : |
|
689 |
visibleRect.width; |
|
690 |
} |
|
691 |
||
692 |
/** |
|
693 |
* Returns {@code false} to indicate that the height of the viewport does not
|
|
694 |
* determine the height of the layer, unless the preferred height |
|
695 |
* of the layer is smaller than the height of the viewport. |
|
696 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
697 |
* @param l the {@code JLayer} component where this UI delegate is being installed
|
| 3508 | 698 |
* @return whether the layer should track the height of the viewport |
699 |
* @see Scrollable#getScrollableTracksViewportHeight() |
|
700 |
*/ |
|
701 |
public boolean getScrollableTracksViewportHeight(JLayer<? extends V> l) {
|
|
702 |
if (l.getView() instanceof Scrollable) {
|
|
703 |
return ((Scrollable)l.getView()).getScrollableTracksViewportHeight(); |
|
704 |
} |
|
705 |
return false; |
|
706 |
} |
|
707 |
||
708 |
/** |
|
709 |
* Returns {@code false} to indicate that the width of the viewport does not
|
|
710 |
* determine the width of the layer, unless the preferred width |
|
711 |
* of the layer is smaller than the width of the viewport. |
|
712 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
713 |
* @param l the {@code JLayer} component where this UI delegate is being installed
|
| 3508 | 714 |
* @return whether the layer should track the width of the viewport |
715 |
* @see Scrollable |
|
716 |
* @see LayerUI#getScrollableTracksViewportWidth(JLayer) |
|
717 |
*/ |
|
718 |
public boolean getScrollableTracksViewportWidth(JLayer<? extends V> l) {
|
|
719 |
if (l.getView() instanceof Scrollable) {
|
|
720 |
return ((Scrollable)l.getView()).getScrollableTracksViewportWidth(); |
|
721 |
} |
|
722 |
return false; |
|
723 |
} |
|
724 |
||
725 |
/** |
|
726 |
* Returns a scroll increment, which is required for components |
|
727 |
* that display logical rows or columns in order to completely expose |
|
728 |
* one new row or column, depending on the value of orientation. |
|
729 |
* Ideally, components should handle a partially exposed row or column |
|
730 |
* by returning the distance required to completely expose the item. |
|
731 |
* <p> |
|
732 |
* Scrolling containers, like JScrollPane, will use this method |
|
733 |
* each time the user requests a unit scroll. |
|
734 |
* |
|
|
3748
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
735 |
* @param l the {@code JLayer} component where this UI delegate is being installed
|
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
736 |
* @param visibleRect The view area visible within the viewport |
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
737 |
* @param orientation Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. |
|
b88af44d77a8
6875153: JLayer.isOptimizedDrawingEnabled() throws NPE for null glass pane set
alexp
parents:
3737
diff
changeset
|
738 |
* @param direction Less than zero to scroll up/left, greater than zero for down/right. |
| 3508 | 739 |
* @return The "unit" increment for scrolling in the specified direction. |
740 |
* This value should always be positive. |
|
741 |
* @see Scrollable#getScrollableUnitIncrement(Rectangle, int, int) |
|
742 |
*/ |
|
743 |
public int getScrollableUnitIncrement(JLayer<? extends V> l, |
|
744 |
Rectangle visibleRect, |
|
745 |
int orientation, int direction) {
|
|
746 |
if (l.getView() instanceof Scrollable) {
|
|
747 |
return ((Scrollable)l.getView()).getScrollableUnitIncrement( |
|
748 |
visibleRect, orientation, direction); |
|
749 |
} |
|
750 |
return 1; |
|
751 |
} |
|
752 |
||
753 |
/** |
|
754 |
* If the {@code JLayer}'s view component is not {@code null},
|
|
755 |
* this calls the view's {@code getBaseline()} method.
|
|
756 |
* Otherwise, the default implementation is called. |
|
757 |
* |
|
758 |
* @param c {@code JLayer} to return baseline resize behavior for
|
|
759 |
* @param width the width to get the baseline for |
|
760 |
* @param height the height to get the baseline for |
|
761 |
* @return baseline or a value < 0 indicating there is no reasonable |
|
762 |
* baseline |
|
763 |
*/ |
|
764 |
public int getBaseline(JComponent c, int width, int height) {
|
|
765 |
JLayer l = (JLayer) c; |
|
766 |
if (l.getView() != null) {
|
|
767 |
return l.getView().getBaseline(width, height); |
|
768 |
} |
|
769 |
return super.getBaseline(c, width, height); |
|
770 |
} |
|
771 |
||
772 |
/** |
|
773 |
* If the {@code JLayer}'s view component is not {@code null},
|
|
774 |
* this calls the view's {@code getBaselineResizeBehavior()} method.
|
|
775 |
* Otherwise, the default implementation is called. |
|
776 |
* |
|
777 |
* @param c {@code JLayer} to return baseline resize behavior for
|
|
778 |
* @return an enum indicating how the baseline changes as the component |
|
779 |
* size changes |
|
780 |
*/ |
|
781 |
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c) {
|
|
782 |
JLayer l = (JLayer) c; |
|
783 |
if (l.getView() != null) {
|
|
784 |
return l.getView().getBaselineResizeBehavior(); |
|
785 |
} |
|
786 |
return super.getBaselineResizeBehavior(c); |
|
787 |
} |
|
| 3733 | 788 |
} |