1. /*

  2.  * @(#)BasicButtonUI.java	1.100 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10.  

  11. package javax.swing.plaf.basic;

  12. 

  13. import java.awt.*;

  14. import java.awt.event.*;

  15. import java.io.Serializable;

  16. import javax.swing.*;

  17. import javax.swing.border.*;

  18. import java.awt.*;

  19. import java.awt.event.*;

  20. import javax.swing.plaf.ButtonUI;

  21. import javax.swing.plaf.UIResource;

  22. import javax.swing.plaf.ComponentUI;

  23. import javax.swing.text.View;

  24. 

  25. /**

  26.  * BasicButton implementation

  27.  *

  28.  * @version 1.100 02/02/00

  29.  * @author Jeff Dinkins

  30.  */

  31. public class BasicButtonUI extends ButtonUI{

  32.     // Shared UI object

  33.     private final static BasicButtonUI buttonUI = new BasicButtonUI();

  34. 

  35.     // Visual constants

  36.     protected int defaultTextIconGap;

  37.     

  38.     // Offset controlled by set method 

  39.     private int shiftOffset = 0;

  40.     protected int defaultTextShiftOffset;

  41. 

  42.     // Has the shared instance defaults been initialized?

  43.     private boolean defaults_initialized = false;

  44. 

  45.     private final static String propertyPrefix = "Button" + ".";

  46. 

  47.     // ********************************

  48.     //          Create PLAF

  49.     // ********************************

  50.     public static ComponentUI createUI(JComponent c) {

  51.         return buttonUI;

  52.     }

  53. 

  54.     protected String getPropertyPrefix() {

  55.         return propertyPrefix;

  56.     }

  57. 

  58. 

  59.     // ********************************

  60.     //          Install PLAF

  61.     // ********************************

  62.     public void installUI(JComponent c) {

  63.         installDefaults((AbstractButton) c);

  64.         installListeners((AbstractButton) c);

  65.         installKeyboardActions((AbstractButton) c);

  66. 	BasicHTML.updateRenderer(c, ((AbstractButton) c).getText());

  67.     }

  68. 

  69.     private Color defaultForeground = null;

  70.     private Color defaultBackground = null;

  71.     private Font defaultFont = null;

  72.     private Border defaultBorder = null;

  73. 

  74.     protected void installDefaults(AbstractButton b) {

  75.         // load shared instance defaults

  76.         String pp = getPropertyPrefix();

  77.         if(!defaults_initialized) {

  78.             defaultTextIconGap = ((Integer)UIManager.get(pp + "textIconGap")).intValue();

  79.             defaultTextShiftOffset = ((Integer)UIManager.get(pp + "textShiftOffset")).intValue();

  80.         

  81. 	    // next four lines part of optimized component defaults installation

  82. 	   /* defaultForeground = UIManager.getColor(pp + "foreground");

  83. 	    defaultBackground = UIManager.getColor(pp + "background");

  84. 	    defaultFont = UIManager.getFont(pp + "font");

  85. 	    defaultBorder = UIManager.getBorder(pp + "border");*/

  86. 

  87.             defaults_initialized = true;

  88.         }

  89. 

  90.         // set the following defaults on the button

  91.         if (b.isContentAreaFilled()) {

  92.             b.setOpaque(true); 

  93.         } else {

  94.             b.setOpaque(false);

  95.         }

  96. 

  97.         if(b.getMargin() == null || (b.getMargin() instanceof UIResource)) {

  98.             b.setMargin(UIManager.getInsets(pp + "margin"));

  99.         }

  100. 

  101. 	// *** begin optimized defaults install ***

  102. 

  103. /*	Color currentForeground = b.getForeground();

  104. 	Color currentBackground = b.getBackground();

  105. 	Font currentFont = b.getFont();

  106. 	Border currentBorder = b.getBorder();

  107. 

  108. 	if (currentForeground == null || currentForeground instanceof UIResource) {

  109. 	      b.setForeground(defaultForeground);

  110. 	}

  111. 

  112. 	if (currentBackground == null || currentBackground instanceof UIResource) {

  113.               b.setBackground(defaultBackground);

  114. 	}

  115. 

  116. 	if (currentFont == null || currentFont instanceof UIResource) {

  117. 	      b.setFont(defaultFont);

  118. 	}

  119. 

  120. 	if (currentBorder == null || currentBorder instanceof UIResource) {

  121. 	      b.setBorder(defaultBorder);

  122. 	} */

  123. 

  124. 	// *** end optimized defaults install ***

  125. 

  126. 	// old code below works for component defaults installation, but it is slow

  127. 	LookAndFeel.installColorsAndFont(b, pp + "background", pp + "foreground", pp + "font");

  128.         LookAndFeel.installBorder(b, pp + "border");

  129. 

  130.     }

  131. 

  132.     protected void installListeners(AbstractButton b) {

  133.         BasicButtonListener listener = createButtonListener(b);

  134.         if(listener != null) {

  135.             // put the listener in the button's client properties so that

  136.             // we can get at it later

  137.             b.putClientProperty(this, listener);

  138. 

  139.             b.addMouseListener(listener);

  140.             b.addMouseMotionListener(listener);

  141.             b.addFocusListener(listener);

  142.             b.addPropertyChangeListener(listener);

  143.             b.addChangeListener(listener);

  144.         }

  145.     }

  146.     

  147.     protected void installKeyboardActions(AbstractButton b){

  148.         BasicButtonListener listener = (BasicButtonListener) b.getClientProperty(this);

  149.         if(listener != null) {

  150.             listener.installKeyboardActions(b);

  151.         }

  152.     }

  153. 

  154.         

  155.     // ********************************

  156.     //         Uninstall PLAF

  157.     // ********************************

  158.     public void uninstallUI(JComponent c) {

  159.         uninstallKeyboardActions((AbstractButton) c);

  160.         uninstallListeners((AbstractButton) c);

  161.         uninstallDefaults((AbstractButton) c);

  162. 	BasicHTML.updateRenderer(c, "");

  163.     }

  164. 

  165.     protected void uninstallKeyboardActions(AbstractButton b) {

  166.         BasicButtonListener listener = (BasicButtonListener) b.getClientProperty(this);

  167.         if(listener != null) {

  168.             listener.uninstallKeyboardActions(b);

  169.         }

  170.     }

  171. 

  172.     protected void uninstallListeners(AbstractButton b) {

  173.         BasicButtonListener listener = (BasicButtonListener) b.getClientProperty(this);

  174.         b.putClientProperty(this, null);

  175.         if(listener != null) {

  176.             b.removeMouseListener(listener);

  177.             b.removeMouseListener(listener);

  178.             b.removeMouseMotionListener(listener);

  179.             b.removeFocusListener(listener);

  180.             b.removeChangeListener(listener);

  181.             b.removePropertyChangeListener(listener);

  182.         }

  183.     }

  184. 

  185.     protected void uninstallDefaults(AbstractButton b) {

  186.         LookAndFeel.uninstallBorder(b);

  187.         defaults_initialized = false;

  188.     }

  189.   

  190.     // ********************************

  191.     //        Create Listeners 

  192.     // ********************************

  193.     protected BasicButtonListener createButtonListener(AbstractButton b) {

  194.         return new BasicButtonListener(b);

  195.     }

  196. 

  197.     public int getDefaultTextIconGap(AbstractButton b) {

  198.         return defaultTextIconGap;

  199.     }

  200. 

  201.     /* These rectangles/insets are allocated once for all 

  202.      * ButtonUI.paint() calls.  Re-using rectangles rather than 

  203.      * allocating them in each paint call substantially reduced the time

  204.      * it took paint to run.  Obviously, this method can't be re-entered.

  205.      */

  206.     private static Rectangle viewRect = new Rectangle();

  207.     private static Rectangle textRect = new Rectangle();

  208.     private static Rectangle iconRect = new Rectangle();

  209. 

  210.     // ********************************

  211.     //          Paint Methods

  212.     // ********************************

  213. 

  214.     public void paint(Graphics g, JComponent c) 

  215.     {

  216.         AbstractButton b = (AbstractButton) c;

  217.         ButtonModel model = b.getModel();

  218. 

  219.         FontMetrics fm = g.getFontMetrics();

  220. 

  221.         Insets i = c.getInsets();

  222. 

  223.         viewRect.x = i.left;

  224.         viewRect.y = i.top;

  225.         viewRect.width = b.getWidth() - (i.right + viewRect.x);

  226.         viewRect.height = b.getHeight() - (i.bottom + viewRect.y);

  227. 

  228.         textRect.x = textRect.y = textRect.width = textRect.height = 0;

  229.         iconRect.x = iconRect.y = iconRect.width = iconRect.height = 0;

  230. 

  231.         Font f = c.getFont();

  232.         g.setFont(f);

  233. 

  234.         // layout the text and icon

  235.         String text = SwingUtilities.layoutCompoundLabel(

  236.             c, fm, b.getText(), b.getIcon(), 

  237.             b.getVerticalAlignment(), b.getHorizontalAlignment(),

  238.             b.getVerticalTextPosition(), b.getHorizontalTextPosition(),

  239.             viewRect, iconRect, textRect, 

  240.             b.getText() == null ? 0 : defaultTextIconGap

  241.         );

  242. 

  243.         clearTextShiftOffset();

  244. 

  245.         // perform UI specific press action, e.g. Windows L&F shifts text

  246.         if (model.isArmed() && model.isPressed()) {

  247.             paintButtonPressed(g,b); 

  248.         }

  249. 

  250.         // Paint the Icon

  251.         if(b.getIcon() != null) { 

  252.             paintIcon(g,c,iconRect);

  253.         }

  254. 

  255.         if (text != null && !text.equals("")){

  256. 	    View v = (View) c.getClientProperty(BasicHTML.propertyKey);

  257. 	    if (v != null) {

  258. 		v.paint(g, textRect);

  259. 	    } else {

  260. 		paintText(g, c,textRect, text);

  261. 	    }

  262.         }

  263. 

  264.         if (b.isFocusPainted() && b.hasFocus()) {

  265.             // paint UI specific focus

  266.             paintFocus(g,b,viewRect,textRect,iconRect);

  267.         }

  268.     }

  269.     

  270.     protected void paintIcon(Graphics g, JComponent c, Rectangle iconRect){

  271.             AbstractButton b = (AbstractButton) c;                           

  272.             ButtonModel model = b.getModel();

  273.             Icon icon = b.getIcon();

  274.             Icon tmpIcon = null;

  275. 

  276. 	    if(icon == null) {

  277. 	       return;

  278. 	    }

  279. 

  280.             if(!model.isEnabled()) {

  281. 		if(model.isSelected()) {

  282.                    tmpIcon = (Icon) b.getDisabledSelectedIcon();

  283. 		} else {

  284.                    tmpIcon = (Icon) b.getDisabledIcon();

  285. 		}

  286.             } else if(model.isPressed() && model.isArmed()) {

  287.                 tmpIcon = (Icon) b.getPressedIcon();

  288.                 if(tmpIcon != null) {

  289.                     // revert back to 0 offset

  290.                     clearTextShiftOffset();

  291.                 }

  292.             } else if(b.isRolloverEnabled() && model.isRollover()) {

  293. 		if(model.isSelected()) {

  294.                    tmpIcon = (Icon) b.getRolloverSelectedIcon();

  295. 		} else {

  296.                    tmpIcon = (Icon) b.getRolloverIcon();

  297. 		}

  298.             } else if(model.isSelected()) {

  299.                 tmpIcon = (Icon) b.getSelectedIcon();

  300. 	    }

  301.               

  302. 	    if(tmpIcon != null) {

  303. 	        icon = tmpIcon;

  304. 	    }

  305.                

  306.             if(model.isPressed() && model.isArmed()) {

  307.                 icon.paintIcon(c, g, iconRect.x + getTextShiftOffset(),

  308.                         iconRect.y + getTextShiftOffset());

  309.             } else {

  310.                 icon.paintIcon(c, g, iconRect.x, iconRect.y);

  311.             }

  312. 

  313.     }

  314. 

  315.     protected void paintText(Graphics g, JComponent c, Rectangle textRect, String text) {

  316.         AbstractButton b = (AbstractButton) c;                       

  317.         ButtonModel model = b.getModel();

  318.         FontMetrics fm = g.getFontMetrics();

  319. 

  320. 	/* Draw the Text */

  321. 	if(model.isEnabled()) {

  322. 	    /*** paint the text normally */

  323. 	    g.setColor(b.getForeground());

  324. 	    BasicGraphicsUtils.drawString(g,text, model.getMnemonic(),

  325. 					  textRect.x + getTextShiftOffset(),

  326. 					  textRect.y + fm.getAscent() + getTextShiftOffset());

  327. 	}

  328. 	else {

  329. 	    /*** paint the text disabled ***/

  330. 	    g.setColor(b.getBackground().brighter());

  331. 	    BasicGraphicsUtils.drawString(g,text,model.getMnemonic(),

  332. 					  textRect.x, textRect.y + fm.getAscent());

  333. 	    g.setColor(b.getBackground().darker());

  334. 	    BasicGraphicsUtils.drawString(g,text,model.getMnemonic(),

  335. 					  textRect.x - 1, textRect.y + fm.getAscent() - 1);

  336. 	}

  337.     }

  338.         

  339.     protected void paintFocus(Graphics g, AbstractButton b,

  340.                               Rectangle viewRect, Rectangle textRect, Rectangle iconRect){

  341.     }

  342.   

  343. 

  344. 

  345.     protected void paintButtonPressed(Graphics g, AbstractButton b){

  346.     }

  347. 

  348.     protected void clearTextShiftOffset(){

  349.         this.shiftOffset = 0;

  350.     }

  351. 

  352.     protected void setTextShiftOffset(){

  353.         this.shiftOffset = defaultTextShiftOffset;

  354.     }

  355. 

  356.     protected int getTextShiftOffset() {

  357.         return shiftOffset;

  358.     }

  359. 

  360.     // ********************************

  361.     //          Layout Methods

  362.     // ********************************

  363.     public Dimension getMinimumSize(JComponent c) {

  364.         Dimension d = getPreferredSize(c);

  365. 	View v = (View) c.getClientProperty(BasicHTML.propertyKey);

  366. 	if (v != null) {

  367. 	    d.width -= v.getPreferredSpan(View.X_AXIS) - v.getMinimumSpan(View.X_AXIS);

  368. 	}

  369. 	return d;

  370.     }

  371. 

  372.     public Dimension getPreferredSize(JComponent c) {

  373.         AbstractButton b = (AbstractButton)c;

  374.         return BasicGraphicsUtils.getPreferredButtonSize(b, defaultTextIconGap);

  375.     }

  376. 

  377.     public Dimension getMaximumSize(JComponent c) {

  378.         Dimension d = getPreferredSize(c);

  379. 	View v = (View) c.getClientProperty(BasicHTML.propertyKey);

  380. 	if (v != null) {

  381. 	    d.width += v.getMaximumSpan(View.X_AXIS) - v.getPreferredSpan(View.X_AXIS);

  382. 	}

  383. 	return d;

  384.     }

  385. 

  386. 

  387. }