javax.swing

Class JDesktopPane

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable

public class JDesktopPane
extends JLayeredPane
implements Accessible

JDesktopPane is a container (usually for JInternalFrames) that simulates a desktop. Typically, the user will create JInternalFrames and place them in a JDesktopPane. The user can then interact with JInternalFrames like they usually would with JFrames. The actions (minimize, maximize, close, etc) are done by using a DesktopManager that is associated with the JDesktopPane.
See Also:
Serialized Form

Nested Class Summary

protected class
JDesktopPane.AccessibleJDesktopPane
Provides the accessibility features for the JDesktopPane component.

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
This specifies that when dragged, a JInternalFrame should be completely visible.
static int
OUTLINE_DRAG_MODE
This specifies that when dragged, a JInternalFrame should only be visible as an outline.

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

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

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 object.

Method Summary

AccessibleContext
getAccessibleContext()
Returns the object that provides accessibility features for this JDesktopPane component.
JInternalFrame[]
getAllFrames()
This method returns all JInternalFrames that are in the JDesktopPane.
JInternalFrame[]
getAllFramesInLayer(int layer)
This method returns all the JInternalFrames in the given layer.
DesktopManager
getDesktopManager()
This method returns the DesktopManager used with the JDesktopPane.
int
getDragMode()
This method returns the drag mode used with the JDesktopPane.
JInternalFrame
getSelectedFrame()
This method returns the currently selected frame in the JDesktopPane.
DesktopPaneUI
getUI()
This method returns the UI used with the JDesktopPane.
String
getUIClassID()
This method returns a String identifier that allows the UIManager to know which class will act as JDesktopPane's UI.
boolean
isOpaque()
This method always returns true to indicate that it is not transparent.
protected String
paramString()
Returns an implementation-dependent string describing the attributes of this JDesktopPane.
void
setDesktopManager(DesktopManager manager)
This method sets the DesktopManager to use with the JDesktopPane.
void
setDragMode(int mode)
This method sets the drag mode to use with the JDesktopPane.
void
setSelectedFrame(JInternalFrame frame)
This method sets the selected frame in the JDesktopPane.
void
setUI(DesktopPaneUI ui)
This method sets the UI used with the JDesktopPane.
void
updateUI()
This method restores the UI used with the JDesktopPane to the default.

Methods inherited from class javax.swing.JLayeredPane

Integer> getComponentToLayer, addImpl, getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, 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, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LIVE_DRAG_MODE

public static final int LIVE_DRAG_MODE
This specifies that when dragged, a JInternalFrame should be completely visible.
Field Value:
0

OUTLINE_DRAG_MODE

public static final int OUTLINE_DRAG_MODE
This specifies that when dragged, a JInternalFrame should only be visible as an outline.
Field Value:
1

Constructor Details

JDesktopPane

public JDesktopPane()
Creates a new JDesktopPane object.

Method Details

getAccessibleContext

public AccessibleContext getAccessibleContext()
Returns the object that provides accessibility features for this JDesktopPane component.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface JLayeredPane
Returns:
The accessible context (an instance of JDesktopPane.AccessibleJDesktopPane).

getAllFrames

public JInternalFrame[] getAllFrames()
This method returns all JInternalFrames that are in the JDesktopPane.
Returns:
All JInternalFrames that are in the JDesktopPane.

getAllFramesInLayer

public JInternalFrame[] getAllFramesInLayer(int layer)
This method returns all the JInternalFrames in the given layer.
Parameters:
layer - The layer to grab frames in.
Returns:
All JInternalFrames in the given layer.

getDesktopManager

public DesktopManager getDesktopManager()
This method returns the DesktopManager used with the JDesktopPane.
Returns:
The DesktopManager to use with the JDesktopPane.

getDragMode

public int getDragMode()
This method returns the drag mode used with the JDesktopPane.
Returns:
The drag mode used with the JDesktopPane.

getSelectedFrame

public JInternalFrame getSelectedFrame()
This method returns the currently selected frame in the JDesktopPane.
Returns:
The currently selected frame in the JDesktopPane.

getUI

public DesktopPaneUI getUI()
This method returns the UI used with the JDesktopPane.
Returns:
The UI used with the JDesktopPane.

getUIClassID

public String getUIClassID()
This method returns a String identifier that allows the UIManager to know which class will act as JDesktopPane's UI.
Overrides:
getUIClassID in interface JComponent
Returns:
A String identifier for the UI class to use.

isOpaque

public boolean isOpaque()
This method always returns true to indicate that it is not transparent.
Overrides:
isOpaque in interface JComponent
Returns:
true.

paramString

protected String paramString()
Returns an implementation-dependent string describing the attributes of this JDesktopPane.
Overrides:
paramString in interface JComponent
Returns:
A string describing the attributes of this JDesktopPane (never null).

setDesktopManager

public void setDesktopManager(DesktopManager manager)
This method sets the DesktopManager to use with the JDesktopPane.
Parameters:
manager - The DesktopManager to use with the JDesktopPane.

setDragMode

public void setDragMode(int mode)
This method sets the drag mode to use with the JDesktopPane.
Parameters:
mode - The drag mode to use.
Throws:
IllegalArgumentException - If the drag mode given is not LIVE_DRAG_MODE or OUTLINE_DRAG_MODE.

setSelectedFrame

public void setSelectedFrame(JInternalFrame frame)
This method sets the selected frame in the JDesktopPane.
Parameters:
frame - The selected frame in the JDesktopPane.

setUI

public void setUI(DesktopPaneUI ui)
This method sets the UI used with the JDesktopPane.
Parameters:
ui - The UI to use with the JDesktopPane.

updateUI

public void updateUI()
This method restores the UI used with the JDesktopPane to the default.
Overrides:
updateUI in interface JComponent

JDesktopPane.java -- Copyright (C) 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.