trunk/libjava/classpath/javax/swing/plaf/metal/MetalInternalFrameUI.java

   1 /* MetalInternalFrameUI.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.beans.PropertyChangeEvent;
  42 import java.beans.PropertyChangeListener;
  43
  44 import javax.swing.ActionMap;
  45 import javax.swing.JComponent;
  46 import javax.swing.JInternalFrame;
  47 import javax.swing.SwingUtilities;
  48 import javax.swing.plaf.ComponentUI;
  49 import javax.swing.plaf.basic.BasicInternalFrameUI;
  50
  51 /**
  52  * A UI delegate for the {@link JInternalFrame} component.
  53  */
  54 public class MetalInternalFrameUI
  55   extends BasicInternalFrameUI
  56 {
  57   /**
  58    * The key (<code>JInternalFrame.isPalette</code>) for the client property
  59    * that controls whether the internal frame is displayed using the palette
  60    * style.
  61    */
  62   protected static String IS_PALETTE = "JInternalFrame.isPalette";
  63
  64   /**
  65    * Constructs a new instance of <code>MetalInternalFrameUI</code>.
  66    *
  67    * @param frame  the frame.
  68    */
  69   public MetalInternalFrameUI(JInternalFrame frame)
  70   {
  71     super(frame);
  72   }
  73
  74   /**
  75    * Returns an instance of <code>MetalInternalFrameUI</code>.
  76    *
  77    * @param component the internal frame.
  78    *
  79    * @return an instance of <code>MetalInternalFrameUI</code>.
  80    */
  81   public static ComponentUI createUI(JComponent component)
  82   {
  83     return new MetalInternalFrameUI((JInternalFrame) component);
  84   }
  85
  86   /**
  87    * Sets the fields and properties for the component.
  88    *
  89    * @param c  the component.
  90    */
  91   public void installUI(JComponent c)
  92   {
  93     super.installUI(c);
  94     JInternalFrame f = (JInternalFrame) c;
  95     boolean isPalette = false;
  96     Boolean p = (Boolean) f.getClientProperty(IS_PALETTE);
  97     if (p != null)
  98       isPalette = p.booleanValue();
  99     setPalette(isPalette);
 100   }
 101
 102   /**
 103    * Creates and returns the component that will be used for the north pane
 104    * of the {@link JInternalFrame}.
 105    *
 106    * @param w  the internal frame.
 107    *
 108    * @return A new instance of {@link MetalInternalFrameTitlePane}.
 109    */
 110   protected JComponent createNorthPane(JInternalFrame w)
 111   {
 112     titlePane = new MetalInternalFrameTitlePane(w);
 113     return titlePane;
 114   }
 115
 116   /**
 117    * Sets the state of the {@link JInternalFrame} to reflect whether or not
 118    * it is using the palette style.  When a frame is displayed as a palette,
 119    * it uses a different border and the title pane is drawn differently.
 120    *
 121    * @param isPalette  use the palette style?
 122    */
 123   public void setPalette(boolean isPalette)
 124   {
 125     MetalInternalFrameTitlePane title = (MetalInternalFrameTitlePane) northPane;
 126     title.setPalette(isPalette);
 127     if (isPalette)
 128       frame.setBorder(new MetalBorders.PaletteBorder());
 129     else
 130       frame.setBorder(new MetalBorders.InternalFrameBorder());
 131   }
 132
 133   /** A listener that is used to handle IS_PALETTE property changes. */
 134   private PropertyChangeListener paletteListener;
 135
 136   /**
 137    * Adds the required listeners.
 138    */
 139   protected void installListeners()
 140   {
 141     super.installListeners();
 142     paletteListener = new PropertyChangeListener()
 143     {
 144       public void propertyChange(PropertyChangeEvent e)
 145       {
 146         if (e.getPropertyName().equals(IS_PALETTE))
 147           {
 148             if (Boolean.TRUE.equals(e.getNewValue()))
 149               setPalette(true);
 150             else
 151               setPalette(false);
 152           }
 153       }
 154     };
 155     frame.addPropertyChangeListener(paletteListener);
 156   }
 157
 158   /**
 159    * Removes the listeners used.
 160    */
 161   protected void uninstallListeners()
 162   {
 163     super.uninstallListeners();
 164     frame.removePropertyChangeListener(IS_PALETTE, paletteListener);
 165     paletteListener = null;
 166   }
 167
 168   /**
 169    * Installs keyboard actions. This is overridden to remove the
 170    * <code>showSystemMenu</code> Action that is installed by the
 171    * <code>BasicInternalFrameUI</code>, since Metal JInternalFrames don't have
 172    * a system menu.
 173    */
 174   protected void installKeyboardActions()
 175   {
 176     super.installKeyboardActions();
 177     ActionMap am = SwingUtilities.getUIActionMap(frame);
 178     if (am != null)
 179       {
 180         am.remove("showSystemMenu");
 181       }
 182   }
 183 }