FileDocCategorySizeDatePackage
DefaultDesktopManager.javaAPI DocJava SE 6 API25882Tue Jun 10 00:26:36 BST 2008javax.swing

DefaultDesktopManager

public class DefaultDesktopManager extends Object implements DesktopManager, Serializable
This is an implementation of the DesktopManager. It currently implements the basic behaviors for managing JInternalFrames in an arbitrary parent. JInternalFrames that are not children of a JDesktop will use this component to handle their desktop-like actions.

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.

see
JDesktopPane
see
JInternalFrame
version
1.59 11/30/06
author
David Kloba
author
Steve Wilson

Fields Summary
static final String
HAS_BEEN_ICONIFIED_PROPERTY
static final int
DEFAULT_DRAG_MODE
static final int
OUTLINE_DRAG_MODE
static final int
FASTER_DRAG_MODE
int
dragMode
private transient Rectangle
currentBounds
private transient Graphics
desktopGraphics
private transient Rectangle
desktopBounds
private transient Rectangle[]
floatingItems
private transient boolean
didDrag
Set to true when the user actually drags a frame vs clicks on it to start the drag operation. This is only used when dragging with FASTER_DRAG_MODE.
private transient Point
currentLoc
Constructors Summary
Methods Summary
public voidactivateFrame(javax.swing.JInternalFrame f)
This will activate f moving it to the front. It will set the current active frame's (if any) IS_SELECTED_PROPERTY to false. There can be only one active frame across all Layers.

param
f the JInternalFrame to be activated

        Container p = f.getParent();
        Component[] c;
	JDesktopPane d = f.getDesktopPane();
	JInternalFrame currentlyActiveFrame =
	  (d == null) ? null : d.getSelectedFrame();
	// fix for bug: 4162443
        if(p == null) {
            // If the frame is not in parent, its icon maybe, check it
            p = f.getDesktopIcon().getParent();
            if(p == null)
                return;
        }
	// we only need to keep track of the currentActive InternalFrame, if any
	if (currentlyActiveFrame == null){
	  if (d != null) { d.setSelectedFrame(f);}
	} else if (currentlyActiveFrame != f) {  
	  // if not the same frame as the current active
	  // we deactivate the current 
	  if (currentlyActiveFrame.isSelected()) { 
	    try {
	      currentlyActiveFrame.setSelected(false);
	    }
	    catch(PropertyVetoException e2) {}
	  }
	  if (d != null) { d.setSelectedFrame(f);}
	}
	f.moveToFront();
    
public voidbeginDraggingFrame(javax.swing.JComponent f)

        setupDragMode(f);

	if (dragMode == FASTER_DRAG_MODE) {
          Component desktop = f.getParent();
	  floatingItems = findFloatingItems(f);
	  currentBounds = f.getBounds();
          if (desktop instanceof JComponent) {
              desktopBounds = ((JComponent)desktop).getVisibleRect();
          }
          else {
              desktopBounds = desktop.getBounds();
              desktopBounds.x = desktopBounds.y = 0;
          }
          desktopGraphics = JComponent.safelyGetGraphics(desktop);
	  ((JInternalFrame)f).isDragging = true;
          didDrag = false;
	}
	
    
public voidbeginResizingFrame(javax.swing.JComponent f, int direction)

        setupDragMode(f);
    
public voidcloseFrame(javax.swing.JInternalFrame f)
Removes the frame, and, if necessary, the desktopIcon, from its parent.

