This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing
interface DesktopManager

All Known Implementing Classes:
DefaultDesktopManager

public interface DesktopManager

DesktopManager objects are owned by a JDesktopPane object. They are responsible for implementing L&F specific behaviors for the JDesktopPane. JInternalFrame implementations should delegate specific behaviors to the DesktopManager. For instance, if a JInternalFrame was asked to iconify, it should try:

    getDesktopPane().getDesktopManager().iconifyFrame(frame);
 
This delegation allows each L&F to provide custom behaviors for desktop-specific actions. (For example, how and where the internal frame's icon would appear.)

This class provides a policy for the various JInternalFrame methods, it is not meant to be called directly rather the various JInternalFrame methods will call into the DesktopManager.


Method Summary
 void

          Generally, indicate that this frame has focus.
 void

          This method is normally called when the user has indicated that they will begin dragging a component around.
 void
beginResizingFrame(JComponent f, int direction)

          This methods is normally called when the user has indicated that they will begin resizing the frame.
 void

          Generally, this call should remove the frame from it's parent.
 void

          Generally, indicate that this frame has lost focus.
 void

          Generally, remove any iconic representation that is present and restore the frame to it's original size and location.
 void
dragFrame(JComponent f, int newX, int newY)

          The user has moved the frame.
 void

          This method signals the end of the dragging session.
 void

          This method signals the end of the resize session.
 void

          Generally, remove this frame from it's parent and add an iconic representation.
 void

          Generally, the frame should be resized to match it's parents bounds.
 void

          Generally, this indicates that the frame should be restored to it's size and position prior to a maximizeFrame() call.
 void

          If possible, display this frame in an appropriate location.
 void
resizeFrame(JComponent f, int newX, int newY, int newWidth, int newHeight)

          The user has resized the component.
 void
setBoundsForFrame(JComponent f, int newX, int newY, int newWidth, int newHeight)

          This is a primitive reshape method.
 

Method Detail

activateFrame

public void activateFrame(JInternalFrame f)
Generally, indicate that this frame has focus. This is usually called after the JInternalFrame's IS_SELECTED_PROPERTY has been set to true.

Parameters:
f

beginDraggingFrame

public void beginDraggingFrame(JComponent f)
This method is normally called when the user has indicated that they will begin dragging a component around. This method should be called prior to any dragFrame() calls to allow the DesktopManager to prepare any necessary state. Normally f will be a JInternalFrame.

Parameters:
f

beginResizingFrame

public void beginResizingFrame(JComponent f,
                               int direction)
This methods is normally called when the user has indicated that they will begin resizing the frame. This method should be called prior to any resizeFrame() calls to allow the DesktopManager to prepare any necessary state. Normally f will be a JInternalFrame.

Parameters:
f
direction

closeFrame

public void closeFrame(JInternalFrame f)
Generally, this call should remove the frame from it's parent.

Parameters:
f

deactivateFrame

public void deactivateFrame(JInternalFrame f)
Generally, indicate that this frame has lost focus. This is usually called after the JInternalFrame's IS_SELECTED_PROPERTY has been set to false.

Parameters:
f

deiconifyFrame

public void deiconifyFrame(JInternalFrame f)
Generally, remove any iconic representation that is present and restore the frame to it's original size and location.

Parameters:
f

dragFrame

public void dragFrame(JComponent f,
                      int newX,
                      int newY)
The user has moved the frame. Calls to this method will be preceded by calls to beginDraggingFrame(). Normally f will be a JInternalFrame.

Parameters:
f
newX
newY

endDraggingFrame

public void endDraggingFrame(JComponent f)
This method signals the end of the dragging session. Any state maintained by the DesktopManager can be removed here. Normally f will be a JInternalFrame.

Parameters:
f

endResizingFrame

public void endResizingFrame(JComponent f)
This method signals the end of the resize session. Any state maintained by the DesktopManager can be removed here. Normally f will be a JInternalFrame.

Parameters:
f

iconifyFrame

public void iconifyFrame(JInternalFrame f)
Generally, remove this frame from it's parent and add an iconic representation.

Parameters:
f

maximizeFrame

public void maximizeFrame(JInternalFrame f)
Generally, the frame should be resized to match it's parents bounds.

Parameters:
f

minimizeFrame

public void minimizeFrame(JInternalFrame f)
Generally, this indicates that the frame should be restored to it's size and position prior to a maximizeFrame() call.

Parameters:
f

openFrame

public void openFrame(JInternalFrame f)
If possible, display this frame in an appropriate location. Normally, this is not called, as the creator of the JInternalFrame will add the frame to the appropriate parent.

Parameters:
f

resizeFrame

public void resizeFrame(JComponent f,
                        int newX,
                        int newY,
                        int newWidth,
                        int newHeight)
The user has resized the component. Calls to this method will be preceded by calls to beginResizingFrame(). Normally f will be a JInternalFrame.

Parameters:
f
newX
newY
newWidth
newHeight

setBoundsForFrame

public void setBoundsForFrame(JComponent f,
                              int newX,
                              int newY,
                              int newWidth,
                              int newHeight)
This is a primitive reshape method.

Parameters:
f
newX
newY
newWidth
newHeight


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.