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.swing.gcanvas;

import java.awt.Color;

import java.awt.Graphics;

import java.awt.event.MouseListener;

import java.awt.event.MouseMotionListener;

import java.util.List;

/**

 * Canvas where graphic elements are painted

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

 */

public interface GCanvas extends MouseListener, MouseMotionListener {

        /**

     * Creates a border layer to the graphic canvas

     * @param color

     * @return

     */

    public DrawableElement createBorderLayerForGCanvas(Color color);

    /**

     * Creates a information layer for the graphic canvas

     * @param colorLayer

     * @return

     */

    public InfoLayer createInfoLayerForGCanvas(Color colorLayer);

    /**

     * Creates a histogram for the graphic canvas

     * @param data

     * @param color

     * @return

     */

    public GraphicHistogram createHistogramForGCanvas(double[] data, Color color);

    /**

     * Creates a minmax layer for the graphic canvas

     * @param color

     * @return

     */

    public MinMaxLines createMinMaxLinesForGCanvas(Color color);

    /**

     * Creates a straight line layer for the graphic canvas

     * @param color

     * @return

     */

    public StraightLine createStraightLineForGCanvas(Color color);

    /**

     * Creates a logaritmic or exponential function layer for the graphic canvas

     * @param color

     * @return

     */

    public LogaritmicExponentialLine createLogaritmicExponentialLineForGCanvas(Color color, double point);

    /**

     * Creates a square root or pow line function for the graphic canvas

     * @param color

     * @return

     */

    public SquareRootPowLine createSquareRootPowLineForGCanvas(Color color, double point);

    /**

     * Creates a density slice function for the graphic canvas

     * @param color

     * @return

     */

    public DensitySlicingLine createDensitySliceForGCanvas(Color color, int levels);

        public void addBorder(int x1, int y1, int x2, int y2);

        /**

         * A?adir un listener a la lista de eventos

         * @param listener

         */

        public void addValueChangedListener(IGCanvasListener listener);

        /**

         * Borrar un listener de la lista de eventos

         * @param listener

         */

        public void removeValueChangedListener(IGCanvasListener listener);

        /**

         * Invocar a los eventos asociados al componente

         */

        public void callDataChanged(String key, Object value);

        /**

         * Invocar a los eventos asociados al componente

         */

        public void callDataDragged(String key, Object value);

        /**

         * A?ade un elemento dibujable a la lista

         * @param element

         */

        public void addDrawableElement(DrawableElement element);

        /**

         * Reemplaza un elemento dibujable si encuentra uno de su mismo tipo

         * @param element

         */

        public void replaceDrawableElement(DrawableElement element);

        /**

         * Obtiene todos los elementos dibujable que sean una instancia de c1

         * @param c1

         * @return ArrayList de DrawableElements

         */

        public List<DrawableElement> getDrawableElements(Class<?> c1);

        /**

         * Reemplaza un elemento dibujable si encuentra uno del tipo especificado en el 

         * parametro c1

         * @param element

         * @param c1

         */

        public void replaceDrawableElement(DrawableElement element, Class<?> cl);

        /**

         * Elimina un elemento dibujable

         * @param Class clase del elemento a eliminar

         */

        public void removeDrawableElement(Class<?> cl);

        /**

         * Asigna una lista de elementos dibujables

         * @return

         */

        public void setDrawableElements(List<DrawableElement>  list);

        /**

         * Inicializa el fondo y dibuja el gr?fico sobre el canvas.

         */

        public void paint(Graphics g);

        /**

         * Ejecuta las acciones antes del primer dibujado de todos

         * los elementos dibujables

         */

        public void execFirstDrawActions();

        /**

         * Obtiene la posici?n m?nima en X del canvas donde comenzar a dibujar

         * @return

         */

        public int getCanvasMinX();

        /**

         * Obtiene la posici?n m?nima en Y del canvas donde comenzar a dibujar

         * @return

         */

        public int getCanvasMinY();

        /**

         * Obtiene la posici?n m?xima en X del canvas donde terminar el dibujado

         * @return

         */

        public int getCanvasMaxX();

        /**

         * Obtiene la posici?n m?xima en Y del canvas donde terminar el dibujado

         * @return

         */

        public int getCanvasMaxY();

        /**

         * Obtiene el ancho del canvas sumando a partir de getCanvasX donde termina el ?rea de dibujo

         * @return

         */

        public int getCanvasWidth();

        /**

         * Obtiene el alto del canvas sumando a partir de getCanvasY donde termina el ?rea de dibujo

         * @return

         */

        public int getCanvasHeight();

}