param
f the JInternalFrame to be removed

        JDesktopPane d = f.getDesktopPane();
        if (d == null) {
            return;
        }
        boolean findNext = f.isSelected();
	Container c = f.getParent();
        JInternalFrame nextFrame = null;
        if (findNext) {
            nextFrame = d.getNextFrame(f);
            try { f.setSelected(false); } catch (PropertyVetoException e2) { }
        }
        if(c != null) {
            c.remove(f); // Removes the focus.
            c.repaint(f.getX(), f.getY(), f.getWidth(), f.getHeight());
        }
        removeIconFor(f);
        if(f.getNormalBounds() != null)
            f.setNormalBounds(null);
        if(wasIcon(f))
            setWasIcon(f, null);
        if (nextFrame != null) {
            try { nextFrame.setSelected(true); } 
            catch (PropertyVetoException e2) { }
        } else if (findNext && d.getComponentCount() == 0) {
            // It was selected and was the last component on the desktop.
            d.requestFocus();
        }
    
public voiddeactivateFrame(javax.swing.JInternalFrame f)

      JDesktopPane d = f.getDesktopPane();
      JInternalFrame currentlyActiveFrame =
	  (d == null) ? null : d.getSelectedFrame();
      if (currentlyActiveFrame == f)
	d.setSelectedFrame(null);
    
public voiddeiconifyFrame(javax.swing.JInternalFrame f)
Removes the desktopIcon from its parent and adds its frame to the parent.

param
f the JInternalFrame to be de-iconified

        JInternalFrame.JDesktopIcon desktopIcon = f.getDesktopIcon();
        Container c = desktopIcon.getParent();
        JDesktopPane d = f.getDesktopPane();
        if (c != null && d != null) {
            c.add(f);
            // If the frame is to be restored to a maximized state make
            // sure it still fills the whole desktop.
            if (f.isMaximum()) {
                Rectangle desktopBounds = c.getBounds();
                if (f.getWidth() != desktopBounds.width ||
                        f.getHeight() != desktopBounds.height) {
                    setBoundsForFrame(f, 0, 0,
                        desktopBounds.width, desktopBounds.height);
                }
            }
            removeIconFor(f);
            if (f.isSelected()) {
                f.moveToFront();
                f.restoreSubcomponentFocus();
            }
            else {
                try {
                    f.setSelected(true);  
                } catch (PropertyVetoException e2) {}

            }
        }
    
public voiddragFrame(javax.swing.JComponent f, int newX, int newY)
Moves the visible location of the frame being dragged to the location specified. The means by which this occurs can vary depending on the dragging algorithm being used. The actual logical location of the frame might not change until endDraggingFrame is called.


                                                        
            

        if (dragMode == OUTLINE_DRAG_MODE) {
	    JDesktopPane desktopPane = getDesktopPane(f);
	    if (desktopPane != null){
              Graphics g = JComponent.safelyGetGraphics(desktopPane);

	      g.setXORMode(Color.white);
	      if (currentLoc != null) {
	        g.drawRect(currentLoc.x, currentLoc.y,
                        f.getWidth()-1, f.getHeight()-1);
	      }
	      g.drawRect( newX, newY, f.getWidth()-1, f.getHeight()-1);
	      currentLoc = new Point (newX, newY);
	      g.dispose();
	    }
	} else if (dragMode == FASTER_DRAG_MODE) {
	  dragFrameFaster(f, newX, newY);
	} else {
	    setBoundsForFrame(f, newX, newY, f.getWidth(), f.getHeight());
	}
    
