Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.andami.ui.mdiManager;

import java.beans.PropertyVetoException;

import com.iver.andami.ui.mdiFrame.MDIFrame;

/**

 * Las vistas que se a?aden al framework derivan de JPanel. ?Como pasamos de un

 * JPanel al control que vemos (habitualmente un JInternalFrame) Mediante la

 * clase skin que implementa esta interfaz. El framework  invoca los m?todos

 * de la clase pasando como par?metros jPanel y la clase toma el JPanel, lo

 * trata (en la version por defecto lo mete en un JInternalFrame) y lo a?ade

 * al Frame principal. Para poner un ejemplo se podr?a implementar ua clase

 * que situara los jpanel en la forma que lo hace eclipse, o instalar un men?

 * por cada vista de forma que al seleccionar el men?  desapareciera la vista

 * actual y se mostrara la que  se ha seleccionado, ...     Actualmente la

 * clase que implementa esta interfaz es Skin y se usa a pi??n fijo, pero en

 * un futuro se dejar? abierta la posibilidad de sustituir esta clase por una

 * que  implemente el usuario.

 *

 * @author Fernando Gonz?lez Cort?s

 */

public interface MDIManager {

    /**

     * Inicializaci?n de la clase, se le pasa la consola para mostrar mensajes

     * y el frame principal para actuar sobre ?l

     *

     * @param f DOCUMENT ME!

     */

    public void init(MDIFrame f);

    /**

     * A?ade una nueva vista a la interfaz y lo visualiza. Dicho vista se

     * elimina completamente al cerrarse.

     *

     * @param p Panel con los controles de la vista

     *

     * @return Devuelve la vista a?adida o si es un singleton y ya estaba

     *         a?adida devuelve la vista ya a?adida

     *

     * @throws SingletonDialogAlreadyShownException Si lo que se est? a?adiendo

     *         es una vista modal singleton y ya est? a?adida

     */

    public IWindow addWindow(IWindow p) throws SingletonDialogAlreadyShownException;

    /**

     * @author Pablo Piqueras Bartolom?

     * 

     * A?ade una nueva vista centrada a la interfaz y la visualiza. Dicha vista se

     * elimina completamente al cerrarse.

     *

     * @param p Panel con los controles de la vista

     *

     * @return Devuelve la vista a?adida o si es un singleton y ya estaba

     *         a?adida devuelve la vista ya a?adida

     *

     * @throws SingletonDialogAlreadyShownException Si lo que se est? a?adiendo

     *         es una vista modal singleton y ya est? a?adida

     */

    public IWindow addCentredWindow(IWindow p) throws SingletonDialogAlreadyShownException;

    /**

     * Obtiene una referencia al panel de la ultima vista no modal que se

     * activ? en la aplicaci?n.

     *

     * @return referencia al panel activo o null si no hay ninguna vista activa

     */

    public IWindow getActiveWindow();

    /**

     * Obtiene una referencia al panel de la ?ltima vista, ya sea modal o no,que se

     * activ? en la aplicaci?n.

     *

     * @return referencia al panel activo o null si no hay ninguna vista activa

     */

    public IWindow getFocusWindow();

    /**

     * Obtiene una referencia a los paneles de todas las ventanas no modales que

     * hay en la aplicaci?n.

     *

     * @return Un vector con todos los paneles que contiene la aplicaci?n.

     */

    public IWindow[] getAllWindows();

    /**

     * Gets a reference to the panels of all the non modal windows present in

     * the application. The panels are provided in the same order that

     * they have in the application.

     * 

     * @return An ordered array containing all the panels in the application.

     * The first element of the array is the topmost (foreground) window in the

     * application. The last element is the botton (background) window.

     */

    public IWindow[] getOrderedWindows();

    /**

     * Cierra la ventana SingletonView cuya clase se pasa como par?metro y cuyo

     * modelo se pasa como par?metro.

     *

     * @param viewClass Clase de la vista que se quiere cerrar

     * @param model Modelo de la vista que se quiere cerrar

     *

     * @return true si hay abierta una vista con la clase viewClass y con el

     *         modelo que se pasa como par?metro. False si no hay ninguna

     *         ventana de ese tipo.

     */

    public boolean closeSingletonWindow(Class viewClass, Object model);

    /**

     * Cierra todas las ventanas Singleton que tengan como modelo el que se

     * pasa como par?metro

     *

     * @param model Modelo de las ventanas que se quieren cerrar

     *

     * @return true si se cierra alguna ventana y false si no hay abierta

     *         ninguna ventana singleton con ese modelo

     */

    public boolean closeSingletonWindow(Object model);

    /**

     * Cierra la vista correspondiente con el JPanel

     *

     * @param p vista que se quiere cerrar

     */

    public void closeWindow(IWindow p);

    /**

     * Cierra todas las vistas que actualmente est?n abiertas

     */

    public void closeAllWindows();

    /**

     * Obtiene la referencia al objeto que contiene la informaci?n de la vista

     * que se pasa como par?metro

     *

     * @param v vista cuya informaci?n se requiere

     *

     * @return ViewInfo

     */

    public WindowInfo getWindowInfo(IWindow v);

    /**

     * Pone como icono de rat?n el HourGlass y bloquea todos los eventos de la

     * interfaz que se producen hasta que se recibe una llamada a

     * restoreCursor

     */

    public void setWaitCursor();

    /**

     * Restaura al icono de rat?n que hab?a antes de realizar la operaci?n

     */

    public void restoreCursor();

    /**

     * Maximiza o no la ventana que contiene la vista v

     * @param v

     * @param bMaximum

     * @throws PropertyVetoException

     */

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

    /**

     * Cambia el ViewInfo de la vista por el que pasamos como par?metro, utilizado de

     * momento para cambiar la vista a palette

     * @param v

     * @param vi

     */

    public void changeWindowInfo(IWindow v, WindowInfo vi);

}