libjava/javax/swing/LookAndFeel.java

   1 /* LookAndFeel.java --
   2    Copyright (C) 2002, 2004  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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;
  40
  41 import java.awt.Component;
  42 import java.awt.Toolkit;
  43
  44 import javax.swing.text.JTextComponent;
  45
  46 public abstract class LookAndFeel
  47 {
  48   /**
  49    * This method is called once by UIManager.setLookAndFeel to create
  50    * the look and feel specific defaults table.
  51    *
  52    * @return the UI defaults
  53    */
  54   public UIDefaults getDefaults()
  55   {
  56     return null;
  57   }
  58
  59   public abstract String getDescription();
  60
  61   public abstract String getID();
  62
  63   public abstract String getName();
  64
  65   /**
  66    * Returns true when the Look and Feel supports window decorations,
  67    * false others. This method returns always false and needs to be overwritten
  68    * when the derived Look and Feel supports this.
  69    *
  70    * @return false
  71    *
  72    * @since 1.4
  73    */
  74   public boolean getSupportsWindowDecorations()
  75   {
  76     return false;
  77   }
  78
  79   /**
  80    * UIManager.setLookAndFeel calls this method before the first call
  81    * (and typically the only call) to getDefaults().
  82    */
  83   public void initialize()
  84   {
  85   }
  86
  87   /**
  88    * Convenience method for installing a component's default Border object
  89    * on the specified component if either the border is currently null
  90    * or already an instance of UIResource.
  91    */
  92   public static void installBorder(JComponent c, String defaultBorderName)
  93   {
  94   }
  95
  96   /**
  97    * Convenience method for initializing a component's foreground and
  98    * background color properties with values from the current defaults table.
  99    */
 100   public static void installColors(JComponent c, String defaultBgName, String defaultFgName)
 101   {
 102   }
 103
 104   /**
 105    * Convenience method for initializing a components foreground background
 106    * and font properties with values from the current defaults table.
 107    */
 108   public static void installColorsAndFont(JComponent component,
 109                                           String defaultBgName,
 110                                           String defaultFgName,
 111                                           String defaultFontName)
 112   {
 113   }
 114
 115   public abstract boolean isNativeLookAndFeel();
 116
 117   public abstract boolean isSupportedLookAndFeel();
 118
 119   /**
 120    * Loads the bindings in keys into retMap.
 121    */
 122   public static void loadKeyBindings(InputMap retMap, Object[] keys)
 123   {
 124   }
 125
 126   /**
 127    * Creates a ComponentInputMap from keys.
 128    */
 129   public static ComponentInputMap makeComponentInputMap(JComponent c,
 130                                                         Object[] keys)
 131   {
 132     return null;
 133   }
 134
 135   /**
 136    * Utility method that creates a UIDefaults.LazyValue that creates an
 137    * ImageIcon UIResource for the specified gifFile filename.
 138    */
 139   public static Object makeIcon(Class baseClass, String gifFile)
 140   {
 141     return null;
 142   }
 143
 144   /**
 145    * Creates a InputMap from keys.
 146    */
 147   public static InputMap makeInputMap(Object[] keys)
 148   {
 149     return null;
 150   }
 151
 152   /**
 153    * Convenience method for building lists of KeyBindings.
 154    */
 155   public static JTextComponent.KeyBinding[] makeKeyBindings(Object[] keyBindingList)
 156   {
 157     return null;
 158   }
 159
 160   /**
 161    * Invoked when the user attempts an invalid operation. The default implement
 162    * just beeps. Subclasses that wish to change this need to override this
 163    * method.
 164    *
 165    * @param component the component the error occured in
 166    */
 167   public void provideErrorFeedback(Component component)
 168   {
 169     Toolkit.getDefaultToolkit().beep();
 170   }
 171
 172   /**
 173    * Returns a string that displays and identifies this object's properties.
 174    *
 175    * @return the string "LookAndFeel"
 176    */
 177   public String toString()
 178   {
 179     return "LookAndFeel";
 180   }
 181
 182   /**
 183    * UIManager.setLookAndFeel calls this method just before we're replaced by
 184    * a new default look and feel.
 185    */
 186   public void uninitialize()
 187   {
 188   }
 189
 190   /**
 191    * Convenience method for un-installing a component's default border on the
 192    * specified component if the border is currently an instance of UIResource.
 193    */
 194   public static void uninstallBorder(JComponent c)
 195   {
 196   }
 197 }