private voiddragFrameFaster(javax.swing.JComponent f, int newX, int newY)


      Rectangle previousBounds = new Rectangle(currentBounds.x,
                                               currentBounds.y,
                                               currentBounds.width,
                                               currentBounds.height);

   // move the frame
      currentBounds.x = newX;
      currentBounds.y = newY;
   
      if (didDrag) {
          // Only initiate cleanup if we have actually done a drag.
          emergencyCleanup(f);
      }
      else {
          didDrag = true;
          // We reset the danger field as until now we haven't actually
          // moved the internal frame so we don't need to initiate repaint.
          ((JInternalFrame)f).danger = false;
      }
      
      boolean floaterCollision = isFloaterCollision(previousBounds, currentBounds);
  
    // System.out.println(previousBounds);
      JComponent parent = (JComponent)f.getParent();
      Rectangle visBounds = previousBounds.intersection(desktopBounds);
    //  System.out.println(previousBounds);
 

     // System.out.println(visBounds);

      RepaintManager currentManager = RepaintManager.currentManager(f); 

      currentManager.beginPaint();
      try {
          if(!floaterCollision) {
              currentManager.copyArea(parent, desktopGraphics, visBounds.x,
                                      visBounds.y,
                                      visBounds.width,
                                      visBounds.height,
                                      newX - previousBounds.x,
                                      newY - previousBounds.y,
                                      true);
          }
 
          f.setBounds(currentBounds);

          if(floaterCollision) {
              // since we couldn't blit we just redraw as fast as possible
              // the isDragging mucking is to avoid activating emergency
              // cleanup
              ((JInternalFrame)f).isDragging = false;
              parent.paintImmediately(currentBounds);
              ((JInternalFrame)f).isDragging = true;
          }

          // fake out the repaint manager.  We'll take care of everything

          currentManager.markCompletelyClean(parent);
          currentManager.markCompletelyClean(f);

          // compute the minimal newly exposed area
          // if the rects intersect then we use computeDifference.  Otherwise
          // we'll repaint the entire previous bounds
          Rectangle[] dirtyRects = null;
          if ( previousBounds.intersects(currentBounds) ) {
              dirtyRects = SwingUtilities.computeDifference(previousBounds,
                                                            currentBounds);
          } else {
              dirtyRects = new Rectangle[1];
              dirtyRects[0] = previousBounds;
              //  System.out.println("no intersection");
          };

          // Fix the damage
          for (int i = 0; i < dirtyRects.length; i++) {
              parent.paintImmediately(dirtyRects[i]);
          }

          // new areas of blit were exposed
          if ( !(visBounds.equals(previousBounds)) ) {
              dirtyRects = SwingUtilities.computeDifference(previousBounds,
                                                            desktopBounds);
              for (int i = 0; i < dirtyRects.length; i++) {
                  dirtyRects[i].x += newX - previousBounds.x;
                  dirtyRects[i].y += newY - previousBounds.y;
                  ((JInternalFrame)f).isDragging = false;

                  parent.paintImmediately(dirtyRects[i]);
                  ((JInternalFrame)f).isDragging = true;
            
                  // System.out.println(dirtyRects[i]);
              }
              
          }
      } finally {
          currentManager.endPaint();
      }
   
private voidemergencyCleanup(javax.swing.JComponent f)
This method is here to clean up problems associated with a race condition which can occur when the full contents of a copyArea's source argument is not available onscreen. This uses brute force to clean up in case of possible damage


        if ( ((JInternalFrame)f).danger ) {
           
           SwingUtilities.invokeLater( new Runnable(){
                                       public void run(){
  
                                       ((JInternalFrame)f).isDragging = false;
                                       f.paintImmediately(0,0, 
                                                          f.getWidth(),
                                                          f.getHeight());
                                        
                                        //finalFrame.repaint();
                                        ((JInternalFrame)f).isDragging = true;
                                        // System.out.println("repair complete");
                                       }});     
                                       
             ((JInternalFrame)f).danger = false;        
        }
    
   
public voidendDraggingFrame(javax.swing.JComponent f)

        if ( dragMode == OUTLINE_DRAG_MODE && currentLoc != null) {
	    setBoundsForFrame(f, currentLoc.x, currentLoc.y, f.getWidth(), f.getHeight() );
	    currentLoc = null;
	} else if (dragMode == FASTER_DRAG_MODE) { 
	    currentBounds = null;
	    if (desktopGraphics != null) {
	        desktopGraphics.dispose();
	        desktopGraphics = null;
	    }
	    desktopBounds = null;
	    ((JInternalFrame)f).isDragging = false;
	}
    
public voidendResizingFrame(javax.swing.JComponent f)

        if ( dragMode == OUTLINE_DRAG_MODE && currentBounds != null) {
	    setBoundsForFrame(f, currentBounds.x, currentBounds.y, currentBounds.width, currentBounds.height );
	    currentBounds = null;
	}
    
