Dead
[official-gcc.git] / gomp-20050608-branch / libjava / classpath / javax / swing / plaf / metal / MetalSliderUI.java
blob08fb99d216c0625da666bf63f45319858d924fb3
1 /* MetalSliderUI.java
2 Copyright (C) 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
39 package javax.swing.plaf.metal;
41 import java.awt.Color;
42 import java.awt.Dimension;
43 import java.awt.Graphics;
44 import java.awt.Rectangle;
45 import java.beans.PropertyChangeEvent;
46 import java.beans.PropertyChangeListener;
48 import javax.swing.Icon;
49 import javax.swing.JComponent;
50 import javax.swing.JSlider;
51 import javax.swing.UIManager;
52 import javax.swing.plaf.ComponentUI;
53 import javax.swing.plaf.basic.BasicGraphicsUtils;
54 import javax.swing.plaf.basic.BasicSliderUI;
56 /**
57 * A UI delegate for the {@link JSlider} component.
59 public class MetalSliderUI extends BasicSliderUI
61 /**
62 * A property change handler that updates the rendered component in response
63 * to specific property change events. This custom handler is used to
64 * intercept the "JSlider.isFilled" property, which is only recognised by
65 * the {@link MetalLookAndFeel}.
67 protected class MetalPropertyListener
68 extends BasicSliderUI.PropertyChangeHandler
70 /**
71 * Creates a new listener.
73 protected MetalPropertyListener()
75 // Nothing to do here.
78 /**
79 * Handles property change events. Events with the name "JSlider.isFilled"
80 * are handled here, and other events are passed to the superclass.
82 * @param e the property change event.
84 public void propertyChange(PropertyChangeEvent e)
86 if (e.getPropertyName().equals(SLIDER_FILL))
88 Boolean b = (Boolean) e.getNewValue();
89 if (b == null)
90 filledSlider = false;
91 else
92 filledSlider = b.booleanValue();
94 else
95 super.propertyChange(e);
99 /** The thumb color (unused, because an icon is used to draw the thumb). */
100 protected static Color thumbColor;
102 /**
103 * The highlight color used for drawing the track rect when the slider is
104 * enabled.
106 protected static Color highlightColor;
109 * The shadow color used for drawing the track rect when the slider is
110 * enabled.
112 protected static Color darkShadowColor;
114 /** The track width. */
115 protected static int trackWidth = UIManager.getInt("Slider.trackWidth");
117 /** The length of the major tick marks. */
118 protected static int tickLength = UIManager.getInt("Slider.majorTickLength");
120 /** The icon used for the thumb control of horizontally oriented sliders. */
121 protected static Icon horizThumbIcon = UIManager.getIcon(
122 "Slider.horizontalThumbIcon");
124 /** The icon used for the thumb control of vertically oriented sliders. */
125 protected static Icon vertThumbIcon = UIManager.getIcon(
126 "Slider.verticalThumbIcon");
128 /** The gap between the track and the tick marks. */
129 protected final int TICK_BUFFER = 4;
131 /** A key to look up the filledSlider setting in the {@link UIManager}. */
132 protected final String SLIDER_FILL = "JSlider.isFilled";
134 /**
135 * A flag that controls whether or not the track is filled up to the value
136 * of the slider.
138 protected boolean filledSlider;
141 * Constructs a new instance.
143 public MetalSliderUI()
145 super(null);
146 filledSlider = UIManager.getBoolean(SLIDER_FILL);
147 darkShadowColor = MetalLookAndFeel.getControlDarkShadow();
148 highlightColor = MetalLookAndFeel.getControlHighlight();
152 * Returns a new instance of <code>MetalSliderUI</code>.
154 * @param component the component (ignored).
156 * @return A new instance of <code>MetalSliderUI</code>.
158 public static ComponentUI createUI(JComponent component)
160 return new MetalSliderUI();
164 * Installs the default for this UI delegate in the supplied component.
166 * @param c the component.
168 public void installUI(JComponent c)
170 super.installUI(c);
171 Boolean b = (Boolean) c.getClientProperty(SLIDER_FILL);
172 if (b != null)
173 filledSlider = b.booleanValue();
177 * Creates a property change listener for the slider.
179 * @param slider the slider.
181 * @return A new instance of {@link MetalPropertyListener}.
183 protected PropertyChangeListener createPropertyChangeListener(JSlider slider)
185 return new MetalPropertyListener();
189 * Paints the thumb icon for the slider.
191 * @param g the graphics device.
193 public void paintThumb(Graphics g)
195 if (slider.getOrientation() == JSlider.HORIZONTAL)
196 horizThumbIcon.paintIcon(slider, g, thumbRect.x, thumbRect.y);
197 else
198 vertThumbIcon.paintIcon(slider, g, thumbRect.x, thumbRect.y);
202 * Paints the track along which the thumb control moves.
204 * @param g the graphics device.
206 public void paintTrack(Graphics g)
208 Color shadowColor = MetalLookAndFeel.getControlShadow();
209 if (slider.getOrientation() == JSlider.HORIZONTAL)
211 int trackX = trackRect.x;
212 int trackY = trackRect.y + (trackRect.height - getTrackWidth()) / 2;
213 int trackW = trackRect.width - 1;
214 int trackH = getTrackWidth();
216 // draw border
217 if (slider.isEnabled())
218 BasicGraphicsUtils.drawEtchedRect(g, trackX, trackY, trackW, trackH,
219 darkShadowColor, shadowColor, darkShadowColor, highlightColor);
220 else
222 g.setColor(MetalLookAndFeel.getControlShadow());
223 g.drawRect(trackX, trackY, trackW - 2, trackH - 2);
226 // fill track (if required)
227 if (filledSlider)
229 int xPos = xPositionForValue(slider.getValue());
230 int x = (slider.getInverted() ? xPos : trackRect.x);
231 int w = (slider.getInverted() ? trackX + trackW - xPos
232 : xPos - trackRect.x);
233 g.setColor(MetalLookAndFeel.getControlShadow());
234 g.fillRect(x + 1, trackY + 1, w - 3, getTrackWidth() - 3);
235 if (slider.isEnabled())
237 g.setColor(MetalLookAndFeel.getControl());
238 g.drawLine(x + 1, trackY + 1, x + w - 3, trackY + 1);
239 g.drawLine(x + 1, trackY + 1, x + 1,
240 trackY + getTrackWidth() - 3);
244 else
246 int trackX = trackRect.x + (trackRect.width - getTrackWidth()) / 2;
247 int trackY = trackRect.y;
248 int trackW = getTrackWidth();
249 int trackH = trackRect.height - 1;
250 if (slider.isEnabled())
251 BasicGraphicsUtils.drawEtchedRect(g, trackX, trackY, trackW, trackH,
252 darkShadowColor, shadowColor, darkShadowColor, highlightColor);
253 else
255 g.setColor(MetalLookAndFeel.getControlShadow());
256 g.drawRect(trackX, trackY, trackW - 2, trackH - 2);
259 if (filledSlider)
261 int yPos = yPositionForValue(slider.getValue());
262 int y = (slider.getInverted() ? trackY : yPos);
263 int h = (slider.getInverted() ? yPos - trackY
264 : trackY + trackH - yPos);
265 g.setColor(MetalLookAndFeel.getControlShadow());
266 g.fillRect(trackX + 1, y + 1, getTrackWidth() - 3, h - 3);
267 if (slider.isEnabled())
269 g.setColor(MetalLookAndFeel.getControl());
270 g.drawLine(trackX + 1, y + 1, trackX + trackW - 3, y + 1);
271 g.drawLine(trackX + 1, y + 1, trackX + 1, y + h - 3);
278 * Draws the focus rectangle for the slider. The Metal look and feel
279 * indicates that the {@link JSlider} has the focus by changing the color of
280 * the thumb control - this is handled elsewhere and so this method is empty
281 * (it overrides the method in the {@link BasicSliderUI} class to prevent
282 * a default focus highlight from being drawn).
284 * @param g the graphics device.
286 public void paintFocus(Graphics g)
288 // do nothing as focus is shown by different color on thumb control
292 * Returns the size of the thumb icon.
294 * @return The size of the thumb icon.
296 protected Dimension getThumbSize()
298 if (slider.getOrientation() == JSlider.HORIZONTAL)
299 return new Dimension(horizThumbIcon.getIconWidth(),
300 horizThumbIcon.getIconHeight());
301 else
302 return new Dimension(vertThumbIcon.getIconWidth(),
303 vertThumbIcon.getIconHeight());
307 * Returns the length of the major tick marks.
309 * @return The length of the major tick marks.
311 public int getTickLength()
313 return tickLength + TICK_BUFFER;
317 * Returns the track width.
319 * @return The track width.
321 protected int getTrackWidth()
323 return trackWidth;
327 * Returns the track length.
329 * @return The track length.
331 protected int getTrackLength()
333 return (slider.getOrientation() == JSlider.HORIZONTAL
334 ? tickRect.width : tickRect.height);
338 * Returns the thumb overhang.
340 * @return The thumb overhang.
342 protected int getThumbOverhang()
344 // FIXME: for what might this method be used?
345 return 0;
348 protected void scrollDueToClickInTrack(int dir)
350 // FIXME: for what might this method be overridden?
351 super.scrollDueToClickInTrack(dir);
355 * Paints the minor ticks for a slider with a horizontal orientation.
357 * @param g the graphics device.
358 * @param tickBounds the tick bounds.
359 * @param x the x value for the tick.
361 protected void paintMinorTickForHorizSlider(Graphics g, Rectangle tickBounds,
362 int x)
364 // Note the incoming 'g' has a translation in place to get us to the
365 // start of the tick rect already...
366 if (slider.isEnabled())
367 g.setColor(MetalLookAndFeel.getPrimaryControlShadow());
368 else
369 g.setColor(MetalLookAndFeel.getControlDisabled());
370 g.drawLine(x, TICK_BUFFER, x, TICK_BUFFER + tickLength / 2);
374 * Paints the major ticks for a slider with a horizontal orientation.
376 * @param g the graphics device.
377 * @param tickBounds the tick bounds.
378 * @param x the x value for the tick.
380 protected void paintMajorTickForHorizSlider(Graphics g, Rectangle tickBounds,
381 int x)
383 // Note the incoming 'g' has a translation in place to get us to the
384 // start of the tick rect already...
385 if (slider.isEnabled())
386 g.setColor(MetalLookAndFeel.getPrimaryControlShadow());
387 else
388 g.setColor(MetalLookAndFeel.getControlDisabled());
389 g.drawLine(x, TICK_BUFFER, x, TICK_BUFFER + tickLength);
393 * Paints the minor ticks for a slider with a vertical orientation.
395 * @param g the graphics device.
396 * @param tickBounds the tick bounds.
397 * @param y the y value for the tick.
399 protected void paintMinorTickForVertSlider(Graphics g, Rectangle tickBounds,
400 int y)
402 // Note the incoming 'g' has a translation in place to get us to the
403 // start of the tick rect already...
404 if (slider.isEnabled())
405 g.setColor(MetalLookAndFeel.getPrimaryControlShadow());
406 else
407 g.setColor(MetalLookAndFeel.getControlDisabled());
408 g.drawLine(TICK_BUFFER - 1, y, TICK_BUFFER - 1 + tickLength / 2, y);
412 * Paints the major ticks for a slider with a vertical orientation.
414 * @param g the graphics device.
415 * @param tickBounds the tick bounds.
416 * @param y the y value for the tick.
418 protected void paintMajorTickForVertSlider(Graphics g, Rectangle tickBounds,
419 int y)
421 // Note the incoming 'g' has a translation in place to get us to the
422 // start of the tick rect already...
423 if (slider.isEnabled())
424 g.setColor(MetalLookAndFeel.getPrimaryControlShadow());
425 else
426 g.setColor(MetalLookAndFeel.getControlDisabled());
427 g.drawLine(TICK_BUFFER - 1, y, TICK_BUFFER - 1 + tickLength, y);