Java Platform 1.2
Beta 4

Class com.sun.java.swing.UIManager

java.lang.Object
  |
  +--com.sun.java.swing.UIManager

public class UIManager
extends Object
implements Serializable
This class keeps track of the current look and feel and its defaults.

We manage three levels of defaults: user defaults, look and feel defaults, system defaults. A call to UIManager.get() checks all three levels in order and returns the first non-null value for a key, if any. A call to UIManager.put() just affects the user defaults. Note that a call to setLookAndFeel() doesn't affect the user defaults, it just replaces the middle defaults "level".

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
Serialized Form

Inner Class Summary
static  UIManager.LookAndFeelInfo
          Provide a little information about an installed LookAndFeel for the sake of configuring a menu or for initial application set up.
 
Method Summary
static void addAuxiliaryLookAndFeel(LookAndFeel laf)
          Add a LookAndFeel to the list of auxiliary look and feels.
static void addPropertyChangeListener(PropertyChangeListener listener)
          Add a PropertyChangeListener to the listener list.
static Object get(Object key)
           
static LookAndFeel[] getAuxiliaryLookAndFeels()
          Return the list of auxiliary look and feels (can be null).
static Border getBorder(Object key)
           
static Color getColor(Object key)
           
static String getCrossPlatformLookAndFeelClassName()
          Returns the name of the LookAndFeel class that implements the default cross platform look and feel, i.e. the "Java Look and Feel", or JLF.
static UIDefaults getDefaults()
           
static Dimension getDimension(Object key)
           
static Font getFont(Object key)
           
static Icon getIcon(Object key)
           
static Insets getInsets(Object key)
           
static UIManager.LookAndFeelInfo[] getInstalledLookAndFeels()
          Return an array of objects that provide some information about the LookAndFeel implementations that have been installed with this java development kit.
static int getInt(Object key)
           
static LookAndFeel getLookAndFeel()
          Returns The current default look and feel, or null.
static UIDefaults getLookAndFeelDefaults()
           
static String getString(Object key)
           
static String getSystemLookAndFeelClassName()
          Returns the name of the LookAndFeel class that implements the native systems look and feel if there is one, otherwise the name of the default cross platform LookAndFeel class.
static ComponentUI getUI(JComponent target)
           
static void installLookAndFeel(String name, String className)
           
static void installLookAndFeel(UIManager.LookAndFeelInfo info)
          Adds the specified look and feel to the current array and then calls setInstalledLookAndFeels.
static Object put(Object key, Object value)
           
static boolean removeAuxiliaryLookAndFeel(LookAndFeel laf)
          Remove a LookAndFeel from the list of auxiliary look and feels.
static void removePropertyChangeListener(PropertyChangeListener listener)
          Remove a PropertyChangeListener from the listener list.
static void setInstalledLookAndFeels(UIManager.LookAndFeelInfo[] infos)
          Replaces the current array of installed LookAndFeelInfos.
static void setLookAndFeel(LookAndFeel newLookAndFeel)
          Set the current default look and feel.
static void setLookAndFeel(String className)
           
 
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
 

Method Detail

getInstalledLookAndFeels

public static UIManager.LookAndFeelInfo[] getInstalledLookAndFeels()
Return an array of objects that provide some information about the LookAndFeel implementations that have been installed with this java development kit. The LookAndFeel info objects can be used by an application to construct a menu of look and feel options for the user or to set the look and feel at start up time. Note that we do not return the LookAndFeel classes themselves here to avoid the cost of unnecessarily loading them.

Given a LookAndFeelInfo object one can set the current look and feel like this:

 UIManager.setLookAndFeel(info.getClassName());
 
See Also:
setLookAndFeel(com.sun.java.swing.LookAndFeel)

setInstalledLookAndFeels

public static void setInstalledLookAndFeels(UIManager.LookAndFeelInfo[] infos)
                                     throws SecurityException
Replaces the current array of installed LookAndFeelInfos.
See Also:
getInstalledLookAndFeels()

installLookAndFeel

public static void installLookAndFeel(UIManager.LookAndFeelInfo info)
Adds the specified look and feel to the current array and then calls setInstalledLookAndFeels.
See Also:
setInstalledLookAndFeels(com.sun.java.swing.UIManager.LookAndFeelInfo[])

installLookAndFeel

public static void installLookAndFeel(String name,
                                      String className)

getLookAndFeel

public static LookAndFeel getLookAndFeel()
Returns The current default look and feel, or null.
Returns:
The current default look and feel, or null.
See Also:
setLookAndFeel(com.sun.java.swing.LookAndFeel)