private java.awt.Rectangle[]findFloatingItems(javax.swing.JComponent f)

      Container desktop = f.getParent();
      Component[] children = desktop.getComponents();
      int i = 0;
      for (i = 0; i < children.length; i++) {
         if (children[i] == f) {
            break;
         }
      }
      // System.out.println(i);
      Rectangle[] floaters = new Rectangle[i];
      for (i = 0; i < floaters.length; i++) {
         floaters[i] = children[i].getBounds();
      }

      return floaters;
   
protected java.awt.RectanglegetBoundsForIconOf(javax.swing.JInternalFrame f)
The iconifyFrame() code calls this to determine the proper bounds for the desktopIcon.

      //
      // Get the icon for this internal frame and its preferred size
      //

      JInternalFrame.JDesktopIcon icon = f.getDesktopIcon();
      Dimension prefSize = icon.getPreferredSize();
      //
      // Get the parent bounds and child components.
      //

      Container c = f.getParent();
      if (c == null) {
	  c = f.getDesktopIcon().getParent();
      }

      if (c == null) {
	/* the frame has not yet been added to the parent; how about (0,0) ?*/
	return new Rectangle(0, 0, prefSize.width, prefSize.height);
      }
	
      Rectangle parentBounds = c.getBounds();
      Component [] components = c.getComponents();


      //
      // Iterate through valid default icon locations and return the
      // first one that does not intersect any other icons.
      //

      Rectangle availableRectangle = null;
      JInternalFrame.JDesktopIcon currentIcon = null;

      int x = 0;
      int y = parentBounds.height - prefSize.height;
      int w = prefSize.width;
      int h = prefSize.height;

      boolean found = false;

      while (!found) {

	availableRectangle = new Rectangle(x,y,w,h);

	found = true;

	for ( int i=0; i<components.length; i++ ) {

	  //
	  // Get the icon for this component
	  //

	  if ( components[i] instanceof JInternalFrame ) {
	    currentIcon = ((JInternalFrame)components[i]).getDesktopIcon();
	  }
	  else if ( components[i] instanceof JInternalFrame.JDesktopIcon ){
	    currentIcon = (JInternalFrame.JDesktopIcon)components[i];
	  } else
	    /* found a child that's neither an internal frame nor
	       an icon. I don't believe this should happen, but at
	       present it does and causes a null pointer exception.
	       Even when that gets fixed, this code protects against
	       the npe. hania */
	    continue;
	  
	  //
	  // If this icon intersects the current location, get next location.
	  //

	  if ( !currentIcon.equals(icon) ) {
	    if ( availableRectangle.intersects(currentIcon.getBounds()) ) {
	      found = false;
	      break;
	    }
	  }
	}

	if (currentIcon == null)
	  /* didn't find any useful children above. This probably shouldn't
	   happen, but this check protects against an npe if it ever does
	   (and it's happening now) */
	  return availableRectangle;

	x += currentIcon.getBounds().width;

	if ( x + w > parentBounds.width ) {
	  x = 0;
	  y -= h;
	}
      }
	    
      return(availableRectangle);
    
javax.swing.JDesktopPanegetDesktopPane(javax.swing.JComponent frame)

        JDesktopPane pane = null;
	Component c = frame.getParent();

        // Find the JDesktopPane
        while ( pane == null ) {
	    if ( c instanceof JDesktopPane ) {
	        pane = (JDesktopPane)c;
	    }
	    else if ( c == null ) {
	        break;
	    }
	    else {
	        c = c.getParent();
	    }
	}

	return pane;
    
protected java.awt.RectanglegetPreviousBounds(javax.swing.JInternalFrame f)
Gets the normal bounds of the component prior to the component being maximized.

param
f the JInternalFrame of interest
return
the normal bounds of the component

        return f.getNormalBounds();
    
