1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
|
/* BasicScrollBarUI.java --
Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
package javax.swing.plaf.basic;
import gnu.classpath.NotImplementedException;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Insets;
import java.awt.LayoutManager;
import java.awt.Rectangle;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.swing.BoundedRangeModel;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JScrollBar;
import javax.swing.LookAndFeel;
import javax.swing.SwingConstants;
import javax.swing.SwingUtilities;
import javax.swing.Timer;
import javax.swing.UIManager;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.ScrollBarUI;
/**
* The Basic Look and Feel UI delegate for JScrollBar.
*/
public class BasicScrollBarUI extends ScrollBarUI implements LayoutManager,
SwingConstants
{
/**
* A helper class that listens to the two JButtons on each end of the
* JScrollBar.
*/
protected class ArrowButtonListener extends MouseAdapter
{
/**
* Move the thumb in the direction specified by the button's arrow. If
* this button is held down, then it should keep moving the thumb.
*
* @param e The MouseEvent fired by the JButton.
*/
public void mousePressed(MouseEvent e)
{
scrollTimer.stop();
scrollListener.setScrollByBlock(false);
if (e.getSource() == incrButton)
scrollListener.setDirection(POSITIVE_SCROLL);
else if (e.getSource() == decrButton)
scrollListener.setDirection(NEGATIVE_SCROLL);
scrollTimer.setDelay(100);
scrollTimer.start();
}
/**
* Stops the thumb when the JButton is released.
*
* @param e The MouseEvent fired by the JButton.
*/
public void mouseReleased(MouseEvent e)
{
scrollTimer.stop();
scrollTimer.setDelay(300);
if (e.getSource() == incrButton)
scrollByUnit(POSITIVE_SCROLL);
else if (e.getSource() == decrButton)
scrollByUnit(NEGATIVE_SCROLL);
}
}
/**
* A helper class that listens to the ScrollBar's model for ChangeEvents.
*/
protected class ModelListener implements ChangeListener
{
/**
* Called when the model changes.
*
* @param e The ChangeEvent fired by the model.
*/
public void stateChanged(ChangeEvent e)
{
calculatePreferredSize();
updateThumbRect();
scrollbar.repaint();
}
}
/**
* A helper class that listens to the ScrollBar's properties.
*/
public class PropertyChangeHandler implements PropertyChangeListener
{
/**
* Called when one of the ScrollBar's properties change.
*
* @param e The PropertyChangeEvent fired by the ScrollBar.
*/
public void propertyChange(PropertyChangeEvent e)
{
if (e.getPropertyName().equals("model"))
{
((BoundedRangeModel) e.getOldValue()).removeChangeListener(modelListener);
scrollbar.getModel().addChangeListener(modelListener);
updateThumbRect();
}
else if (e.getPropertyName().equals("orientation"))
{
uninstallListeners();
uninstallComponents();
uninstallDefaults();
installDefaults();
installComponents();
installListeners();
}
else if (e.getPropertyName().equals("enabled"))
{
Boolean b = (Boolean) e.getNewValue();
if (incrButton != null)
incrButton.setEnabled(b.booleanValue());
if (decrButton != null)
decrButton.setEnabled(b.booleanValue());
}
}
}
/**
* A helper class that listens for events from the timer that is used to
* move the thumb.
*/
protected class ScrollListener implements ActionListener
{
/** The direction the thumb moves in. */
private transient int direction;
/** Whether movement will be in blocks. */
private transient boolean block;
/**
* Creates a new ScrollListener object. The default is scrolling
* positively with block movement.
*/
public ScrollListener()
{
direction = POSITIVE_SCROLL;
block = true;
}
/**
* Creates a new ScrollListener object using the given direction and
* block.
*
* @param dir The direction to move in.
* @param block Whether movement will be in blocks.
*/
public ScrollListener(int dir, boolean block)
{
direction = dir;
this.block = block;
}
/**
* Sets the direction to scroll in.
*
* @param direction The direction to scroll in.
*/
public void setDirection(int direction)
{
this.direction = direction;
}
/**
* Sets whether scrolling will be done in blocks.
*
* @param block Whether scrolling will be in blocks.
*/
public void setScrollByBlock(boolean block)
{
this.block = block;
}
/**
* Called every time the timer reaches its interval.
*
* @param e The ActionEvent fired by the timer.
*/
public void actionPerformed(ActionEvent e)
{
if (block)
{
// Only need to check it if it's block scrolling
// We only block scroll if the click occurs
// in the track.
if (!trackListener.shouldScroll(direction))
{
trackHighlight = NO_HIGHLIGHT;
scrollbar.repaint();
return;
}
scrollByBlock(direction);
}
else
scrollByUnit(direction);
}
}
/**
* Helper class that listens for movement on the track.
*/
protected class TrackListener extends MouseAdapter
implements MouseMotionListener
{
/** The current X coordinate of the mouse. */
protected int currentMouseX;
/** The current Y coordinate of the mouse. */
protected int currentMouseY;
/**
* The offset between the current mouse cursor and the current value of
* the scrollbar.
*/
protected int offset;
/**
* This method is called when the mouse is being dragged.
*
* @param e The MouseEvent given.
*/
public void mouseDragged(MouseEvent e)
{
currentMouseX = e.getX();
currentMouseY = e.getY();
if (scrollbar.getValueIsAdjusting())
{
int value;
if (scrollbar.getOrientation() == SwingConstants.HORIZONTAL)
value = valueForXPosition(currentMouseX) - offset;
else
value = valueForYPosition(currentMouseY) - offset;
scrollbar.setValue(value);
}
}
/**
* This method is called when the mouse is moved.
*
* @param e The MouseEvent given.
*/
public void mouseMoved(MouseEvent e)
{
// Not interested in where the mouse
// is unless it is being dragged.
}
/**
* This method is called when the mouse is pressed. When it is pressed,
* the thumb should move in blocks towards the cursor.
*
* @param e The MouseEvent given.
*/
public void mousePressed(MouseEvent e)
{
currentMouseX = e.getX();
currentMouseY = e.getY();
int value;
if (scrollbar.getOrientation() == SwingConstants.HORIZONTAL)
value = valueForXPosition(currentMouseX);
else
value = valueForYPosition(currentMouseY);
if (! thumbRect.contains(e.getPoint()))
{
scrollTimer.stop();
scrollListener.setScrollByBlock(true);
if (value > scrollbar.getValue())
{
trackHighlight = INCREASE_HIGHLIGHT;
scrollListener.setDirection(POSITIVE_SCROLL);
}
else
{
trackHighlight = DECREASE_HIGHLIGHT;
scrollListener.setDirection(NEGATIVE_SCROLL);
}
scrollTimer.setDelay(100);
scrollTimer.start();
}
else
{
// We'd like to keep track of where the cursor
// is inside the thumb.
// This works because the scrollbar's value represents
// "lower" edge of the thumb. The value at which
// the cursor is at must be greater or equal
// to that value.
scrollListener.setScrollByBlock(false);
scrollbar.setValueIsAdjusting(true);
offset = value - scrollbar.getValue();
}
scrollbar.repaint();
}
/**
* This method is called when the mouse is released. It should stop
* movement on the thumb
*
* @param e The MouseEvent given.
*/
public void mouseReleased(MouseEvent e)
{
scrollTimer.stop();
scrollTimer.setDelay(300);
currentMouseX = e.getX();
currentMouseY = e.getY();
if (shouldScroll(POSITIVE_SCROLL))
scrollByBlock(POSITIVE_SCROLL);
else if (shouldScroll(NEGATIVE_SCROLL))
scrollByBlock(NEGATIVE_SCROLL);
trackHighlight = NO_HIGHLIGHT;
scrollListener.setScrollByBlock(false);
scrollbar.setValueIsAdjusting(true);
scrollbar.repaint();
}
/**
* A helper method that decides whether we should keep scrolling in the
* given direction.
*
* @param direction The direction to check for.
*
* @return Whether the thumb should keep scrolling.
*/
boolean shouldScroll(int direction)
{
int value;
if (scrollbar.getOrientation() == HORIZONTAL)
value = valueForXPosition(currentMouseX);
else
value = valueForYPosition(currentMouseY);
if (thumbRect.contains(currentMouseX, currentMouseY))
return false;
if (direction == POSITIVE_SCROLL)
return (value > scrollbar.getValue());
else
return (value < scrollbar.getValue());
}
}
/** The listener that listens to the JButtons. */
protected ArrowButtonListener buttonListener;
/** The listener that listens to the model. */
protected ModelListener modelListener;
/** The listener that listens to the scrollbar for property changes. */
protected PropertyChangeListener propertyChangeListener;
/** The listener that listens to the timer. */
protected ScrollListener scrollListener;
/** The listener that listens for MouseEvents on the track. */
protected TrackListener trackListener;
/** The JButton that decrements the scrollbar's value. */
protected JButton decrButton;
/** The JButton that increments the scrollbar's value. */
protected JButton incrButton;
/** The dimensions of the maximum thumb size. */
protected Dimension maximumThumbSize;
/** The dimensions of the minimum thumb size. */
protected Dimension minimumThumbSize;
/** The color of the thumb. */
protected Color thumbColor;
/** The outer shadow of the thumb. */
protected Color thumbDarkShadowColor;
/** The top and left edge color for the thumb. */
protected Color thumbHighlightColor;
/** The outer light shadow for the thumb. */
protected Color thumbLightShadowColor;
/** The color that is used when the mouse press occurs in the track. */
protected Color trackHighlightColor;
/** The color of the track. */
protected Color trackColor;
/** The size and position of the track. */
protected Rectangle trackRect;
/** The size and position of the thumb. */
protected Rectangle thumbRect;
/** Indicates that the decrease highlight should be painted. */
protected static final int DECREASE_HIGHLIGHT = 1;
/** Indicates that the increase highlight should be painted. */
protected static final int INCREASE_HIGHLIGHT = 2;
/** Indicates that no highlight should be painted. */
protected static final int NO_HIGHLIGHT = 0;
/** Indicates that the scrolling direction is positive. */
private static final int POSITIVE_SCROLL = 1;
/** Indicates that the scrolling direction is negative. */
private static final int NEGATIVE_SCROLL = -1;
/** The cached preferred size for the scrollbar. */
private transient Dimension preferredSize;
/** The current highlight status. */
protected int trackHighlight;
/** FIXME: Use this for something (presumably mouseDragged) */
protected boolean isDragging;
/** The timer used to move the thumb when the mouse is held. */
protected Timer scrollTimer;
/** The scrollbar this UI is acting for. */
protected JScrollBar scrollbar;
/**
* This method adds a component to the layout.
*
* @param name The name to associate with the component that is added.
* @param child The Component to add.
*/
public void addLayoutComponent(String name, Component child)
{
// You should not be adding stuff to this component.
// The contents are fixed.
}
/**
* This method configures the scrollbar's colors. This can be done by
* looking up the standard colors from the Look and Feel defaults.
*/
protected void configureScrollBarColors()
{
trackColor = UIManager.getColor("ScrollBar.track");
trackHighlightColor = UIManager.getColor("ScrollBar.trackHighlight");
thumbColor = UIManager.getColor("ScrollBar.thumb");
thumbHighlightColor = UIManager.getColor("ScrollBar.thumbHighlight");
thumbDarkShadowColor = UIManager.getColor("ScrollBar.thumbDarkShadow");
thumbLightShadowColor = UIManager.getColor("ScrollBar.thumbShadow");
}
/**
* This method creates an ArrowButtonListener.
*
* @return A new ArrowButtonListener.
*/
protected ArrowButtonListener createArrowButtonListener()
{
return new ArrowButtonListener();
}
/**
* This method creates a new JButton with the appropriate icon for the
* orientation.
*
* @param orientation The orientation this JButton uses.
*
* @return The increase JButton.
*/
protected JButton createIncreaseButton(int orientation)
{
return new BasicArrowButton(orientation);
}
/**
* This method creates a new JButton with the appropriate icon for the
* orientation.
*
* @param orientation The orientation this JButton uses.
*
* @return The decrease JButton.
*/
protected JButton createDecreaseButton(int orientation)
{
return new BasicArrowButton(orientation);
}
/**
* This method creates a new ModelListener.
*
* @return A new ModelListener.
*/
protected ModelListener createModelListener()
{
return new ModelListener();
}
/**
* This method creates a new PropertyChangeListener.
*
* @return A new PropertyChangeListener.
*/
protected PropertyChangeListener createPropertyChangeListener()
{
return new PropertyChangeHandler();
}
/**
* This method creates a new ScrollListener.
*
* @return A new ScrollListener.
*/
protected ScrollListener createScrollListener()
{
return new ScrollListener();
}
/**
* This method creates a new TrackListener.
*
* @return A new TrackListener.
*/
protected TrackListener createTrackListener()
{
return new TrackListener();
}
/**
* This method returns a new BasicScrollBarUI.
*
* @param c The JComponent to create a UI for.
*
* @return A new BasicScrollBarUI.
*/
public static ComponentUI createUI(JComponent c)
{
return new BasicScrollBarUI();
}
/**
* This method returns the maximum size for this JComponent.
*
* @param c The JComponent to measure the maximum size for.
*
* @return The maximum size for the component.
*/
public Dimension getMaximumSize(JComponent c)
{
return new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);
}
/**
* This method returns the maximum thumb size.
*
* @return The maximum thumb size.
*/
protected Dimension getMaximumThumbSize()
{
return maximumThumbSize;
}
/**
* This method returns the minimum size for this JComponent.
*
* @param c The JComponent to measure the minimum size for.
*
* @return The minimum size for the component.
*/
public Dimension getMinimumSize(JComponent c)
{
return getPreferredSize(c);
}
/**
* This method returns the minimum thumb size.
*
* @return The minimum thumb size.
*/
protected Dimension getMinimumThumbSize()
{
return minimumThumbSize;
}
/**
* This method calculates the preferred size since calling
* getPreferredSize() returns a cached value.
* This is package-private to avoid an accessor method.
*/
void calculatePreferredSize()
{
int height;
int width;
height = width = 0;
if (scrollbar.getOrientation() == SwingConstants.HORIZONTAL)
{
width += incrButton.getPreferredSize().getWidth();
width += decrButton.getPreferredSize().getWidth();
width += 16;
height = UIManager.getInt("ScrollBar.width");
}
else
{
height += incrButton.getPreferredSize().getHeight();
height += decrButton.getPreferredSize().getHeight();
height += 16;
width = UIManager.getInt("ScrollBar.width");
}
Insets insets = scrollbar.getInsets();
height += insets.top + insets.bottom;
width += insets.left + insets.right;
preferredSize = new Dimension(width, height);
}
/**
* This method returns a cached value of the preferredSize. The only
* restrictions are: If the scrollbar is horizontal, the height should be
* the maximum of the height of the JButtons and the minimum width of the
* thumb. For vertical scrollbars, the calculation is similar (swap width
* for height and vice versa).
*
* @param c The JComponent to measure.
*
* @return The preferredSize.
*/
public Dimension getPreferredSize(JComponent c)
{
calculatePreferredSize();
return preferredSize;
}
/**
* This method returns the thumb's bounds based on the current value of the
* scrollbar. This method updates the cached value and returns that.
*
* @return The thumb bounds.
*/
protected Rectangle getThumbBounds()
{
return thumbRect;
}
/**
* This method calculates the bounds of the track. This method updates the
* cached value and returns it.
*
* @return The track's bounds.
*/
protected Rectangle getTrackBounds()
{
return trackRect;
}
/**
* This method installs any addition Components that are a part of or
* related to this scrollbar.
*/
protected void installComponents()
{
int orientation = scrollbar.getOrientation();
switch (orientation)
{
case (JScrollBar.HORIZONTAL):
incrButton = createIncreaseButton(EAST);
decrButton = createDecreaseButton(WEST);
break;
default:
incrButton = createIncreaseButton(SOUTH);
decrButton = createDecreaseButton(NORTH);
break;
}
if (incrButton != null)
scrollbar.add(incrButton);
if (decrButton != null)
scrollbar.add(decrButton);
}
/**
* This method installs the defaults for the scrollbar specified by the
* Basic Look and Feel.
*/
protected void installDefaults()
{
LookAndFeel.installColors(scrollbar, "ScrollBar.background",
"ScrollBar.foreground");
LookAndFeel.installBorder(scrollbar, "ScrollBar.border");
scrollbar.setOpaque(true);
scrollbar.setLayout(this);
thumbColor = UIManager.getColor("ScrollBar.thumb");
thumbDarkShadowColor = UIManager.getColor("ScrollBar.thumbDarkShadow");
thumbHighlightColor = UIManager.getColor("ScrollBar.thumbHighlight");
thumbLightShadowColor = UIManager.getColor("ScrollBar.thumbShadow");
maximumThumbSize = UIManager.getDimension("ScrollBar.maximumThumbSize");
minimumThumbSize = UIManager.getDimension("ScrollBar.minimumThumbSize");
}
/**
* This method installs the keyboard actions for the scrollbar.
*/
protected void installKeyboardActions()
throws NotImplementedException
{
// FIXME: implement.
}
/**
* This method installs any listeners for the scrollbar. This method also
* installs listeners for things such as the JButtons and the timer.
*/
protected void installListeners()
{
scrollListener = createScrollListener();
trackListener = createTrackListener();
buttonListener = createArrowButtonListener();
modelListener = createModelListener();
propertyChangeListener = createPropertyChangeListener();
scrollbar.addMouseMotionListener(trackListener);
scrollbar.addMouseListener(trackListener);
incrButton.addMouseListener(buttonListener);
decrButton.addMouseListener(buttonListener);
scrollbar.addPropertyChangeListener(propertyChangeListener);
scrollbar.getModel().addChangeListener(modelListener);
scrollTimer.addActionListener(scrollListener);
}
/**
* This method installs the UI for the component. This can include setting
* up listeners, defaults, and components. This also includes initializing
* any data objects.
*
* @param c The JComponent to install.
*/
public void installUI(JComponent c)
{
super.installUI(c);
if (c instanceof JScrollBar)
{
scrollbar = (JScrollBar) c;
trackRect = new Rectangle();
thumbRect = new Rectangle();
scrollTimer = new Timer(300, null);
installDefaults();
installComponents();
configureScrollBarColors();
installListeners();
calculatePreferredSize();
}
}
/**
* This method lays out the scrollbar.
*
* @param scrollbarContainer The Container to layout.
*/
public void layoutContainer(Container scrollbarContainer)
{
if (scrollbarContainer instanceof JScrollBar)
{
if (scrollbar.getOrientation() == SwingConstants.HORIZONTAL)
layoutHScrollbar((JScrollBar) scrollbarContainer);
else
layoutVScrollbar((JScrollBar) scrollbarContainer);
}
}
/**
* This method lays out the scrollbar horizontally.
*
* @param sb The JScrollBar to layout.
*/
protected void layoutHScrollbar(JScrollBar sb)
{
Rectangle vr = new Rectangle();
SwingUtilities.calculateInnerArea(scrollbar, vr);
Dimension incrDims = incrButton.getPreferredSize();
Dimension decrDims = decrButton.getPreferredSize();
// calculate and update the track bounds
SwingUtilities.calculateInnerArea(scrollbar, trackRect);
trackRect.width -= incrDims.getWidth();
trackRect.width -= decrDims.getWidth();
trackRect.x += decrDims.getWidth();
updateThumbRect();
decrButton.setBounds(vr.x, vr.y, decrDims.width, trackRect.height);
incrButton.setBounds(trackRect.x + trackRect.width, vr.y, incrDims.width,
trackRect.height);
}
/**
* This method lays out the scrollbar vertically.
*
* @param sb The JScrollBar to layout.
*/
protected void layoutVScrollbar(JScrollBar sb)
{
Rectangle vr = new Rectangle();
SwingUtilities.calculateInnerArea(scrollbar, vr);
Dimension incrDims = incrButton.getPreferredSize();
Dimension decrDims = decrButton.getPreferredSize();
// Update rectangles
SwingUtilities.calculateInnerArea(scrollbar, trackRect);
trackRect.height -= incrDims.getHeight();
trackRect.height -= decrDims.getHeight();
trackRect.y += decrDims.getHeight();
updateThumbRect();
decrButton.setBounds(vr.x, vr.y, trackRect.width, decrDims.height);
incrButton.setBounds(vr.x, trackRect.y + trackRect.height,
trackRect.width, incrDims.height);
}
/**
* Updates the thumb rect.
*/
void updateThumbRect()
{
int max = scrollbar.getMaximum();
int min = scrollbar.getMinimum();
int value = scrollbar.getValue();
int extent = scrollbar.getVisibleAmount();
if (max - extent <= min)
{
if (scrollbar.getOrientation() == JScrollBar.HORIZONTAL)
{
thumbRect.x = trackRect.x;
thumbRect.y = trackRect.y;
thumbRect.width = getMinimumThumbSize().width;
thumbRect.height = trackRect.height;
}
else
{
thumbRect.x = trackRect.x;
thumbRect.y = trackRect.y;
thumbRect.width = trackRect.width;
thumbRect.height = getMinimumThumbSize().height;
}
}
else
{
if (scrollbar.getOrientation() == JScrollBar.HORIZONTAL)
{
thumbRect.x = trackRect.x;
thumbRect.width = Math.max(extent * trackRect.width / (max - min),
getMinimumThumbSize().width);
int availableWidth = trackRect.width - thumbRect.width;
thumbRect.x += (value - min) * availableWidth / (max - min - extent);
thumbRect.y = trackRect.y;
thumbRect.height = trackRect.height;
}
else
{
thumbRect.x = trackRect.x;
thumbRect.height = Math.max(extent * trackRect.height / (max - min),
getMinimumThumbSize().height);
int availableHeight = trackRect.height - thumbRect.height;
thumbRect.y = trackRect.y
+ (value - min) * availableHeight / (max - min - extent);
thumbRect.width = trackRect.width;
}
}
}
/**
* This method returns the minimum size required for the layout.
*
* @param scrollbarContainer The Container that is laid out.
*
* @return The minimum size.
*/
public Dimension minimumLayoutSize(Container scrollbarContainer)
{
return preferredLayoutSize(scrollbarContainer);
}
/**
* This method is called when the component is painted.
*
* @param g The Graphics object to paint with.
* @param c The JComponent to paint.
*/
public void paint(Graphics g, JComponent c)
{
paintTrack(g, c, getTrackBounds());
paintThumb(g, c, getThumbBounds());
if (trackHighlight == INCREASE_HIGHLIGHT)
paintIncreaseHighlight(g);
else if (trackHighlight == DECREASE_HIGHLIGHT)
paintDecreaseHighlight(g);
}
/**
* This method is called when repainting and the mouse is pressed in the
* track. It paints the track below the thumb with the trackHighlight
* color.
*
* @param g The Graphics object to paint with.
*/
protected void paintDecreaseHighlight(Graphics g)
{
Color saved = g.getColor();
g.setColor(trackHighlightColor);
if (scrollbar.getOrientation() == HORIZONTAL)
g.fillRect(trackRect.x, trackRect.y, thumbRect.x - trackRect.x,
trackRect.height);
else
g.fillRect(trackRect.x, trackRect.y, trackRect.width,
thumbRect.y - trackRect.y);
g.setColor(saved);
}
/**
* This method is called when repainting and the mouse is pressed in the
* track. It paints the track above the thumb with the trackHighlight
* color.
*
* @param g The Graphics objet to paint with.
*/
protected void paintIncreaseHighlight(Graphics g)
{
Color saved = g.getColor();
g.setColor(trackHighlightColor);
if (scrollbar.getOrientation() == HORIZONTAL)
g.fillRect(thumbRect.x + thumbRect.width, trackRect.y,
trackRect.x + trackRect.width - thumbRect.x - thumbRect.width,
trackRect.height);
else
g.fillRect(trackRect.x, thumbRect.y + thumbRect.height, trackRect.width,
trackRect.y + trackRect.height - thumbRect.y
- thumbRect.height);
g.setColor(saved);
}
/**
* This method paints the thumb.
*
* @param g The Graphics object to paint with.
* @param c The Component that is being painted.
* @param thumbBounds The thumb bounds.
*/
protected void paintThumb(Graphics g, JComponent c, Rectangle thumbBounds)
{
g.setColor(thumbColor);
g.fillRect(thumbBounds.x, thumbBounds.y, thumbBounds.width,
thumbBounds.height);
BasicGraphicsUtils.drawBezel(g, thumbBounds.x, thumbBounds.y,
thumbBounds.width, thumbBounds.height,
false, false, thumbDarkShadowColor,
thumbDarkShadowColor, thumbHighlightColor,
thumbHighlightColor);
}
/**
* This method paints the track.
*
* @param g The Graphics object to paint with.
* @param c The JComponent being painted.
* @param trackBounds The track's bounds.
*/
protected void paintTrack(Graphics g, JComponent c, Rectangle trackBounds)
{
Color saved = g.getColor();
g.setColor(trackColor);
g.fill3DRect(trackBounds.x, trackBounds.y, trackBounds.width,
trackBounds.height, false);
g.setColor(saved);
}
/**
* This method returns the preferred size for the layout.
*
* @param scrollbarContainer The Container to find a size for.
*
* @return The preferred size for the layout.
*/
public Dimension preferredLayoutSize(Container scrollbarContainer)
{
if (scrollbarContainer instanceof JComponent)
return getPreferredSize((JComponent) scrollbarContainer);
else
return null;
}
/**
* This method removes a child component from the layout.
*
* @param child The child to remove.
*/
public void removeLayoutComponent(Component child)
{
// You should not be removing stuff from this component.
}
/**
* The method scrolls the thumb by a block in the direction specified.
*
* @param direction The direction to scroll.
*/
protected void scrollByBlock(int direction)
{
scrollbar.setValue(scrollbar.getValue()
+ scrollbar.getBlockIncrement(direction));
}
/**
* The method scrolls the thumb by a unit in the direction specified.
*
* @param direction The direction to scroll.
*/
protected void scrollByUnit(int direction)
{
scrollbar.setValue(scrollbar.getValue()
+ scrollbar.getUnitIncrement(direction));
}
/**
* This method sets the thumb's bounds.
*
* @param x The X position of the thumb.
* @param y The Y position of the thumb.
* @param width The width of the thumb.
* @param height The height of the thumb.
*/
protected void setThumbBounds(int x, int y, int width, int height)
{
thumbRect.x = x;
thumbRect.y = y;
thumbRect.width = width;
thumbRect.height = height;
}
/**
* This method uninstalls any components that are a part of or related to
* this scrollbar.
*/
protected void uninstallComponents()
{
if (incrButton != null)
scrollbar.remove(incrButton);
if (decrButton != null)
scrollbar.remove(decrButton);
}
/**
* This method uninstalls any defaults that this scrollbar acquired from the
* Basic Look and Feel defaults.
*/
protected void uninstallDefaults()
{
scrollbar.setForeground(null);
scrollbar.setBackground(null);
LookAndFeel.uninstallBorder(scrollbar);
incrButton = null;
decrButton = null;
}
/**
* This method uninstalls any keyboard actions this scrollbar acquired
* during install.
*/
protected void uninstallKeyboardActions()
throws NotImplementedException
{
// FIXME: implement.
}
/**
* This method uninstalls any listeners that were registered during install.
*/
protected void uninstallListeners()
{
if (scrollTimer != null)
scrollTimer.removeActionListener(scrollListener);
if (scrollbar != null)
{
scrollbar.getModel().removeChangeListener(modelListener);
scrollbar.removePropertyChangeListener(propertyChangeListener);
scrollbar.removeMouseListener(trackListener);
scrollbar.removeMouseMotionListener(trackListener);
}
if (decrButton != null)
decrButton.removeMouseListener(buttonListener);
if (incrButton != null)
incrButton.removeMouseListener(buttonListener);
propertyChangeListener = null;
modelListener = null;
buttonListener = null;
trackListener = null;
scrollListener = null;
}
/**
* This method uninstalls the UI. This includes removing any defaults,
* listeners, and components that this UI may have initialized. It also
* nulls any instance data.
*
* @param c The Component to uninstall for.
*/
public void uninstallUI(JComponent c)
{
uninstallListeners();
uninstallDefaults();
uninstallComponents();
scrollTimer = null;
thumbRect = null;
trackRect = null;
trackColor = null;
trackHighlightColor = null;
thumbColor = null;
thumbHighlightColor = null;
thumbDarkShadowColor = null;
thumbLightShadowColor = null;
scrollbar = null;
}
/**
* This method returns the value in the scrollbar's range given the y
* coordinate. If the value is out of range, it will return the closest
* legal value.
* This is package-private to avoid an accessor method.
*
* @param yPos The y coordinate to calculate a value for.
*
* @return The value for the y coordinate.
*/
int valueForYPosition(int yPos)
{
int min = scrollbar.getMinimum();
int max = scrollbar.getMaximum();
int len = trackRect.height;
int value;
// If the length is 0, you shouldn't be able to even see where the thumb is.
// This really shouldn't ever happen, but just in case, we'll return the middle.
if (len == 0)
return ((max - min) / 2);
value = ((yPos - trackRect.y) * (max - min) / len + min);
// If this isn't a legal value, then we'll have to move to one now.
if (value > max)
value = max;
else if (value < min)
value = min;
return value;
}
/**
* This method returns the value in the scrollbar's range given the x
* coordinate. If the value is out of range, it will return the closest
* legal value.
* This is package-private to avoid an accessor method.
*
* @param xPos The x coordinate to calculate a value for.
*
* @return The value for the x coordinate.
*/
int valueForXPosition(int xPos)
{
int min = scrollbar.getMinimum();
int max = scrollbar.getMaximum();
int len = trackRect.width;
int value;
// If the length is 0, you shouldn't be able to even see where the slider is.
// This really shouldn't ever happen, but just in case, we'll return the middle.
if (len == 0)
return ((max - min) / 2);
value = ((xPos - trackRect.x) * (max - min) / len + min);
// If this isn't a legal value, then we'll have to move to one now.
if (value > max)
value = max;
else if (value < min)
value = min;
return value;
}
}
|