Application: gvSIG desktop » gvSIG projections

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2012 gvSIG Association

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.proj.swing;

import java.awt.event.ActionListener;

import org.gvsig.proj.CoordinateReferenceSystem;

import org.gvsig.proj.catalog.CRSDefinition;

import org.gvsig.proj.catalog.extent.GeographicBoundingBox;

import org.gvsig.tools.swing.api.Component;

/**

 * User interface component API to select a {@link CoordinateReferenceSystem}.

 * 

 * @author gvSIG Team

 */

public interface CoordinateReferenceSystemSelectorComponent extends Component {

    /**

     * Returns the current {@link CoordinateReferenceSystem}.

     * 

     * @return the current {@link CoordinateReferenceSystem}

     */

    CoordinateReferenceSystem getCoordinateReferenceSystem();

    /**

     * Sets the current {@link CoordinateReferenceSystem}.

     * 

     * @param crs

     *            the current {@link CoordinateReferenceSystem}

     */

    void setCoordinateReferenceSystem(CoordinateReferenceSystem crs);

    /**

     * Sets the label to use in the user interface for the custom group of

     * CRSs.

     * 

     * @param label

     */

    void setCustomGroupLabel(String label);

    /**

     * Adds a CRS to the list of custom definitions

     * 

     * @param customCRS

     */

    void addCustomCRS(CRSDefinition customCRS);

    /**

     * Adds an spatial filter to the list of available spatial filter.

     * 

     * @param label Identifies this spatial filter and it is used as the filter name in user interface

     * @param minLon

     * @param maxLon

     * @param minLat

     * @param maxLat

     */

    void addCRSSpatialFilter(String label, GeographicBoundingBox boundingBox);

    /**

     * Adds a listener to be notified when a CRS is selected

     * 

     * @param listener

     */

    void addCRSSelectionListener(ActionListener listener);

    /**

     * Enables the spatial filter identified by {@code label}. The CRSs will be

     * included in the search if their validity area contains the provided bounding box.

     * 

     * @param label The label of the spatial filter to enable, as defined by

     * in the {@link #addCRSSpatialFilter(String, GeographicBoundingBox)} method.

     * Non-existing spatial filters are ignored

     */

    void enableSpatialFilter(String label);

    /**

     * Enables an alphanumeric filter to refine the list of CRSs to those matching the

     * provided search string.

     * 

     * @param searchString

     */

    void enableAlphanumericFilter(String searchString);

}