public voidiconifyFrame(javax.swing.JInternalFrame f)
Removes the frame from its parent and adds its desktopIcon to the parent.

param
f the JInternalFrame to be iconified

        JInternalFrame.JDesktopIcon desktopIcon;
        Container c = f.getParent();
	JDesktopPane d = f.getDesktopPane();
	boolean findNext = f.isSelected();
        desktopIcon = f.getDesktopIcon();
        if(!wasIcon(f)) {
            Rectangle r = getBoundsForIconOf(f);
            desktopIcon.setBounds(r.x, r.y, r.width, r.height);
            setWasIcon(f, Boolean.TRUE);
        }

	if (c == null || d == null) {
            return;
        }

	if (c instanceof JLayeredPane) {
	    JLayeredPane lp = (JLayeredPane)c;
	    int layer = lp.getLayer(f);
	    lp.putLayer(desktopIcon, layer);
	}

        // If we are maximized we already have the normal bounds recorded
        // don't try to re-record them, otherwise we incorrectly set the
        // normal bounds to maximized state.
        if (!f.isMaximum()) {
            f.setNormalBounds(f.getBounds());
        }
        d.setComponentOrderCheckingEnabled(false);
        c.remove(f);
        c.add(desktopIcon);
        d.setComponentOrderCheckingEnabled(true);
        c.repaint(f.getX(), f.getY(), f.getWidth(), f.getHeight());
        if (findNext) {
            if (d.selectFrame(true) == null) {
                // The icon is the last frame.
                f.restoreSubcomponentFocus();
            }
        }
    
private booleanisFloaterCollision(java.awt.Rectangle moveFrom, java.awt.Rectangle moveTo)

      if (floatingItems.length == 0) {
        // System.out.println("no floaters");
         return false;
      }

      for (int i = 0; i < floatingItems.length; i++) {
         boolean intersectsFrom = moveFrom.intersects(floatingItems[i]);         
         if (intersectsFrom) {
            return true;
         }
         boolean intersectsTo = moveTo.intersects(floatingItems[i]);
         if (intersectsTo) {
            return true;
         }
      }  

      return false;
   
public voidmaximizeFrame(javax.swing.JInternalFrame f)
Resizes the frame to fill its parents bounds.

param
f the frame to be resized

        if (f.isIcon()) {
            try {
                // In turn calls deiconifyFrame in the desktop manager.
                // That method will handle the maximization of the frame.
                f.setIcon(false);
            } catch (PropertyVetoException e2) {
            }
        } else {
            f.setNormalBounds(f.getBounds());
            Rectangle desktopBounds = f.getParent().getBounds();
            setBoundsForFrame(f, 0, 0,
                desktopBounds.width, desktopBounds.height);
        }

        // Set the maximized frame as selected.
        try {
            f.setSelected(true);
        } catch (PropertyVetoException e2) {
        }
    
public voidminimizeFrame(javax.swing.JInternalFrame f)
Restores the frame back to its size and position prior to a maximizeFrame call.

param
f the JInternalFrame to be restored

        // If the frame was an icon restore it back to an icon.
        if (f.isIcon()) {
            iconifyFrame(f);
            return;
        }

        if ((f.getNormalBounds()) != null) {
            Rectangle r = f.getNormalBounds();
	    f.setNormalBounds(null);
            try { f.setSelected(true); } catch (PropertyVetoException e2) { }
            setBoundsForFrame(f, r.x, r.y, r.width, r.height);
        }
    
public voidopenFrame(javax.swing.JInternalFrame f)
Normally this method will not be called. If it is, it try to determine the appropriate parent from the desktopIcon of the frame. Will remove the desktopIcon from its parent if it successfully adds the frame.


                                              
        
        if(f.getDesktopIcon().getParent() != null) {
            f.getDesktopIcon().getParent().add(f);
            removeIconFor(f);
        }
    
