Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* 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., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

package org.gvsig.raster.algorithm;

import java.util.EventListener;

import javax.swing.JComponent;

/**

 * Interface for panels which build an algorithm using the parameters selected

 * by the user

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface BasicAPISwingPanel {

        /**

         * Gets the main component 

         * @return

         */

        public JComponent getComponent();

        /**

         * Gets the process loaded with the data selected in the interface

         * @return

         */

        public Object getResult() throws Exception;

        /**

         * Initialization actions.

         */

        public void initialize();

        /**

         * Gets the component ID using the object of this component. This is useful

         * to know what button has been pressed in a panel. The IDs should be defined

         * in the component API.

         * @param obj

         * @return

         */

        public int getComponentIDByObject(Object obj);

        /**

         * Adds a listener to the components of a panel. The EventListener could be

         * any listener.

         * @param listener

         */

        public void addListener(EventListener listener);

}