Application: gvSIG desktop

 * which will decide the final implementation of frames. A different frame

 * implementation could be used by switching the Skin.

 * </p>

 * @see IWindow

 * @see WindowInfo

 * @see SingletonWindow

 *

 */

public interface MDIManager {

    /**

     * Initializes the MDIFrame. It must be called before starting

     * to use it. It receives the application's main frame

     *

     * @param f Application's main frame.

     */

     * new window. The new frame's properties are set according to

     * the WindowInfo object from IWindow's <code>getWindowInfo()</code>

     * method.

     * </p>

     * <p>

     * If the provided IWindow also implements SingletonWindow, and

     *

     * @return Returns the added IWindow, or in case it is a

     * SingletonWindow and there is another SingletonWindow with

     * later SingletonWindow.

     */

    public IWindow addWindow(IWindow p) throws SingletonDialogAlreadyShownException;

    /*

     */

    public final MODE WINDOW = WindowManager.MODE.WINDOW;

    public final MODE TOOL = WindowManager.MODE.TOOL;

    public final MODE DIALOG = WindowManager.MODE.DIALOG;

    /**

     * use addWindow

     * @param panel to show as a window

     * @param title title of the window

     * @param mode type of the window to create

     * Return the window associated to the SingletonWindow class and the model

     * specified. If not exists any singleton window associated to this

     * null is returned.

     * @param windowClass, the class that implement SingletonWindow

     * @param model, the model associated to the SingletonWindow

     * @return the requested window or null.

     */

    public SingletonWindow getSingletonWindow(Class windowClass, Object model) ;

    /**

     * <p>

     * Creates a new frame with the provided contents, and shows this

     * new window. The new frame will be centered, regardless the

     * position specified in the WindowInfo object from IWindow's

     * <code>getWindowInfo()</code> method.

     * </p>

     * <p>

     * If the provided IWindow also implements SingletonWindow, and

     *

     * @return Returns the added IWindow, or in case it is a

     * SingletonWindow and there is another SingletonWindow with

     * later SingletonWindow.

     * @author Pablo Piqueras Bartolom?

     */

    public IWindow addCentredWindow(IWindow p) throws SingletonDialogAlreadyShownException;

    public static final int ALIGN_PAGE_END = GridBagConstraints.PAGE_END;

    public static final int ALIGN_LAST_LINE_END = GridBagConstraints.LAST_LINE_END;

    public static final int ALIGN_CENTER = GridBagConstraints.CENTER;

    public IWindow addWindow(IWindow p, int align) throws SingletonDialogAlreadyShownException;

    /**

     * <p>

     * Modal windows and PALETTE windows are considered to be auxiliary windows,

     * that is the reason why they are not returned.

     *

     * @return A reference to the active window, or null if there is no

     * active window

     * focused window

     */

    public IWindow getFocusWindow();

    public void moveToFrom(IWindow win);

    /**

     * Gets all the open windows. Minimized and maximized windows are

     * included. The application's main frame is excluded; it can be

     * @return An IWindow array containing all the open windows.

     */

    public IWindow[] getAllWindows();

    /**

     * Gets all the open windows (as {@link #getAllWindows()}),

     * but in this method the windows are returned in the same

    /**

     * Close the SingletonWindow whose class and model are provided as

     * parameters.

     * @param viewClass Class of the window which is to be closed

     * @param model Model of the window which is to be closed

     *

     * @param v window whose information is to be retrieved

     *

     * @return WindowInfo The WindowInfo object containing the information

     * @see WindowInfo

     */

    public WindowInfo getWindowInfo(IWindow v);

    /**

     * Sets the normal cursor and unblocks events from main window.

     * @see #setWaitCursor()

     */

    public void restoreCursor();

    /**

     * Maximizes or restores the provided window

     * @param bMaximum If true, the window will be maximized,

     *  if false, it will be restored

     * @throws PropertyVetoException

     */

    public void setMaximum(IWindow v, boolean bMaximum) throws PropertyVetoException;

    /**

     * Updates the window properties (size, location, etc) according to the

     * provided WindowInfo object.

     * @param v The window whose properties are to be changed

     * @param vi The WindowInfo object containing the new properties to be set

     */

    public void changeWindowInfo(IWindow v, WindowInfo vi);

    /**

     * Forces a window to be repainted. Normally, this is not necessary,

     * as windows are refreshed when necessary.

     * @param win The window to be refreshed.

     */

    public void refresh(IWindow win);

     * Sets the provided image as background image in the main window. The image

     * will be centered, set in mosaic or expanded to fill the full window,

     * depending on the <code>typeDesktop</code> argument.

     * @param image The image to be set as background image

     * @param typeDesktop Decides whether the image should be centered, set

     * in mosaic or expanded. Accepted values are: Theme.CENTERED,

     * Theme.MOSAIC and Theme.EXPAND.

     */

    public void setBackgroundImage(ImageIcon image, String typeDesktop);

    public void setLocale(Locale locale);

}