001 /*
002 * Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.swing;
027
028 /** DesktopManager objects are owned by a JDesktopPane object. They are responsible
029 * for implementing L&F specific behaviors for the JDesktopPane. JInternalFrame
030 * implementations should delegate specific behaviors to the DesktopManager. For
031 * instance, if a JInternalFrame was asked to iconify, it should try:
032 * <PRE>
033 * getDesktopPane().getDesktopManager().iconifyFrame(frame);
034 * </PRE>
035 * This delegation allows each L&F to provide custom behaviors for desktop-specific
036 * actions. (For example, how and where the internal frame's icon would appear.)
037 * <p>This class provides a policy for the various JInternalFrame methods, it is not
038 * meant to be called directly rather the various JInternalFrame methods will call
039 * into the DesktopManager.</p>
040 *
041 * @see JDesktopPane
042 * @see JInternalFrame
043 * @see JInternalFrame.JDesktopIcon
044 *
045 * @version 1.22 05/05/07
046 * @author David Kloba
047 */
048 public interface DesktopManager {
049 /** If possible, display this frame in an appropriate location.
050 * Normally, this is not called, as the creator of the JInternalFrame
051 * will add the frame to the appropriate parent.
052 */
053 void openFrame(JInternalFrame f);
054
055 /** Generally, this call should remove the frame from it's parent. */
056 void closeFrame(JInternalFrame f);
057
058 /** Generally, the frame should be resized to match it's parents bounds. */
059 void maximizeFrame(JInternalFrame f);
060
061 /** Generally, this indicates that the frame should be restored to it's
062 * size and position prior to a maximizeFrame() call.
063 */
064 void minimizeFrame(JInternalFrame f);
065
066 /** Generally, remove this frame from it's parent and add an iconic representation. */
067 void iconifyFrame(JInternalFrame f);
068
069 /** Generally, remove any iconic representation that is present and restore the
070 * frame to it's original size and location.
071 */
072 void deiconifyFrame(JInternalFrame f);
073
074 /**
075 * Generally, indicate that this frame has focus. This is usually called after
076 * the JInternalFrame's IS_SELECTED_PROPERTY has been set to true.
077 */
078 void activateFrame(JInternalFrame f);
079
080 /**
081 * Generally, indicate that this frame has lost focus. This is usually called
082 * after the JInternalFrame's IS_SELECTED_PROPERTY has been set to false.
083 */
084 void deactivateFrame(JInternalFrame f);
085
086 /** This method is normally called when the user has indicated that
087 * they will begin dragging a component around. This method should be called
088 * prior to any dragFrame() calls to allow the DesktopManager to prepare any
089 * necessary state. Normally <b>f</b> will be a JInternalFrame.
090 */
091 void beginDraggingFrame(JComponent f);
092
093 /** The user has moved the frame. Calls to this method will be preceded by calls
094 * to beginDraggingFrame().
095 * Normally <b>f</b> will be a JInternalFrame.
096 */
097 void dragFrame(JComponent f, int newX, int newY);
098
099 /** This method signals the end of the dragging session. Any state maintained by
100 * the DesktopManager can be removed here. Normally <b>f</b> will be a JInternalFrame.
101 */
102 void endDraggingFrame(JComponent f);
103
104 /** This methods is normally called when the user has indicated that
105 * they will begin resizing the frame. This method should be called
106 * prior to any resizeFrame() calls to allow the DesktopManager to prepare any
107 * necessary state. Normally <b>f</b> will be a JInternalFrame.
108 */
109 void beginResizingFrame(JComponent f, int direction);
110
111 /** The user has resized the component. Calls to this method will be preceded by calls
112 * to beginResizingFrame().
113 * Normally <b>f</b> will be a JInternalFrame.
114 */
115 void resizeFrame(JComponent f, int newX, int newY, int newWidth,
116 int newHeight);
117
118 /** This method signals the end of the resize session. Any state maintained by
119 * the DesktopManager can be removed here. Normally <b>f</b> will be a JInternalFrame.
120 */
121 void endResizingFrame(JComponent f);
122
123 /** This is a primitive reshape method.*/
124 void setBoundsForFrame(JComponent f, int newX, int newY,
125 int newWidth, int newHeight);
126 }
|