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.plugins;

/**

 * <p>

 * Una extensi?n es el mecanismo en la que los plugins pueden extender Andami.

 * En la aplicaci?n habr? una instancia de cada extensi?n, las cuales tienen

 * unos m?todos que ser?n ejecutados en respuesta a acciones del usuario. Las

 * extensiones pueden a?adir controles a la interfaz de usuario.  Pueden

 * a?adir men?s y herramientas de la barra de herramientas, de forma que al

 * ser seleccionadas se ejecute c?digo de la extensi?n. Adem?s de implementar esta

 * interfaz, una extensi?n ha de tener un constructor vac?o, el cual ser? invocado

 * para crear la instancia de la interfaz

 * </p>

 *

 * <p>

 * En un plugin correctamente implementado se crear? una instancia de cada

 * extensi?n. Tras la creaci?n se invocar? al m?todo inicializar y luego con

 * la aplicaci?n en marcha se invocar? a los m?todos isEnabled(), isVisible(),

 * repetidas veces para controlar la activaci?n y visualizaci?n de los

 * controles relacionados con la  extensi?n. Cuando se ejecuta una extensi?n

 * se ejecuta el metodo execute. Dicho m?todo se ejecuta en el thread de la

 * interfaz de usuario, por lo que dejar? la interfaz bloqueada. Si se quiere

 * dejar activa la interfaz se deber? lanzar un thread a parte. Al finalizar la

 * extensi?n, se ejecutar? el m?todo finalize.

 * </p>

 *

 * <p>

 * Esta clase est? "deprecated". En un futuro de deben sustituir las apariciones

 * de esta interfaz por la clase abstracta Extension

 * </p>

 */

public interface IExtension {

        /**

     * C?digo de inicializaci?n de la extension.

     */

    public void initialize();

    /**

     * M?todo que se ejecuta al finalizar la inicializaci?n de todas las extensiones

     *

     */

    public void postInitialize();

    /**

     * M?todo que se ejecuta al finalizar la extensi?n

     *

     */

    public void terminate();

    /**

     * M?todo que se ejecuta cuando el usuario acciona un control de la

     * extensi?n

     *

     * @param status DOCUMENT ME!

     * @param actionCommand DOCUMENT ME!

     *

     * @throws Throwable DOCUMENT ME!

     */

    public void execute(String actionCommand);

    /**

     * Este m?todo es invocado por la aplicaci?n para habilitar o desabilitar

     * el estado de los controles (men?s y botones de la barra de

     * herramientas) que ejecutan el c?digo de la extensi?n.

     *

     * @return true si el c?digo debe estar habilitado y false en caso

     *         contrario

     */

    public boolean isEnabled();

    /**

     * Este m?todo es invocado por la aplicaci?n para mostrar o esconder los

     * controles (men?s y botones de la barra de herramientas)  que ejecutan

     * el c?digo de la extensi?n.

     *

     * @return true si el c?digo debe estar visibles y false en caso contrario

     */

    public boolean isVisible();

    /**

     * Este m?todo es invocado por la aplicaci?n para habilitar o desabilitar los

     * controles (men?s y botones de la barra de herramientas) de la extensi?n

     * 'extension'. Este metodo es utilizado cuando la extesion actual esta

     * especificada en el par?metro de linea de comando 'exclusiveUI'

     *

     * @return true si el c?digo debe estar habilitado y false en caso

     *         contrario

     */

    public boolean isEnabled(IExtension extension);

    /**

     * Este m?todo es invocado por la aplicaci?n para mostrar o esconder los

     * controles (men?s y botones de la barra de herramientas) de la extensi?n

     * 'extension'. Este metodo es utilizado cuando la extesion actual esta

     * especificada en el par?metro de linea de comando 'exclusiveUI'

     *

     * @return true si el c?digo debe estar visibles y false en caso contrario

     */

    public boolean isVisible(IExtension extension);

}