setLookAndFeel

public static void setLookAndFeel(LookAndFeel newLookAndFeel)
                           throws UnsupportedLookAndFeelException
Set the current default look and feel.

This is a JavaBeans bound property.

Throws:
UnsupportedLookAndFeelException - If lnf.isSupportedLookAndFeel() is false.
See Also:
getLookAndFeel()

setLookAndFeel

public static void setLookAndFeel(String className)
                           throws ClassNotFoundException,
                                  InstantiationException,
                                  IllegalAccessException,
                                  UnsupportedLookAndFeelException
Throws:
ClassNotFoundException - If the LookAndFeel class could not be found.
InstantiationException - If a new instance of the class couldn't be creatd.
IllegalAccessException - If the class or initializer isn't accessible.
UnsupportedLookAndFeelException - If lnf.isSupportedLookAndFeel() is false.

getSystemLookAndFeelClassName

public static String getSystemLookAndFeelClassName()
Returns the name of the LookAndFeel class that implements the native systems look and feel if there is one, otherwise the name of the default cross platform LookAndFeel class.
See Also:
#setLookAndFeel(), getCrossPlatformLookAndFeelClassName()

getCrossPlatformLookAndFeelClassName

public static String getCrossPlatformLookAndFeelClassName()
Returns the name of the LookAndFeel class that implements the default cross platform look and feel, i.e. the "Java Look and Feel", or JLF.
Returns:
a string with the JLF implementation-class
See Also:
#setLookAndFeel(), getSystemLookAndFeelClassName()

getDefaults

public static UIDefaults getDefaults()

getFont

public static Font getFont(Object key)

getColor

public static Color getColor(Object key)

getIcon

public static Icon getIcon(Object key)

getBorder

public static Border getBorder(Object key)

getString

public static String getString(Object key)

getInt

public static int getInt(Object key)

getInsets

public static Insets getInsets(Object key)

getDimension

public static Dimension getDimension(Object key)

get

public static Object get(Object key)

put

public static Object put(Object key,
                         Object value)

getUI

public static ComponentUI getUI(JComponent target)

getLookAndFeelDefaults

public static UIDefaults getLookAndFeelDefaults()

addAuxiliaryLookAndFeel

public static void addAuxiliaryLookAndFeel(LookAndFeel laf)
Add a LookAndFeel to the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what other LookAndFeel classes for a component instance are to be used in addition to the default LookAndFeel class when creating a multiplexing UI. The change will only take effect when a new UI class is created or when the default look and feel is changed on a component instance.

Note these are not the same as the installed look and feels.

See Also:
removeAuxiliaryLookAndFeel(com.sun.java.swing.LookAndFeel), setLookAndFeel(com.sun.java.swing.LookAndFeel), getAuxiliaryLookAndFeels(), getInstalledLookAndFeels()

removeAuxiliaryLookAndFeel

public static boolean removeAuxiliaryLookAndFeel(LookAndFeel laf)
Remove a LookAndFeel from the list of auxiliary look and feels. The auxiliary look and feels tell the multiplexing look and feel what other LookAndFeel classes for a component instance are to be used in addition to the default LookAndFeel class when creating a multiplexing UI. The change will only take effect when a new UI class is created or when the default look and feel is changed on a component instance.

Note these are not the same as the installed look and feels.

Returns:
true if the LookAndFeel was removed from the list
See Also:
removeAuxiliaryLookAndFeel(com.sun.java.swing.LookAndFeel), getAuxiliaryLookAndFeels(), setLookAndFeel(com.sun.java.swing.LookAndFeel), getInstalledLookAndFeels()

getAuxiliaryLookAndFeels

public static LookAndFeel[] getAuxiliaryLookAndFeels()
Return the list of auxiliary look and feels (can be null). The auxiliary look and feels tell the multiplexing look and feel what other LookAndFeel classes for a component instance are to be used in addition to the default LookAndFeel class when creating a multiplexing UI.

Note these are not the same as the installed look and feels.

See Also:
addAuxiliaryLookAndFeel(com.sun.java.swing.LookAndFeel), removeAuxiliaryLookAndFeel(com.sun.java.swing.LookAndFeel), setLookAndFeel(com.sun.java.swing.LookAndFeel), getInstalledLookAndFeels()

addPropertyChangeListener

public static void addPropertyChangeListener(PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.
Parameters:
listener - The PropertyChangeListener to be added
See Also:
PropertyChangeSupport

removePropertyChangeListener

public static void removePropertyChangeListener(PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
Parameters:
listener - The PropertyChangeListener to be removed
See Also:
PropertyChangeSupport

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.