Application: gvSIG desktop » gvSIG projections

/* gvSIG. Desktop Geographic Information System.

*

* Copyright ? 2018 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 org.gvsig.proj.CoordinateTransformation;

import java.awt.event.ActionListener;

import org.gvsig.proj.CoordinateReferenceSystem;

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

/**

* User interface component API to select a {@link CoordinateTransformation} and

* optionally the source and target CoordinateReferenceSystems for the

* transformation (or converesion) of coordinates.

* 

* @author gvSIG Team

*/

public interface CoordinateTransformationSelectorComponent extends Component {

   /**

    * Returns the source {@link CoordinateReferenceSystem}.

    * 

    * @return the source {@link CoordinateReferenceSystem}

    */

   CoordinateReferenceSystem getSourceCoordinateReferenceSystem();

   /**

    * Returns the target {@link CoordinateReferenceSystem}.

    * 

    * @return the target {@link CoordinateReferenceSystem}

    */

   CoordinateReferenceSystem getTargetCoordinateReferenceSystem();

   /**

    * Returns the selected {@link CoordinateTransformation}.

    * 

    * @return the selected {@link CoordinateTransformation}

    */

   CoordinateTransformation getCoordinateTransformation();

   /**

    * Sets the current {@link CoordinateTransformation}.

    * 

    * @param transformation

    *            the current {@link CoordinateTransformation}

    */

   void setCoordinateTransformation(CoordinateTransformation transformation);

   /**

    * Sets the source {@link CoordinateReferenceSystem}.

    * 

    * @param crs

    *            the source {@link CoordinateReferenceSystem}

    */

   void setSourceCoordinateReferenceSystem(CoordinateReferenceSystem source);

   /**

    * Sets the source {@link CoordinateReferenceSystem} and defines whether

    * the source CRS selector should be editable by the user. The selector

    * will be enabled by default.

    * 

    * @param crs

    *            the source {@link CoordinateReferenceSystem}

    * @param editable

    *            whether the source coordinate reference system control

    *            should be editable by the user

    */

   void setSourceCoordinateReferenceSystem(CoordinateReferenceSystem source, boolean editable);

   /**

    * Sets the target {@link CoordinateReferenceSystem}.

    * 

    * @param crs

    *            the target {@link CoordinateReferenceSystem}

    */

   void setTargetCoordinateReferenceSystem(CoordinateReferenceSystem target);

   /**

    * Sets the target {@link CoordinateReferenceSystem} and defines whether

    * the target CRS selector should be editable by the user. The selector

    * will be enabled by default.

    * 

    * @param target

    *            the target {@link CoordinateReferenceSystem}

    * @param editable

    *            whether the target coordinate reference system control

    *            should be editable by the user

    */

   void setTargetCoordinateReferenceSystem(CoordinateReferenceSystem target, boolean editable);

   /**

    * Determines whether the source coordinate reference system control

    * is editable by the user

    * 

    * @see #setSourceCoordinateReferenceSystem(CoordinateReferenceSystem, boolean)

    */

   boolean isSourceCoordinateReferenceSystemEditable();

   /**

    * Determines whether the target coordinate reference system control

    * should be editable by the user

    * 

    * @see #setTargetCoordinateReferenceSystem(CoordinateReferenceSystem, boolean)

    */

   boolean isTargetCoordinateReferenceSystemEditable();

   /**

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

    * 

    * @param listener

    */

   void addCoordinateTransformationSelectionListener(ActionListener listener);

   /**

    * Enables an alphanumeric filter to refine the list of CoordinateTransformations

    * to those matching the provided search string.

    * 

    * @param searchString

    */

   void enableAlphanumericFilter(String searchString);

}