javax.swing
Class JDesktopPane

java.lang.Object   
  java.awt.Component   
      java.awt.Container   
          javax.swing.JComponent   
              javax.swing.JLayeredPane   
                  javax.swing.JDesktopPane

All Implemented Interfaces:

ImageObserver , MenuContainer , Serializable , Accessible

public class JDesktopPane
extends JLayeredPane   
implements Accessible   

A container used to create a multiple-document interface or a virtual desktop. You create JInternalFrame objects and add them to the JDesktopPane. JDesktopPane extends JLayeredPane to manage the potentially overlapping internal frames. It also maintains a reference to an instance of DesktopManager that is set by the UI class for the current look and feel (L&F). Note that JDesktopPane does not support borders.

This class is normally used as the parent of JInternalFrames to provide a pluggable DesktopManager object to the JInternalFrames. The installUI of the L&F specific implementation is responsible for setting the desktopManager variable appropriately. When the parent of a JInternalFrame is a JDesktopPane, it should delegate most of its behavior to the desktopManager (closing, resizing, etc).

For further documentation and examples see How to Use Internal Frames, a section in The Java Tutorial.

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 applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder .

See Also:

JInternalFrame , JInternalFrame.JDesktopIcon , DesktopManager , Serialized Form

Nested Class Summary

protected class

JDesktopPane.AccessibleJDesktopPane This class implements accessibility support for the JDesktopPane class.

Nested classes/interfaces inherited from class javax.swing.JLayeredPane

JLayeredPane.AccessibleJLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent , Component.BltBufferStrategy , Component.FlipBufferStrategy

Field Summary

static int	LIVE_DRAG_MODE Indicates that the entire contents of the item being dragged should appear inside the desktop pane.
static int	OUTLINE_DRAG_MODE Indicates that an outline only of the item being dragged should appear inside the desktop pane.

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER , DRAG_LAYER , FRAME_CONTENT_LAYER , LAYER_PROPERTY , MODAL_LAYER , PALETTE_LAYER , POPUP_LAYER

Fields inherited from class javax.swing.JComponent

accessibleContext , listenerList , TOOL_TIP_TEXT_KEY , ui , UNDEFINED_CONDITION , WHEN_ANCESTOR_OF_FOCUSED_COMPONENT , WHEN_FOCUSED , WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT , CENTER_ALIGNMENT , LEFT_ALIGNMENT , RIGHT_ALIGNMENT , TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT , ALLBITS , ERROR , FRAMEBITS , HEIGHT , PROPERTIES , SOMEBITS , WIDTH

Constructor Summary

JDesktopPane ()
Creates a new JDesktopPane.

Method Summary

AccessibleContext	getAccessibleContext () Gets the AccessibleContext associated with this JDesktopPane.
JInternalFrame []	getAllFrames () Returns all JInternalFrames currently displayed in the desktop.
JInternalFrame []	getAllFramesInLayer (int layer) Returns all JInternalFrames currently displayed in the specified layer of the desktop.
DesktopManager	getDesktopManager () Returns the DesktopManger that handles desktop-specific UI actions.
int	getDragMode () Gets the current "dragging style" used by the desktop pane.
JInternalFrame	getSelectedFrame () Returns the currently active JInternalFrame in this JDesktopPane, or null if no JInternalFrame is currently active.
DesktopPaneUI	getUI () Returns the L&F object that renders this component.
String	getUIClassID () Returns the name of the L&F class that renders this component.
boolean	isOpaque () Returns true to indicate that this component paints every pixel in its range.
protected String	paramString () Returns a string representation of this JDesktopPane.
void	setDesktopManager (DesktopManager d) Sets the DesktopManger that will handle desktop-specific UI actions.
void	setDragMode (int dragMode) Sets the "dragging style" used by the desktop pane.
void	setSelectedFrame (JInternalFrame f) Sets the currently active JInternalFrame in this JDesktopPane.
void	setUI (DesktopPaneUI ui) Sets the L&F object that renders this component.
void	updateUI () Notification from the UIManager that the L&F has changed.

Methods inherited from class javax.swing.JLayeredPane

addImpl , getComponentCountInLayer , getComponentsInLayer , getComponentToLayer , getIndexOf , getLayer , getLayer , getLayeredPaneAbove , getObjectForLayer , getPosition , highestLayer , insertIndexForLayer , isOptimizedDrawingEnabled , lowestLayer , moveToBack , moveToFront , paint , putLayer , remove , removeAll , setLayer , setLayer , setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener , addNotify , addVetoableChangeListener , computeVisibleRect , contains , createToolTip , disable , enable , firePropertyChange , firePropertyChange , firePropertyChange , fireVetoableChange , getActionForKeyStroke , getActionMap , getAlignmentX , getAlignmentY , getAncestorListeners , getAutoscrolls , getBorder , getBounds , getClientProperty , getComponentGraphics , getComponentPopupMenu , getConditionForKeyStroke , getDebugGraphicsOptions , getDefaultLocale , getFontMetrics , getGraphics , getHeight , getInheritsPopupMenu , getInputMap , getInputMap , getInputVerifier , getInsets , getInsets , getListeners , getLocation , getMaximumSize , getMinimumSize , getNextFocusableComponent , getPopupLocation , getPreferredSize , getRegisteredKeyStrokes , getRootPane , getSize , getToolTipLocation , getToolTipText , getToolTipText , getTopLevelAncestor , getTransferHandler , getVerifyInputWhenFocusTarget