APIdia Launch Partner
Top Description Methods
javax.swing

public Interface DesktopManager

Known Direct Implementers
javax.swing.DefaultDesktopManager

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.

Author
David Kloba
Since
1.2
See Also
JDesktopPane, JInternalFrame, JInternalFrame.JDesktopIcon

Method Summary

Modifier and TypeMethod and Description
public void
activateFrame(JInternalFrame
the JInternalFrame to be activated
f
)

Generally, indicate that this frame has focus.

public void
beginDraggingFrame(JComponent
the JComponent being dragged
f
)

This method is normally called when the user has indicated that they will begin dragging a component around.

public void
beginResizingFrame(JComponent
the JComponent being resized
f
,
int
the direction
direction
)

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

public void
closeFrame(JInternalFrame
the JInternalFrame to be removed
f
)

Generally, this call should remove the frame from its parent.

public void
deactivateFrame(JInternalFrame
the JInternalFrame to be deactivated
f
)

Generally, indicate that this frame has lost focus.

public void
deiconifyFrame(JInternalFrame
the JInternalFrame to be de-iconified
f
)

Generally, remove any iconic representation that is present and restore the frame to it's original size and location.

public void
dragFrame(JComponent
the JComponent being dragged
f
,
int
the new x-coordinate
newX
,
int
the new y-coordinate
newY
)

The user has moved the frame.

public void
endDraggingFrame(JComponent
the JComponent being dragged
f
)

This method signals the end of the dragging session.

public void
endResizingFrame(JComponent
the JComponent being resized
f
)

This method signals the end of the resize session.

public void
iconifyFrame(JInternalFrame
the JInternalFrame to be iconified
f
)

Generally, remove this frame from its parent and add an iconic representation.

public void
maximizeFrame(JInternalFrame
the JInternalFrame to be resized
f
)

Generally, the frame should be resized to match its parents bounds.

public void
minimizeFrame(JInternalFrame
the JInternalFrame to be restored
f
)

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

public void
openFrame(JInternalFrame
the JInternalFrame to be displayed
f
)

If possible, display this frame in an appropriate location.

public void
resizeFrame(JComponent
the JComponent being resized
f
,
int
the new x-coordinate
newX
,
int
the new y-coordinate
newY
,
int
the new width
newWidth
,
int
the new height
newHeight
)

The user has resized the component.

public void
setBoundsForFrame(JComponent
the JComponent being moved or resized
f
,
int
the new x-coordinate
newX
,
int
the new y-coordinate
newY
,
int
the new width
newWidth
,
int
the new height
newHeight
)

This is a primitive reshape method.

Method Detail

activateFrameback to summary
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:JInternalFrame

the JInternalFrame to be activated

beginDraggingFrameback to summary
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:JComponent

the JComponent being dragged

beginResizingFrameback to summary
public void beginResizingFrame(JComponent f, int direction)

This method 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:JComponent

the JComponent being resized

direction:int

the direction

closeFrameback to summary
public void closeFrame(JInternalFrame f)

Generally, this call should remove the frame from its parent.

Parameters
f:JInternalFrame

the JInternalFrame to be removed

deactivateFrameback to summary
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:JInternalFrame

the JInternalFrame to be deactivated

deiconifyFrameback to summary
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:JInternalFrame

the JInternalFrame to be de-iconified

dragFrameback to summary
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:JComponent

the JComponent being dragged

newX:int

the new x-coordinate

newY:int

the new y-coordinate

endDraggingFrameback to summary
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:JComponent

the JComponent being dragged

endResizingFrameback to summary
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:JComponent

the JComponent being resized

iconifyFrameback to summary
public void iconifyFrame(JInternalFrame f)

Generally, remove this frame from its parent and add an iconic representation.

Parameters
f:JInternalFrame

the JInternalFrame to be iconified

maximizeFrameback to summary
public void maximizeFrame(JInternalFrame f)

Generally, the frame should be resized to match its parents bounds.

Parameters
f:JInternalFrame

the JInternalFrame to be resized

minimizeFrameback to summary
public void minimizeFrame(JInternalFrame f)

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

Parameters
f:JInternalFrame

the JInternalFrame to be restored

openFrameback to summary
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:JInternalFrame

the JInternalFrame to be displayed

resizeFrameback to summary
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:JComponent

the JComponent being resized

newX:int

the new x-coordinate

newY:int

the new y-coordinate

newWidth:int

the new width

newHeight:int

the new height

setBoundsForFrameback to summary
public void setBoundsForFrame(JComponent f, int newX, int newY, int newWidth, int newHeight)

This is a primitive reshape method.

Parameters
f:JComponent

the JComponent being moved or resized

newX:int

the new x-coordinate

newY:int

the new y-coordinate

newWidth:int

the new width

newHeight:int

the new height