Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.JDesktopPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--com.sun.java.swing.JComponent
                    |
                    +--com.sun.java.swing.JLayeredPane
                          |
                          +--com.sun.java.swing.JDesktopPane

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

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 the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JDesktopPane key assignments.

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:

JInternalFrame, JInternalFrame.JDesktopIcon, DesktopManager, Serialized Form

Inner Class Summary

protected

JDesktopPane.AccessibleJDesktopPane The class used to obtain the accessible role for this object.

Inner classes inherited from class com.sun.java.swing.JLayeredPane

JLayeredPane.AccessibleJLayeredPane

Inner classes inherited from class com.sun.java.swing.JComponent

JComponent.AccessibleJComponent

Fields inherited from class com.sun.java.swing.JLayeredPane

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

Fields inherited from class com.sun.java.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

Constructor Summary

JDesktopPane()
Creates a new JDesktopPane.

Method Summary

AccessibleContext	getAccessibleContext() Get the AccessibleContext associated with this JComponent
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.
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.
void	setDesktopManager(DesktopManager d) Sets the DesktopManger that will handle desktop-specific UI actions.
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 com.sun.java.swing.JLayeredPane

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

Methods inherited from class com.sun.java.swing.JComponent

addAncestorListener , addNotify , addPropertyChangeListener , addVetoableChangeListener , computeVisibleRect , contains , createToolTip , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , firePropertyChange , fireVetoableChange , getActionForKeyStroke , getAlignmentX , getAlignmentY , getAutoscrolls , getBorder , getBounds , getClientProperty , getComponentGraphics , getConditionForKeyStroke , getDebugGraphicsOptions , getGraphics , getHeight , getInsets , getInsets , getLocation , getMaximumSize , getMinimumSize , getNextFocusableComponent , getPreferredSize , getRegisteredKeyStrokes , getRootPane , getSize , getToolTipLocation , getToolTipText , getToolTipText , getTopLevelAncestor , getVisibleRect , getWidth , getX , getY , grabFocus , hasFocus , isDoubleBuffered , isFocusCycleRoot , isFocusTraversable , isLightweightComponent , isManagingFocus , isPaintingTile , isRequestFocusEnabled , isValidateRoot , paintBorder , paintChildren , paintComponent , paintImmediately , paintImmediately , processComponentKeyEvent , processFocusEvent , processKeyEvent , processMouseMotionEvent , putClientProperty , registerKeyboardAction , registerKeyboardAction , removeAncestorListener , removeNotify , removePropertyChangeListener , removeVetoableChangeListener , repaint , repaint , requestDefaultFocus , requestFocus , resetKeyboardActions , reshape , revalidate , scrollRectToVisible , setAlignmentX , setAlignmentY , setAutoscrolls , setBorder , setDebugGraphicsOptions , setDoubleBuffered , setEnabled , setMaximumSize , setMinimumSize , setNextFocusableComponent , setOpaque , setPreferredSize , setRequestFocusEnabled , setToolTipText , setUI , setVisible , unregisterKeyboardAction , update

Methods inherited from class java.awt.Container

add , add , add , add , add , addContainerListener , countComponents , deliverEvent , doLayout , findComponentAt , findComponentAt , getComponent , getComponentAt , getComponentAt , getComponentCount , getComponents , getLayout , insets , invalidate , isAncestorOf , layout , list , list , locate , minimumSize , paintComponents , paramString , preferredSize , print , printComponents , processContainerEvent , processEvent , remove , removeAll , removeContainerListener , setLayout , validate , validateTree

Methods inherited from class java.awt.Component

action , add , addComponentListener , addFocusListener , addInputMethodListener , addKeyListener , addMouseListener , addMouseMotionListener , addPropertyChangeListener , bounds , checkImage , checkImage , coalesceEvents , contains , createImage , createImage , disable , disableEvents , dispatchEvent , enable , enable , enableEvents , enableInputMethods , getBackground , getBounds , getColorModel , getComponentOrientation , getCursor , getDropTarget , getFont , getFontMetrics , getForeground , getInputContext , getInputMethodRequests , getLocale , getLocation , getLocationOnScreen , getName , getParent , getPeer , getSize , getToolkit , getTreeLock , gotFocus , handleEvent , hide , imageUpdate , inside , isDisplayable , isEnabled , isLightweight , isShowing , isValid , isVisible , keyDown , keyUp , list , list , list , location , lostFocus , mouseDown , mouseDrag , mouseEnter , mouseExit , mouseMove , mouseUp , move , nextFocus , paintAll , postEvent , prepareImage , prepareImage , printAll , processComponentEvent , processInputMethodEvent , processMouseEvent , remove , removeComponentListener , removeFocusListener , removeInputMethodListener , removeKeyListener , removeMouseListener , removeMouseMotionListener , removePropertyChangeListener , repaint , repaint , repaint , resize , resize , setBackground , setBounds , setBounds , setComponentOrientation , setCursor , setDropTarget , setFont , setForeground , setLocale , setLocation , setLocation , setName , setSize , setSize , show , show , size , toString , transferFocus

Methods inherited from class java.lang.Object

clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait

Constructor Detail

JDesktopPane

public JDesktopPane()

Creates a new JDesktopPane.

Method Detail

getUI

public DesktopPaneUI getUI()

Returns the L&F object that renders this component.

Returns:

the DesktopPaneUI object that renders this component

setUI

public void setUI(DesktopPaneUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the DesktopPaneUI L&F object

See Also:

UIDefaults.getUI(com.sun.java.swing.JComponent)

getDesktopManager

public DesktopManager getDesktopManager()

Returns the DesktopManger that handles desktop-specific UI actions.

Parameters:

d - the DesktopManager currently in use

setDesktopManager

public void setDesktopManager(DesktopManager d)

Sets the DesktopManger that will handle desktop-specific UI actions.

Parameters:

d - the DesktopManager to use

updateUI

public void updateUI()

Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

Overrides:

updateUI in class JComponent

See Also:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"DesktopPaneUI"

Overrides:

getUIClassID in class JComponent

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(com.sun.java.swing.JComponent)

getAllFrames

public JInternalFrame[] getAllFrames()

Returns all JInternalFrames currently displayed in the desktop. Returns iconified frames as well as expanded frames.

Returns:

an array of JInternalFrame objects

getAllFramesInLayer

public JInternalFrame[] getAllFramesInLayer(int layer)

Returns all JInternalFrames currently displayed in the specified layer of the desktop. Returns iconified frames as well expanded frames.

Parameters:

layer - an int specifying the desktop layer

Returns:

an array of JInternalFrame objects

See Also:

JLayeredPane

isOpaque

public boolean isOpaque()

Returns true to indicate that this component paints every pixel in its range. (In other words, it does not have a transparent background or foreground.)

Returns:

true

Overrides:

isOpaque in class JComponent

See Also:

JComponent.isOpaque()

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Specified by:

getAccessibleContext in interface Accessible

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JLayeredPane