Source for javax.swing.plaf.metal.MetalToolBarUI

   1: /* MetalToolBarUI.java
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   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.
  10: 
  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.
  15: 
  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.
  20: 
  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.
  25: 
  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. */
  37: 
  38: 
  39: package javax.swing.plaf.metal;
  40: 
  41: import java.awt.event.ContainerListener;
  42: import java.beans.PropertyChangeListener;
  43: 
  44: import javax.swing.JComponent;
  45: import javax.swing.JToolBar;
  46: import javax.swing.border.Border;
  47: import javax.swing.plaf.ComponentUI;
  48: import javax.swing.plaf.basic.BasicToolBarUI;
  49: 
  50: /**
  51:  * A UI delegate for the {@link JToolBar} component.
  52:  */
  53: public class MetalToolBarUI extends BasicToolBarUI
  54: {
  55:   
  56:   /**
  57:    * A listener (no longer used) that responds when components are added to or 
  58:    * removed from the {@link JToolBar}.  The required behaviour is now
  59:    * handled in the super class. 
  60:    * 
  61:    * @see MetalToolBarUI#createContainerListener()
  62:    */
  63:   protected class MetalContainerListener
  64:     extends BasicToolBarUI.ToolBarContListener
  65:   {
  66:     /**
  67:      * Creates a new instance.
  68:      */
  69:     protected MetalContainerListener()
  70:     {
  71:       // Nothing to do here.
  72:     }
  73:   }
  74: 
  75:   /**
  76:    * A listener (no longer used) that responds to property change events in a
  77:    * {@link JToolBar} component.  The required behaviour is now handled in the 
  78:    * super class. 
  79:    * 
  80:    * @see MetalToolBarUI#createRolloverListener()
  81:    */
  82:   protected class MetalRolloverListener
  83:     extends BasicToolBarUI.PropertyListener
  84:   {
  85:     /**
  86:      * Creates a new instance.
  87:      */
  88:     protected MetalRolloverListener()
  89:     {
  90:       // Nothing to do here.
  91:     }
  92:   }
  93:   
  94:   /** 
  95:    * The container listener (an implementation specific field, according to the
  96:    * spec, and not used in GNU Classpath).
  97:    */
  98:   protected ContainerListener contListener;
  99:   
 100:   /** 
 101:    * The rollover listener (an implementation specific field, according to the
 102:    * spec, and not used in GNU Classpath). 
 103:    */
 104:   protected PropertyChangeListener rolloverListener;
 105: 
 106:   /**
 107:    * Creates a new instance of this UI delegate.
 108:    */
 109:   public MetalToolBarUI()
 110:   {
 111:     super();
 112:   }
 113: 
 114:   /**
 115:    * Returns a new instance of <code>MetalToolBarUI</code>.
 116:    *
 117:    * @param component  the component for which we return an UI instance
 118:    *
 119:    * @return A new instance of <code>MetalToolBarUI</code>.
 120:    */
 121:   public static ComponentUI createUI(JComponent component)
 122:   {
 123:     return new MetalToolBarUI();
 124:   }
 125:   
 126:   /**
 127:    * Returns <code>null</code> as permitted by recent versions of the API
 128:    * specification.  Originally it seems this method returned a new instance of 
 129:    * {@link MetalRolloverListener}, but this is now redundant.
 130:    * 
 131:    * @return <code>null</code>.
 132:    */
 133:   protected PropertyChangeListener createRolloverListener()
 134:   {
 135:     return null;
 136:   }
 137:   
 138:   /**
 139:    * Returns <code>null</code> as permitted by recent versions of the API
 140:    * specification.  Originally it seems this method returned a new instance of 
 141:    * {@link MetalContainerListener}, but this is now redundant.
 142:    * 
 143:    * @return <code>null</code>.
 144:    */
 145:   protected ContainerListener createContainerListener()
 146:   {
 147:     return null;
 148:   }
 149:   
 150:   /**
 151:    * Returns a border with no rollover effect for buttons in the tool bar.
 152:    * 
 153:    * @return A border.
 154:    * 
 155:    * @see MetalBorders#getToolbarButtonBorder()
 156:    */
 157:   protected Border createNonRolloverBorder()
 158:   {
 159:     return MetalBorders.getToolbarButtonBorder();   
 160:   }
 161: 
 162: }