JavaTM 2 Platform
Std. Ed. v1.4.1

javax.swing.plaf.basic
Class BasicRootPaneUI

java.lang.Object
  |
  +--javax.swing.plaf.ComponentUI
        |
        +--javax.swing.plaf.RootPaneUI
              |
              +--javax.swing.plaf.basic.BasicRootPaneUI
All Implemented Interfaces:
EventListener, PropertyChangeListener
Direct Known Subclasses:
MetalRootPaneUI

public class BasicRootPaneUI
extends RootPaneUI
implements PropertyChangeListener

Basic implementation of RootPaneUI, there is one shared between all JRootPane instances.


Constructor Summary
BasicRootPaneUI()
           
 
Method Summary
static ComponentUI createUI(JComponent c)
          Returns an instance of the UI delegate for the specified component.
protected  void installComponents(JRootPane root)
           
protected  void installDefaults(JRootPane c)
           
protected  void installKeyboardActions(JRootPane root)
           
protected  void installListeners(JRootPane root)
           
 void installUI(JComponent c)
          Configures the specified component appropriate for the look and feel.
 void propertyChange(PropertyChangeEvent e)
          Invoked when a property changes on the root pane.
protected  void uninstallComponents(JRootPane root)
           
protected  void uninstallDefaults(JRootPane root)
           
protected  void uninstallKeyboardActions(JRootPane root)
           
protected  void uninstallListeners(JRootPane root)
           
 void uninstallUI(JComponent c)
          Reverses configuration which was done on the specified component during installUI.
 
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, paint, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicRootPaneUI

public BasicRootPaneUI()
Method Detail

createUI

public static ComponentUI createUI(JComponent c)
Description copied from class: ComponentUI
Returns an instance of the UI delegate for the specified component. Each subclass must provide its own static createUI method that returns an instance of that UI delegate subclass. If the UI delegate subclass is stateless, it may return an instance that is shared by multiple components. If the UI delegate is stateful, then it should return a new instance per component. The default implementation of this method throws an error, as it should never be invoked.


installUI

public void installUI(JComponent c)
Description copied from class: ComponentUI
Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:
  1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
  2. Install a LayoutManager on the component if necessary.
  3. Create/add any required sub-components to the component.
  4. Create/install event listeners on the component.
  5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
  6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
  7. Initialize any appropriate instance data.

Overrides:
installUI in class ComponentUI
Parameters:
c - the component where this UI delegate is being installed
See Also:
ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)
Description copied from class: ComponentUI
Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:
  1. Remove any UI-set borders from the component.
  2. Remove any UI-set layout managers on the component.
  3. Remove any UI-added sub-components from the component.
  4. Remove any UI-added event/property listeners from the component.
  5. Remove any UI-installed keyboard UI from the component.
  6. Nullify any allocated instance data objects to allow for GC.

Overrides:
uninstallUI in class ComponentUI
Parameters:
c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also:
ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

installDefaults

protected void installDefaults(JRootPane c)

installComponents

protected void installComponents(JRootPane root)

installListeners

protected void installListeners(JRootPane root)

installKeyboardActions

protected void installKeyboardActions(JRootPane root)

uninstallDefaults

protected void uninstallDefaults(JRootPane root)

uninstallComponents

protected void uninstallComponents(JRootPane root)

uninstallListeners

protected void uninstallListeners(JRootPane root)

uninstallKeyboardActions

protected void uninstallKeyboardActions(JRootPane root)

propertyChange

public void propertyChange(PropertyChangeEvent e)
Invoked when a property changes on the root pane. If the event indicates the defaultButton has changed, this will reinstall the keyboard actions.

Specified by:
propertyChange in interface PropertyChangeListener
Parameters:
e - A PropertyChangeEvent object describing the event source and the property that has changed.

JavaTM 2 Platform
Std. Ed. v1.4.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.