BasicDesktopPaneUI (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.DesktopPaneUI
    - - javax.swing.plaf.basic.BasicDesktopPaneUI
Direct Known Subclasses:
SynthDesktopPaneUI

public class BasicDesktopPaneUI
extends DesktopPaneUI
Basic L&F for a desktop.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BasicDesktopPaneUI.CloseAction	Handles closing an internal frame.
protected class	BasicDesktopPaneUI.MaximizeAction	Handles maximizing an internal frame.
protected class	BasicDesktopPaneUI.MinimizeAction	Handles minimizing an internal frame.
protected class	BasicDesktopPaneUI.NavigateAction	Handles navigating to the next internal frame.
protected class	BasicDesktopPaneUI.OpenAction	Handles restoring a minimized or maximized internal frame.

Field Summary

Fields

Modifier and Type	Field	Description
protected KeyStroke	closeKey	Deprecated.
protected JDesktopPane	desktop
protected DesktopManager	desktopManager
protected KeyStroke	maximizeKey	Deprecated.
protected KeyStroke	minimizeKey	Deprecated.
protected KeyStroke	navigateKey	Deprecated.
protected KeyStroke	navigateKey2	Deprecated.

Constructor Summary

Constructors

Constructor	Description
BasicDesktopPaneUI()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
protected PropertyChangeListener	createPropertyChangeListener()	Returns the PropertyChangeListener to install on the JDesktopPane.
static ComponentUI	createUI(JComponent c)
Dimension	getMaximumSize(JComponent c)	Returns the specified component's maximum size appropriate for the look and feel.
Dimension	getMinimumSize(JComponent c)	Returns the specified component's minimum size appropriate for the look and feel.
Dimension	getPreferredSize(JComponent c)	Returns the specified component's preferred size appropriate for the look and feel.
protected void	installDefaults()
protected void	installDesktopManager()
protected void	installKeyboardActions()
protected void	installListeners()	Installs the PropertyChangeListener returned fromcreatePropertyChangeListener on theJDesktopPane.
void	installUI(JComponent c)	Configures the specified component appropriately for the look and feel.
void	paint(Graphics g,JComponent c)	Paints the specified component appropriately for the look and feel.
protected void	registerKeyboardActions()
protected void	uninstallDefaults()
protected void	uninstallDesktopManager()
protected void	uninstallKeyboardActions()
protected void	uninstallListeners()	Uninstalls the PropertyChangeListener returned fromcreatePropertyChangeListener from theJDesktopPane.
void	uninstallUI(JComponent c)	Reverses configuration which was done on the specified component duringinstallUI.
protected void	unregisterKeyboardActions()

   * ### Methods inherited from class javax.swing.plaf.[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")  
   `[contains](../../../../javax/swing/plaf/ComponentUI.html#contains-javax.swing.JComponent-int-int-), [getAccessibleChild](../../../../javax/swing/plaf/ComponentUI.html#getAccessibleChild-javax.swing.JComponent-int-), [getAccessibleChildrenCount](../../../../javax/swing/plaf/ComponentUI.html#getAccessibleChildrenCount-javax.swing.JComponent-), [getBaseline](../../../../javax/swing/plaf/ComponentUI.html#getBaseline-javax.swing.JComponent-int-int-), [getBaselineResizeBehavior](../../../../javax/swing/plaf/ComponentUI.html#getBaselineResizeBehavior-javax.swing.JComponent-), [update](../../../../javax/swing/plaf/ComponentUI.html#update-java.awt.Graphics-javax.swing.JComponent-)`  
   * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

Field Detail

 * #### desktop  
 protected [JDesktopPane](../../../../javax/swing/JDesktopPane.html "class in javax.swing") desktop  
 * #### desktopManager  
 protected [DesktopManager](../../../../javax/swing/DesktopManager.html "interface in javax.swing") desktopManager  
 * #### minimizeKey  
 [@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")  
 protected [KeyStroke](../../../../javax/swing/KeyStroke.html "class in javax.swing") minimizeKey  
 Deprecated.  
 As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.  
 * #### maximizeKey  
 [@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")  
 protected [KeyStroke](../../../../javax/swing/KeyStroke.html "class in javax.swing") maximizeKey  
 Deprecated.  
 As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.  
 * #### closeKey  
 [@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")  
 protected [KeyStroke](../../../../javax/swing/KeyStroke.html "class in javax.swing") closeKey  
 Deprecated.  
 As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.  
 * #### navigateKey  
 [@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")  
 protected [KeyStroke](../../../../javax/swing/KeyStroke.html "class in javax.swing") navigateKey  
 Deprecated.  
 As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.  
 * #### navigateKey2  
 [@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")  
 protected [KeyStroke](../../../../javax/swing/KeyStroke.html "class in javax.swing") navigateKey2  
 Deprecated.  
 As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.

Constructor Detail

* #### BasicDesktopPaneUI  
public BasicDesktopPaneUI()

Method Detail

* #### createUI  
public static [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf") createUI([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
* #### installUI  
public void installUI([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Configures the specified component appropriately 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 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](../../../../javax/swing/plaf/ComponentUI.html#installUI-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- the component where this UI delegate is being installed  
See Also:  
[ComponentUI.uninstallUI(javax.swing.JComponent)](../../../../javax/swing/plaf/ComponentUI.html#uninstallUI-javax.swing.JComponent-), [JComponent.setUI(javax.swing.plaf.ComponentUI)](../../../../javax/swing/JComponent.html#setUI-javax.swing.plaf.ComponentUI-), [JComponent.updateUI()](../../../../javax/swing/JComponent.html#updateUI--)  
* #### uninstallUI  
public void uninstallUI([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
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](../../../../javax/swing/plaf/ComponentUI.html#uninstallUI-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
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)](../../../../javax/swing/plaf/ComponentUI.html#installUI-javax.swing.JComponent-), [JComponent.updateUI()](../../../../javax/swing/JComponent.html#updateUI--)  
* #### installDefaults  
protected void installDefaults()  
* #### uninstallDefaults  
protected void uninstallDefaults()  
* #### installListeners  
protected void installListeners()  
Installs the `PropertyChangeListener` returned from`createPropertyChangeListener` on the`JDesktopPane`.  
Since:  
1.5  
See Also:  
[createPropertyChangeListener()](../../../../javax/swing/plaf/basic/BasicDesktopPaneUI.html#createPropertyChangeListener--)  
* #### uninstallListeners  
protected void uninstallListeners()  
Uninstalls the `PropertyChangeListener` returned from`createPropertyChangeListener` from the`JDesktopPane`.  
Since:  
1.5  
See Also:  
[createPropertyChangeListener()](../../../../javax/swing/plaf/basic/BasicDesktopPaneUI.html#createPropertyChangeListener--)  
* #### installDesktopManager  
protected void installDesktopManager()  
* #### uninstallDesktopManager  
protected void uninstallDesktopManager()  
* #### installKeyboardActions  
protected void installKeyboardActions()  
* #### registerKeyboardActions  
protected void registerKeyboardActions()  
* #### unregisterKeyboardActions  
protected void unregisterKeyboardActions()  
* #### uninstallKeyboardActions  
protected void uninstallKeyboardActions()  
* #### paint  
public void paint([Graphics](../../../../java/awt/Graphics.html "class in java.awt") g,  
                  [JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Paints the specified component appropriately for the look and feel. This method is invoked from the `ComponentUI.update` method when the specified component is being painted. Subclasses should override this method and use the specified `Graphics` object to render the content of the component.  
Overrides:  
`[paint](../../../../javax/swing/plaf/ComponentUI.html#paint-java.awt.Graphics-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`g` \- the `Graphics` context in which to paint  
`c` \- the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components  
See Also:  
[ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)](../../../../javax/swing/plaf/ComponentUI.html#update-java.awt.Graphics-javax.swing.JComponent-)  
* #### getPreferredSize  
public [Dimension](../../../../java/awt/Dimension.html "class in java.awt") getPreferredSize([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Returns the specified component's preferred size appropriate for the look and feel. If `null` is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns `null`.  
Overrides:  
`[getPreferredSize](../../../../javax/swing/plaf/ComponentUI.html#getPreferredSize-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components  
See Also:  
[JComponent.getPreferredSize()](../../../../javax/swing/JComponent.html#getPreferredSize--), [LayoutManager.preferredLayoutSize(java.awt.Container)](../../../../java/awt/LayoutManager.html#preferredLayoutSize-java.awt.Container-)  
* #### getMinimumSize  
public [Dimension](../../../../java/awt/Dimension.html "class in java.awt") getMinimumSize([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Returns the specified component's minimum size appropriate for the look and feel. If `null` is returned, the minimum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes `getPreferredSize` and returns that value.  
Overrides:  
`[getMinimumSize](../../../../javax/swing/plaf/ComponentUI.html#getMinimumSize-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components  
Returns:  
a `Dimension` object or `null`  
See Also:  
[JComponent.getMinimumSize()](../../../../javax/swing/JComponent.html#getMinimumSize--), [LayoutManager.minimumLayoutSize(java.awt.Container)](../../../../java/awt/LayoutManager.html#minimumLayoutSize-java.awt.Container-), [ComponentUI.getPreferredSize(javax.swing.JComponent)](../../../../javax/swing/plaf/ComponentUI.html#getPreferredSize-javax.swing.JComponent-)  
* #### getMaximumSize  
public [Dimension](../../../../java/awt/Dimension.html "class in java.awt") getMaximumSize([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Returns the specified component's maximum size appropriate for the look and feel. If `null` is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes `getPreferredSize` and returns that value.  
Overrides:  
`[getMaximumSize](../../../../javax/swing/plaf/ComponentUI.html#getMaximumSize-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components  
Returns:  
a `Dimension` object or `null`  
See Also:  
[JComponent.getMaximumSize()](../../../../javax/swing/JComponent.html#getMaximumSize--), [LayoutManager2.maximumLayoutSize(java.awt.Container)](../../../../java/awt/LayoutManager2.html#maximumLayoutSize-java.awt.Container-)  
* #### createPropertyChangeListener  
protected [PropertyChangeListener](../../../../java/beans/PropertyChangeListener.html "interface in java.beans") createPropertyChangeListener()  
Returns the `PropertyChangeListener` to install on the `JDesktopPane`.  
Returns:  
The PropertyChangeListener that will be added to track changes in the desktop pane.  
Since:  
1.5

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

BasicDesktopPaneUI (Java Platform SE 8 ) (original) (raw)

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail