Source for javax.swing.JDesktopPane

   1: /* JDesktopPane.java --
   2:    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing;
  40: 
  41: import java.awt.Component;
  42: import java.beans.PropertyVetoException;
  43: 
  44: import javax.accessibility.Accessible;
  45: import javax.accessibility.AccessibleContext;
  46: import javax.accessibility.AccessibleRole;
  47: import javax.swing.plaf.DesktopPaneUI;
  48: 
  49: /**
  50:  * JDesktopPane is a container (usually for JInternalFrames) that simulates a
  51:  * desktop. Typically, the user will create JInternalFrames and place them in
  52:  * a JDesktopPane. The user can then interact with JInternalFrames like they
  53:  * usually would with JFrames. The actions (minimize, maximize, close, etc)
  54:  * are done by using a DesktopManager that is associated with the
  55:  * JDesktopPane.
  56:  */
  57: public class JDesktopPane extends JLayeredPane implements Accessible
  58: {
  59:   /** DOCUMENT ME! */
  60:   private static final long serialVersionUID = 766333777224038726L;
  61: 
  62:   /**
  63:    * This specifies that when dragged, a JInternalFrame should be completely
  64:    * visible.
  65:    *
  66:    * @specnote final since 1.5.0.
  67:    */
  68:   public static final int LIVE_DRAG_MODE = 0;
  69: 
  70:   /**
  71:    * This specifies that when dragged, a JInternalFrame should only be visible
  72:    * as an outline.
  73:    *
  74:    * @specnote final since 1.5.0.
  75:    */
  76:   public static final int OUTLINE_DRAG_MODE = 1;
  77: 
  78:   /** The selected frame in the JDesktopPane. */
  79:   private transient JInternalFrame selectedFrame;
  80: 
  81:   /** The JDesktopManager to use for acting on JInternalFrames. */
  82:   transient DesktopManager desktopManager;
  83: 
  84:   /** The drag mode used by the JDesktopPane. */
  85:   private transient int dragMode = LIVE_DRAG_MODE;
  86: 
  87:   /**
  88:    * AccessibleJDesktopPane
  89:    */
  90:   protected class AccessibleJDesktopPane extends AccessibleJComponent
  91:   {
  92:     /** DOCUMENT ME! */
  93:     private static final long serialVersionUID = 6079388927946077570L;
  94: 
  95:     /**
  96:      * Constructor AccessibleJDesktopPane
  97:      */
  98:     protected AccessibleJDesktopPane()
  99:     {
 100:       // Nothing to do here.
 101:     }
 102: 
 103:     /**
 104:      * getAccessibleRole
 105:      *
 106:      * @return AccessibleRole
 107:      */
 108:     public AccessibleRole getAccessibleRole()
 109:     {
 110:       return AccessibleRole.DESKTOP_PANE;
 111:     }
 112:   }
 113: 
 114:   /**
 115:    * Creates a new JDesktopPane object.
 116:    */
 117:   public JDesktopPane()
 118:   {
 119:     setLayout(null);
 120:     updateUI();
 121:   }
 122: 
 123:   /**
 124:    * This method returns the UI used with the JDesktopPane.
 125:    *
 126:    * @return The UI used with the JDesktopPane.
 127:    */
 128:   public DesktopPaneUI getUI()
 129:   {
 130:     return (DesktopPaneUI) ui;
 131:   }
 132: 
 133:   /**
 134:    * This method sets the UI used with the JDesktopPane.
 135:    *
 136:    * @param ui The UI to use with the JDesktopPane.
 137:    */
 138:   public void setUI(DesktopPaneUI ui)
 139:   {
 140:     super.setUI(ui);
 141:   }
 142: 
 143:   /**
 144:    * This method sets the drag mode to use with the JDesktopPane.
 145:    *
 146:    * @param mode The drag mode to use.
 147:    *
 148:    * @throws IllegalArgumentException If the drag mode given is not
 149:    *         LIVE_DRAG_MODE or OUTLINE_DRAG_MODE.
 150:    */
 151:   public void setDragMode(int mode)
 152:   {
 153:     if ((mode != LIVE_DRAG_MODE) && (mode != OUTLINE_DRAG_MODE))
 154:       throw new IllegalArgumentException("Drag mode not valid.");
 155: 
 156:     // FIXME: Unsupported mode.
 157:     if (mode == OUTLINE_DRAG_MODE)
 158:       // throw new IllegalArgumentException("Outline drag modes are
 159:       // unsupported.");
 160:       mode = LIVE_DRAG_MODE;
 161: 
 162:     dragMode = mode;
 163:   }
 164: 
 165:   /**
 166:    * This method returns the drag mode used with the JDesktopPane.
 167:    *
 168:    * @return The drag mode used with the JDesktopPane.
 169:    */
 170:   public int getDragMode()
 171:   {
 172:     return dragMode;
 173:   }
 174: 
 175:   /**
 176:    * This method returns the DesktopManager used with the JDesktopPane.
 177:    *
 178:    * @return The DesktopManager to use with the JDesktopPane.
 179:    */
 180:   public DesktopManager getDesktopManager()
 181:   {
 182:     return desktopManager;
 183:   }
 184: 
 185:   /**
 186:    * This method sets the DesktopManager to use with the JDesktopPane.
 187:    *
 188:    * @param manager The DesktopManager to use with the JDesktopPane.
 189:    */
 190:   public void setDesktopManager(DesktopManager manager)
 191:   {
 192:     desktopManager = manager;
 193:   }
 194: 
 195:   /**
 196:    * This method restores the UI used with the JDesktopPane to the default.
 197:    */
 198:   public void updateUI()
 199:   {
 200:     setUI((DesktopPaneUI) UIManager.getUI(this));
 201:     invalidate();
 202:   }
 203: 
 204:   /**
 205:    * This method returns a String identifier that allows the UIManager to know
 206:    * which class will act as JDesktopPane's UI.
 207:    *
 208:    * @return A String identifier for the UI class to use.
 209:    */
 210:   public String getUIClassID()
 211:   {
 212:     return "DesktopPaneUI";
 213:   }
 214: 
 215:   /**
 216:    * This method returns all JInternalFrames that are in the JDesktopPane.
 217:    *
 218:    * @return All JInternalFrames that are in the JDesktopPane.
 219:    */
 220:   public JInternalFrame[] getAllFrames()
 221:   {
 222:     return getFramesFromComponents(getComponents());
 223:   }
 224: 
 225:   /**
 226:    * This method returns the currently selected frame in the JDesktopPane.
 227:    *
 228:    * @return The currently selected frame in the JDesktopPane.
 229:    */
 230:   public JInternalFrame getSelectedFrame()
 231:   {
 232:     return selectedFrame;
 233:   }
 234: 
 235:   /**
 236:    * This method sets the selected frame in the JDesktopPane.
 237:    *
 238:    * @param frame The selected frame in the JDesktopPane.
 239:    */
 240:   public void setSelectedFrame(JInternalFrame frame)
 241:   {
 242:     if (selectedFrame != null)
 243:       {
 244:         try
 245:           {
 246:             selectedFrame.setSelected(false);
 247:           }
 248:         catch (PropertyVetoException e)
 249:           {
 250:             // We do nothing when the attempt is vetoed.
 251:           }
 252:       }
 253:     selectedFrame = null;
 254: 
 255:     try
 256:       {
 257:         if (frame != null)
 258:           frame.setSelected(true);
 259: 
 260:         selectedFrame = frame;
 261:       }
 262:     catch (PropertyVetoException e)
 263:       {
 264:         // We do nothing when the attempt is vetoed.
 265:       }
 266:   }
 267: 
 268:   /**
 269:    * This method returns all the JInternalFrames in the given layer.
 270:    *
 271:    * @param layer The layer to grab frames in.
 272:    *
 273:    * @return All JInternalFrames in the given layer.
 274:    */
 275:   public JInternalFrame[] getAllFramesInLayer(int layer)
 276:   {
 277:     return getFramesFromComponents(getComponentsInLayer(layer));
 278:   }
 279: 
 280:   /**
 281:    * This method always returns true to indicate that it is not transparent.
 282:    *
 283:    * @return true.
 284:    */
 285:   public boolean isOpaque()
 286:   {
 287:     return true;
 288:   }
 289: 
 290:   /**
 291:    * This method returns a String that describes the JDesktopPane.
 292:    *
 293:    * @return A String that describes the JDesktopPane.
 294:    */
 295:   protected String paramString()
 296:   {
 297:     return "JDesktopPane";
 298:   }
 299: 
 300:   /**
 301:    * This method returns all the JInternalFrames in the given Component array.
 302:    *
 303:    * @param components An array to search for JInternalFrames in.
 304:    *
 305:    * @return An array of JInternalFrames found in the Component array.
 306:    */
 307:   private static JInternalFrame[] getFramesFromComponents(Component[] components)
 308:   {
 309:     int count = 0;
 310: 
 311:     for (int i = 0; i < components.length; i++)
 312:     if (components[i] instanceof JInternalFrame)
 313:       count++;
 314:       
 315:     JInternalFrame[] value = new JInternalFrame[count];
 316:     for (int i = 0, j = 0; i < components.length && j != count; i++)
 317:       if (components[i] instanceof JInternalFrame)
 318:     value[j++] = (JInternalFrame) components[i];
 319:     return value;
 320:   }
 321: 
 322:   /**
 323:    * getAccessibleContext
 324:    *
 325:    * @return AccessibleContext
 326:    */
 327:   public AccessibleContext getAccessibleContext()
 328:   {
 329:     if (accessibleContext == null)
 330:       accessibleContext = new AccessibleJDesktopPane();
 331: 
 332:     return accessibleContext;
 333:   }
 334: }