| gvSIG desktop 1

/* 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.mdiFrame;

import com.iver.andami.plugins.PluginClassLoader;

import com.iver.andami.plugins.config.generate.Menu;

import com.iver.utiles.console.ResponseListener;

import java.awt.event.ActionListener;

import javax.swing.JComponent;

/**

 *

 */

public interface MainFrame {

        /**

         * A?ade el men? a la barra de men?s

         *

         * @param menu Texto del menu

         * @param listener objeto que recibe los eventos del menu

         * @param loader ClassLoader del plugin que instala el men?

         */

        public void addMenu(Menu menu, ActionListener listener,

                PluginClassLoader loader);

        /**

         * Cambia el nombre completo del menu, y por tanto su ubicaci?n. El array

         * de strings representa la ruta  completa del men?. por ejemplo un array

         * {"ver", "ventanas", "consola"} referencia al men? que se encuentra en

         * ver/ventanas/consola. Hay que tener en cuenta que los elementos en el

         * array son claves en el fichero de traducciones del plugin

         *

         * @param menu Ruta completa del men?

         * @param newName Nuevo nombre del menu

         * @param loader ClassLoader del plugin que a?adi? el menu

         *

         * @throws NoSuchMenuException Si no existe ning?n menu en la

         * ruta menu

         */

        public void changeMenuName(String[] menu, String newName,

                PluginClassLoader loader) throws NoSuchMenuException;

        public void setSelectedTool(String actionCommand);

        /**

         * Elimina el men? que se pasa como par?metro si est? a?adido. Si no se

         * encuentra el men? no se hace nada

         *

         * @param menu referencia al men? que se quiere eliminar

         */

        public void removeMenu(Menu menu);

        /**

         * Itera por los controles preguntando a las extensiones si estos est?n

         * habilitados y visibles

         */

        public void enableControls();

        /**

         * Sirve para establecec el mensaje en la barra de estado asociado a una etiqueta

         *

         * @return main StatusBar 

         */

        public NewStatusBar getStatusBar();

        /**

         * A?ade a la consola el texto que se pasa como par?metro

         *

         * @param text texto que se a?ade a la consola

         */

        public void addTextToConsole(String text);

        /**

         * A?ade un l?stener a la consola del sistema asociandole un prefijo. Esto

         * quiere decir que si se le asocia el prefijo "cad" las lineas que se

         * introduzcan en la misma de la forma cad:loquesea llegar?n s?lo a los

         * listeners con el prefijo "cad" y acceptResponse recibira el texto

         * introducido por el usuario sin el prefijo.

         *

         * @param prefix Prefijo de los textos destinados al listener que se pasa

         *                   como par?metro

         * @param listener listener que se a?ade

         */

        public void addConsoleListener(String prefix, ResponseListener listener);

        /**

         * Elimina un l?stener de la consola del sistema

         *

         * @param listener listener que se elimina

         */

        public void removeConsoleListener(ResponseListener listener);

        /**

         * Pasa el foco a la consola y hace que procese el evento que se pasa como

         * par?metro si es distinto de null.

         *

         * @param text Evento de teclado

         */

        public void focusConsole(String text);

        /**

         * Esconde la consola

         */

        public void hideConsole();

        /**

         * Muestra la consola

         */

        public void showConsole();

        /**

         * DOCUMENT ME!

         *

         * @param titulo DOCUMENT ME!

         */

        public void setTitle(String titulo);

    /**

     * Get a JComponent previously added by name. For example

     * you can use it if you need to obtain a JToolBar to

     * add some customized component.

     * @param name

     * @return the JComponent or null if none has been found

     */

    public JComponent getComponentByName(String name);

}