| gvSIG desktop 1

package com.iver.cit.gvsig.fmap.layers;

import com.iver.cit.gvsig.fmap.DriverException;

import com.iver.cit.gvsig.fmap.FMap;

import com.iver.cit.gvsig.fmap.ViewPort;

import com.iver.cit.gvsig.fmap.drivers.DriverIOException;

import com.iver.cit.gvsig.fmap.operations.Cancellable;

import com.iver.utiles.XMLEntity;

import org.cresques.cts.ICoordTrans;

import org.cresques.geo.Projected;

import java.awt.Graphics2D;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

/**

 * Interfaz que tienen que implementar todas las capas.

 */

public interface FLayer extends Projected {

        /**

         * Obtiene una representaci?n de la colecci?n de capas de forma recursiva

         *

         * @return XMLEntity.

         */

        XMLEntity getXMLEntity();

        /**

         * Inserta las propiedades del XMLEntity al objeto actual.

         *

         * @param xml XMLEntity

         *

         * @throws XMLException

         * @throws DriverException

         * @throws DriverIOException

         */

        void setXMLEntity(XMLEntity xml)

                throws XMLException, DriverException, DriverIOException;

        /**

         * Pone la capa actual a activa o inactiva seg?n el boolean que se pasa

         * como par?metro.

         *

         * @param selected activa.

         */

        void setActive(boolean selected);

        /**

         * Devuelve true si la capa esta activa.

         *

         * @return activa.

         */

        boolean isActive();

        /**

         * Inserta un nombre a la capa.

         *

         * @param name nombre.

         */

        void setName(String name);

        /**

         * Devuelve el nombre de la capa.

         *

         * @return nombre de la capa.

         */

        String getName();

        /**

         * Realiza las operaciones de inicializaci?n de la capa. El m?todo es

         * invocado una ?nica vez durante la vida de la capa y justo antes de

         * visualizar la capa

         *

         * @throws DriverIOException

         */

        void load() throws DriverIOException;

        /**

         * Pone la capa en modo visible o no visible.

         *

         * @param visibility visibilidad.

         */

        void setVisible(boolean visibility);

        /**

         * Devuelve true si la capa es visible.

         *

         * @return visibilidad.

         */

        boolean isVisible();

        /**

         * Devuelve el FLayers padre de la capa.

         *

         * @return FLayers padre de la capa.

         */

        public FLayers getParentLayer();

        /**

         * Devuelve el FMap al que est? a?adida la capa o null si la capa no ha

         * sido a?adida a ning?n FMap

         *

         * @return FMap

         */

        public FMap getFMap();

        /**

         * Inserta el FLayers padre de la capa.

         *

         * @param root capa padre.

         */

        public void setParentLayer(FLayers root);

        /**

         * Obtiene la extensi?n completa de la capa

         *

         * @return FullExtent.

         *

         * @throws DriverException

         */

        Rectangle2D getFullExtent() throws DriverException;

        /**

         * Dibuja la capa

         *

         * @param image Imagen utilizada para acelerar el dibujado en pantalla.

         * @param g Graphics2D sobre el que dibujar.

         * @param viewPort Propiedades de la vista.

         * @param cancel PAra poder cancelar el dibujado.

         *

         * @throws DriverException

         */

        void draw(BufferedImage image, Graphics2D g, ViewPort viewPort,

                Cancellable cancel) throws DriverException;

        /**

         * Dibuja la capa

         *

         * @param g Graphics2D de la impresora sobre el que dibujar.

         * @param viewPort Propiedades de la vista.

         * @param cancel

         *

         * @throws DriverException

         */

        void print(Graphics2D g, ViewPort viewPort, Cancellable cancel)

                throws DriverException;

        /**

         * Inserta las coordenadas de transformaci?n.

         *

         * @param ct Coordenadas de transformaci?n.

         */

        void setCoordTrans(ICoordTrans ct);

        /**

         * Devuelve las coordenadas de transformaci?n.

         *

         * @return Coordenadas de transformaci?n.

         */

        ICoordTrans getCoordTrans();

        /**

         * A?ade un listener LayerListener a la lista de listeners.

         *

         * @param o Listener.

         *

         * @return True si es correcta la inserci?n del listener.

         */

        public boolean addLayerListener(LayerListener o);

        /**

         * Borra de la lista el LayerListener que se pasa como par?metro.

         *

         * @param o Listener.

         *

         * @return True si es correcto el borrado del listener.

         */

        public boolean removeLayerListener(LayerListener o);

}