Application: gvSIG desktop » gvSIG Document Layout

/* 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.app.project.documents.layout.fframes;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.awt.image.BufferedImage;

import org.gvsig.fmap.dal.exception.ReadException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.mapcontext.MapContext;

/**

 * FFrame which uses a MapContext object, usually because their content is

 * dependent on the MapContext properties

 */

public interface IFFrameUseFMap extends IFFrame {

    public AffineTransform getATMap();

    public void setATMap(AffineTransform at);

    /**

     * Returns the MapContext contained in this FFrameView, which is

     * usually a clone of the associated View. This MapContext

     * may be synchronized with the View one, depending on the

     * scale type that has been set (see {{@link #getTypeScale()}.

     *

     * @return The mapContext object

     */

    public MapContext getMapContext();

    /**

     * Invalidates the FFrameView cache, which will cause the

     * FFrame to be repainted on the next drawing cycle.

     */

    public void refresh();

    /**

     * Sets the extent of the MapContext contained in this FFrameView. It will

     * be ignored if {@link #getScaleType()} equals to

     * {@link SCALE_TYPE#FIXED_SCALE} or {@link SCALE_TYPE#FIXED_EXTENT}

     *

     * @param r Envelope to be set

     */

    public void setNewEnvelope(Envelope r);

    /**

     * Gets a buffered image containing a cached version of the

     * painted result of this FFrame. The size of the buffered image

     * will match only the visible area of the component, not the full

     * size of it.

     *

     * @return The cached image or null if the image is not available

     */

    public BufferedImage getBufferedImage();

    /**

     * Zooms to the extent containing all the layers loaded in the map.

     *

     * @throws ReadException

     */

    public void fullExtent() throws ReadException;

    public void setPointsToZoom(Point2D px1, Point2D px2);

    public void movePoints(Point2D px1, Point2D px2);

    public void refreshOriginalExtent();

    /**

     * Gets the synchronization mode for layers. If <code>true</code>, layers

     * will be synchronized between the FFrameView and the associated View, so

     * any change in the FFrameView (layer added or removed, visibility changed,

     * symbology change, etc) will be propagated to the associated View, and

     * vice versa.

     *

     * @return <code>true</code> if the layers are synchronized between the

     * FFrameView and the View, <code>false</code> otherwise.

     */

    public boolean getLayerSynced();

    /**

     * Sets the synchronization mode for map layers. If <code>true</code>,

     * layers will be synchronized between the FFrameView and the associated

     * View, so any change in the FFrameView (layer added or removed,

     * visibility changed, symbology change, etc) will be propagated to the

     * associated View, and vice versa.

     *

     * @param synced <code>true</code> to enable layers synchronization

     * between the FFrameView and the View, <code>false</code> otherwise.

     */

    public void setLayerSynced(boolean synced);

    /**

     * Gets the synchronization mode for the map extent. If <code>true</code>,

     * the map extent will be synchronized between the FFrameView and the

     * associated View, so any change in the FFrameView (pan, zoom in, zoom

     * out...) will be propagated to the associated View, and vice versa.

     *

     * @return <code>true</code> if the map extent is synchronized between the

     * FFrameView and the View, <code>false</code> otherwise.

     */

    public boolean getExtentSynced();

    /**

     * Sets the synchronization mode for the map extent. If <code>true</code>,

     * the map extent will be synchronized between the FFrameView and the

     * associated View, so any change in the FFrameView (pan, zoom in, zoom

     * out...) will be propagated to the associated View, and vice versa.

     *

     * @param synced <code>true</code> to enable extent synchronization

     * between the FFrameView and the View, <code>false</code> otherwise.

     */

    public void setExtentSynced(boolean synced);

    /**

     * Sets the scale of the MapContext contained in this FFrameView. It will

     * be ignored if {@link #getScaleType()} equals to

     * {@link SCALE_TYPE#FIXED_SCALE} or {@link SCALE_TYPE#FIXED_EXTENT}

     *

     * @param d Scale to be set

     */

    public void setScale(double d);

    public static enum SCALE_TYPE {

            /**

             * The scale and extent can be changed without restrictions

             */

            NORMAL,

            /**

             * The scale has been fixed, so pans are enabled but the scale

             * can't be changed and the zoom in/out tools also behave as

             * pans.

             */

            FIXED_SCALE,

            /**

             * The extent has been fixed, so the scale can't be changed and

             * the pan and zoom tools will not produce any change

             */

            FIXED_EXTENT

    };

    /**

     * Gets the scale and extent types. It can be one of the following:

     * {@link SCALE_TYPE#NORMAL}, {@link SCALE_TYPE#FIXED_SCALE}

     * or {@link SCALE_TYPE#FIXED_EXTENT}

     *

     * @return The scale type

     */

    public SCALE_TYPE getScaleType();

    /**

     * Sets the scale and extent types. It can be one of the following:

     * {@link SCALE_TYPE#NORMAL}, {@link SCALE_TYPE#FIXED_SCALE}

     * or {@link SCALE_TYPE#FIXED_EXTENT}

     *

     * @return The scale type

     */

    public void setScaleType(SCALE_TYPE scaleType);

    /*

    DEPRECATED METHODS AND CONSTANTS, KEPT FOR THE MOMENT FOR

    BACKWARD-COMPATIBILITY. THEY SHOULD BE REMOVED ON FUTURE RELEASES

     */

    /**

     * Kept for the moment for backward-compatibility, it will be

     * removed on the future.

     *

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public static final int AUTOMATICO = 0;

    /**

     * Kept for the moment for backward-compatibility, it will be

     * removed on the future.

     *

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public static final int CONSTANTE = 1;

    /**

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public static final int MANUAL = 2;

    /**

     * Kept for the moment for backward-compatibility, it will be

     * removed on the future.

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public int getTypeScale();

    /**

     * Kept for the moment for backward-compatibility, it will be

     * removed on the future.

     *

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public void setLinked(boolean b);

    /**

     * Kept for the moment for backward-compatibility, it will be

     * removed on the future.

     *

     * @Deprecated Replaced by {@link #getExtentSynced()},

     * {@link #setExtentSynced(boolean)}, {@link #getLayerSynced()},

     * {@link #setLayerSynced(boolean)}, {@link #getScaleType()}

     * and {@link #setScaleType(SCALE_TYPE)}.

     */

    @Deprecated

    public boolean getLinked();

}