protected voidremoveIconFor(javax.swing.JInternalFrame f)
Convenience method to remove the desktopIcon of f is necessary.

        JInternalFrame.JDesktopIcon di = f.getDesktopIcon();
        Container c = di.getParent();
        if(c != null) {
            c.remove(di);
            c.repaint(di.getX(), di.getY(), di.getWidth(), di.getHeight());
        }
    
public voidresizeFrame(javax.swing.JComponent f, int newX, int newY, int newWidth, int newHeight)
Calls setBoundsForFrame with the new values.

param
f the component to be resized
param
newX the new x-coordinate
param
newY the new y-coordinate
param
newWidth the new width
param
newHeight the new height


        if ( dragMode == DEFAULT_DRAG_MODE || dragMode == FASTER_DRAG_MODE ) {
	    setBoundsForFrame(f, newX, newY, newWidth, newHeight);
	} else {
	    JDesktopPane desktopPane = getDesktopPane(f);
	    if (desktopPane != null){
              Graphics g = JComponent.safelyGetGraphics(desktopPane);

	      g.setXORMode(Color.white);
	      if (currentBounds != null) {
	        g.drawRect( currentBounds.x, currentBounds.y, currentBounds.width-1, currentBounds.height-1);
	      }
	      g.drawRect( newX, newY, newWidth-1, newHeight-1);
	      currentBounds = new Rectangle (newX, newY, newWidth, newHeight);
	      g.setPaintMode();
	      g.dispose();
	    }
	}

    
public voidsetBoundsForFrame(javax.swing.JComponent f, int newX, int newY, int newWidth, int newHeight)
This moves the JComponent and repaints the damaged areas.

        boolean didResize = (f.getWidth() != newWidth || f.getHeight() != newHeight);
        f.setBounds(newX, newY, newWidth, newHeight);
        if(didResize) {
            f.validate();
        } 
    
protected voidsetPreviousBounds(javax.swing.JInternalFrame f, java.awt.Rectangle r)
Stores the bounds of the component just before a maximize call.

param
f the component about to be resized
param
r the normal bounds to be saved away

	f.setNormalBounds(r);
    
protected voidsetWasIcon(javax.swing.JInternalFrame f, java.lang.Boolean value)
Sets that the component has been iconized and the bounds of the desktopIcon are valid.

	if (value != null) {
	    f.putClientProperty(HAS_BEEN_ICONIFIED_PROPERTY, value);
	}
    
private voidsetupDragMode(javax.swing.JComponent f)

        JDesktopPane p = getDesktopPane(f);
        Container parent = f.getParent();
        dragMode = DEFAULT_DRAG_MODE;
        if (p != null) {
            String mode = (String)p.getClientProperty("JDesktopPane.dragMode");
            if (mode != null && mode.equals("outline")) {
                dragMode = OUTLINE_DRAG_MODE;
            } else if (mode != null && mode.equals("faster")
                    && f instanceof JInternalFrame
                    && ((JInternalFrame)f).isOpaque() &&
                       (parent == null || parent.isOpaque())) {
                dragMode = FASTER_DRAG_MODE;
            } else {
                if (p.getDragMode() == JDesktopPane.OUTLINE_DRAG_MODE ) {
                    dragMode = OUTLINE_DRAG_MODE;
                } else if ( p.getDragMode() == JDesktopPane.LIVE_DRAG_MODE
                        && f instanceof JInternalFrame
                        && ((JInternalFrame)f).isOpaque()) {
                    dragMode = FASTER_DRAG_MODE;
                } else {
                    dragMode = DEFAULT_DRAG_MODE;
                }
            }
        }
    
protected booleanwasIcon(javax.swing.JInternalFrame f)
Returns true if the component has been iconized and the bounds of the desktopIcon are valid, otherwise returns false.

param
f the JInternalFrame of interest
return
true if the component has been iconized; otherwise returns false

        return (f.getClientProperty(HAS_BEEN_ICONIFIED_PROPERTY) == Boolean.TRUE);