1 /* JDesktopPane.java --
2 Copyright (C) 2002, 2004 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
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)
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.
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., 59 Temple Place, Suite 330, Boston, MA
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
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. */
41 import java.awt.Component;
42 import java.beans.PropertyVetoException;
44 import javax.accessibility.Accessible;
45 import javax.accessibility.AccessibleContext;
46 import javax.accessibility.AccessibleRole;
47 import javax.swing.plaf.DesktopPaneUI;
50 * JDesktopPane is a container (usually for JInternalFrames) that simulates a
51 * desktop. Typically, the user will create JInternalFrames and place thme 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
57 public class JDesktopPane extends JLayeredPane implements Accessible
60 private static final long serialVersionUID = 766333777224038726L;
63 * This specifies that when dragged, a JInternalFrame should be completely
66 * @specnote final since 1.5.0.
68 public static final int LIVE_DRAG_MODE = 0;
71 * This specifies that when dragged, a JInternalFrame should only be visible
74 * @specnote final since 1.5.0.
76 public static final int OUTLINE_DRAG_MODE = 1;
78 /** The selected frame in the JDesktopPane. */
79 private transient JInternalFrame selectedFrame;
81 /** The JDesktopManager to use for acting on JInternalFrames. */
82 transient DesktopManager desktopManager;
84 /** The drag mode used by the JDesktopPane. */
85 private transient int dragMode = LIVE_DRAG_MODE;
88 * AccessibleJDesktopPane
90 protected class AccessibleJDesktopPane extends AccessibleJComponent
93 private static final long serialVersionUID = 6079388927946077570L;
96 * Constructor AccessibleJDesktopPane
98 protected AccessibleJDesktopPane()
105 * @return AccessibleRole
107 public AccessibleRole getAccessibleRole()
109 return AccessibleRole.DESKTOP_PANE;
114 * Creates a new JDesktopPane object.
116 public JDesktopPane()
123 * This method returns the UI used with the JDesktopPane.
125 * @return The UI used with the JDesktopPane.
127 public DesktopPaneUI getUI()
129 return (DesktopPaneUI) ui;
133 * This method sets the UI used with the JDesktopPane.
135 * @param ui The UI to use with the JDesktopPane.
137 public void setUI(DesktopPaneUI ui)
143 * This method sets the drag mode to use with the JDesktopPane.
145 * @param mode The drag mode to use.
147 * @throws IllegalArgumentException If the drag mode given is not
148 * LIVE_DRAG_MODE or OUTLINE_DRAG_MODE.
150 public void setDragMode(int mode)
152 if ((mode != LIVE_DRAG_MODE) && (mode != OUTLINE_DRAG_MODE))
153 throw new IllegalArgumentException("Drag mode not valid.");
155 // FIXME: Unsupported mode.
156 if (mode == OUTLINE_DRAG_MODE)
158 // throw new IllegalArgumentException("Outline drag modes are unsupported.");
159 mode = LIVE_DRAG_MODE;
166 * This method returns the drag mode used with the JDesktopPane.
168 * @return The drag mode used with the JDesktopPane.
170 public int getDragMode()
176 * This method returns the DesktopManager used with the JDesktopPane.
178 * @return The DesktopManager to use with the JDesktopPane.
180 public DesktopManager getDesktopManager()
182 return desktopManager;
186 * This method sets the DesktopManager to use with the JDesktopPane.
188 * @param manager The DesktopManager to use with the JDesktopPane.
190 public void setDesktopManager(DesktopManager manager)
192 desktopManager = manager;
196 * This method restores the UI used with the JDesktopPane to the default.
198 public void updateUI()
200 setUI((DesktopPaneUI) UIManager.getUI(this));
205 * This method returns a String identifier that allows the UIManager to know
206 * which class will act as JDesktopPane's UI.
208 * @return A String identifier for the UI class to use.
210 public String getUIClassID()
212 return "DesktopPaneUI";
216 * This method returns all JInternalFrames that are in the JDesktopPane.
218 * @return All JInternalFrames that are in the JDesktopPane.
220 public JInternalFrame[] getAllFrames()
222 return getFramesFromComponents(getComponents());
226 * This method returns the currently selected frame in the JDesktopPane.
228 * @return The currently selected frame in the JDesktopPane.
230 public JInternalFrame getSelectedFrame()
232 return selectedFrame;
236 * This method sets the selected frame in the JDesktopPane.
238 * @param frame The selected frame in the JDesktopPane.
240 public void setSelectedFrame(JInternalFrame frame)
242 if (selectedFrame != null)
246 selectedFrame.setSelected(false);
248 catch (PropertyVetoException e)
252 selectedFrame = null;
257 frame.setSelected(true);
259 selectedFrame = frame;
261 catch (PropertyVetoException e)
267 * This method returns all the JInternalFrames in the given layer.
269 * @param layer The layer to grab frames in.
271 * @return All JInternalFrames in the given layer.
273 public JInternalFrame[] getAllFramesInLayer(int layer)
275 return getFramesFromComponents(getComponentsInLayer(layer));
279 * This method always returns true to indicate that it is not transparent.
283 public boolean isOpaque()
289 * This method returns a String that describes the JDesktopPane.
291 * @return A String that describes the JDesktopPane.
293 protected String paramString()
295 return "JDesktopPane";
299 * This method returns all the JInternalFrames in the given Component array.
301 * @param components An array to search for JInternalFrames in.
303 * @return An array of JInternalFrames found in the Component array.
305 private static JInternalFrame[] getFramesFromComponents(Component[] components)
309 for (int i = 0; i < components.length; i++)
310 if (components[i] instanceof JInternalFrame)
313 JInternalFrame[] value = new JInternalFrame[count];
314 for (int i = 0, j = 0; i < components.length && j != count; i++)
315 if (components[i] instanceof JInternalFrame)
316 value[j++] = (JInternalFrame) components[i];
321 * getAccessibleContext
323 * @return AccessibleContext
325 public AccessibleContext getAccessibleContext()
327 if (accessibleContext == null)
328 accessibleContext = new AccessibleJDesktopPane();
330 return accessibleContext;