Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.cit.gvsig.gui.layout.fframes;

import com.iver.andami.PluginServices;

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

import com.iver.cit.gvsig.fmap.core.v02.FGraphicUtilities;

import com.iver.cit.gvsig.fmap.core.v02.FSymbol;

import com.iver.cit.gvsig.fmap.layers.FLayer;

import com.iver.cit.gvsig.fmap.layers.FLayers;

import com.iver.cit.gvsig.fmap.layers.layerOperations.AlphanumericData;

import com.iver.cit.gvsig.fmap.layers.layerOperations.Classifiable;

import com.iver.cit.gvsig.fmap.rendering.ClassifiedLegendInfo;

import com.iver.cit.gvsig.gui.layout.FLayoutUtilities;

import com.iver.cit.gvsig.gui.layout.Layout;

import com.iver.cit.gvsig.gui.project.SaveException;

import com.iver.utiles.XMLEntity;

import java.awt.Color;

import java.awt.Font;

import java.awt.Graphics2D;

import java.awt.Rectangle;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import java.util.ArrayList;

/**

 * FFrame para introducir una leyenda en el Layout.

 *

 * @author Vicente Caballero Navarro

 */

public class FFrameLegend extends FFrame implements IFFrameViewDependence {

    private static final int PRESENTACION = 0;

    private static final int BORRADOR = 1;

    private int m_quality = 0;

    private int m_viewing = 0;

    private Font m_f = new Font("Monospaced", Font.PLAIN, 9);

    private FFrameView fframeview = null;

    private int num = 0;

    private int m_max;

    private int m_numLayers;

    private FLayers layers = null;

    private int dependenceIndex;

    /**

     * Rellena la calidad que se quiere aplicar.

     *

     * @param q entero que representa la calidad a aplicar.

     */

    public void setQuality(int q) {

        m_quality = q;

    }

    /**

     * Devuelve un entero que representa la calidad que est? seleccionada.

     *

     * @return tipo de calidad selccionada.

     */

    public int getQuality() {

        return m_quality;

    }

    /**

     * Devuelve un entero que representa la forma en que se actualiza la vista.

     *

     * @return forma que se actualiza la vista.

     */

    public int getViewing() {

        return m_viewing;

    }

    /**

     * Inserta una FFrameView de donde se obtiene la informaci?n de las capas

     * para generar la leyenda.

     *

     * @param f FFrameView para obtener los nombres de las capas.

     */

    public void setFFrameDependence(IFFrame f) {

        fframeview = (FFrameView) f;

    }

    /**

     * Devuelve el FFrameView utilizado para obtener la leyenda.

     *

     * @return FFrameView utilizado.

     */

    public IFFrame getFFrameDependence() {

        return fframeview;

    }

    /**

     * Rellena la forma de actualizar la vista.

     *

     * @param v entero que representa la forma de actualizar la vista.

     */

    public void setViewing(int v) {

        m_viewing = v;

    }

    /**

     * M?todo que dibuja sobre el graphics que se le pasa como par?metro, seg?n

     * la transformada afin que se debe de aplicar y el rect?ngulo que se debe

     * de dibujar.

     *

     * @param g Graphics

     * @param at Transformada afin.

     * @param rv rect?ngulo sobre el que hacer un clip.

     * @param imgBase Imagen para acelerar el dibujado.

     *

     * @throws DriverException

     */

    public void draw(Graphics2D g, AffineTransform at, Rectangle2D rv,

        BufferedImage imgBase) throws DriverException {

        Rectangle2D.Double re = getBoundingBox(at);

        g.rotate(Math.toRadians(getRotation()), re.x + (re.width / 2),

            re.y + (re.height / 2));

        if ((fframeview != null) && (fframeview.getFMap() != null)) {

            layers = fframeview.getFMap().getLayers();

        }

        m_max = 0;

        m_numLayers = 0;

        if (intersects(rv, re)) {

            if (layers == null) { //Si no se ha seleccionado ninguna vista para crear la leyenda.

                drawEmpty(g);

            } else if ((rv == null) || (getQuality() == PRESENTACION)) {

                m_numLayers = getSizeNum(layers);

                double h = re.getHeight() / m_numLayers;

                int[] n = new int[1];

                n[0] = 0;

                drawTheme(g, re, h, layers, n, Font.PLAIN);

            } else if (getQuality() == BORRADOR) { //Si se selecciona la calidad BORRADOR.

                drawDraft(g);

            }

        }

        g.rotate(Math.toRadians(-getRotation()), re.x + (re.width / 2),

            re.y + (re.height / 2));

    }

    /**

     * Dibuja el nombre u s?mbolo de la capa que se pasa como par?metro.

     *

     * @param g Graphics2D sobre el que se dibuja.

     * @param re Rectangle a rellenar.

     * @param h Altura en pixels.

     * @param layers Capa a representar.

     * @param n ?ndice de la capa a dibujar.

     * @param typeFont DOCUMENT ME!

     *

     * @throws DriverException

     */

    private void drawTheme(Graphics2D g, Rectangle2D re, double h,

        FLayers layers, int[] n, int typeFont) throws DriverException {

        //////Se recorren los layers dibujando el s?mbolo y su nombre sobre el graphics        

        for (int i = 0; i < layers.getLayersCount(); i++) {

            FLayer layer = (FLayer) layers.getLayer(i);

            if (layer.isVisible()) {

                if (layer instanceof FLayers) {

                    n[0]++;

                    float sizefont = 0;

                    double dX = 0;

                    double dY = n[0] * h;

                    double xl = (re.getX() + dX);

                    double yl = (re.getY() + dY);

                    if ((re.getHeight() / m_numLayers) < (re.getWidth() / 8)) {

                        sizefont = (float) (re.getHeight() / m_numLayers);

                    } else {

                        sizefont = (float) (re.getWidth() / (m_max * 0.7));

                    }

                    drawNameLegend(g, layer.getName(), re, sizefont,

                        (xl - (re.getWidth() / 5)), yl, h, Font.BOLD);

                    n[0]++;

                    drawTheme(g, re, h, (FLayers) layer, n, Font.ITALIC);

                    n[0]++;

                } else if (layer instanceof AlphanumericData) {

                    AlphanumericData cO = (AlphanumericData) layer;

                    if (((Classifiable) cO).getLegend() instanceof ClassifiedLegendInfo) {

                        ClassifiedLegendInfo cli = (ClassifiedLegendInfo) ((Classifiable) cO).getLegend();

                        double dX = 0;

                        double dY = n[0] * h;

                        double xl = (re.getX() + dX);

                        double yl = (re.getY() + dY);

                        float sizefont = 0;

                        if ((re.getHeight() / m_numLayers) < (re.getWidth() / 8)) {

                            sizefont = (float) (re.getHeight() / m_numLayers);

                        } else {

                            sizefont = (float) (re.getWidth() / (m_max * 0.7));

                        }

                        drawNameLegend(g, layer.getName(), re, sizefont,

                            (xl - (re.getWidth() / 5)), yl, h, typeFont);

                        n[0]++;

                        for (int j = 0; j < cli.getValues().length; j++) {

                            dY = n[0] * h;

                            xl = (re.getX() + dX);

                            yl = (re.getY() + dY);

                            String s = cli.getDescriptions()[j];

                            drawNameLegend(g, s, re, sizefont, xl, yl, h,

                                typeFont);

                            FSymbol fs2d = cli.getSymbols()[j];

                            drawSymbolLegend(g, re, xl, yl, fs2d, sizefont,

                                ((Classifiable) cO).getShapeType(), h);

                            n[0]++;

                        }

                    } else {

                        double dX = 0;

                        double dY = n[0] * h;

                        double xl = (re.getX() + dX);

                        double yl = (re.getY() + dY);

                        float sizefont = 0;

                        if ((re.getHeight() / m_numLayers) < (re.getWidth() / 8)) {

                            sizefont = (float) (re.getHeight() / m_numLayers);

                        } else {

                            sizefont = (float) (re.getWidth() / (m_max * 0.7));

                        }

                        drawNameLegend(g, layer.getName(), re, sizefont, xl,

                            yl, h, typeFont);

                        FSymbol fs2d = ((Classifiable) cO).getLegend()

                                        .getDefaultSymbol();

                        drawSymbolLegend(g, re, xl, yl, fs2d, sizefont,

                            ((Classifiable) cO).getShapeType(), h);

                        n[0]++;

                    }

                }

            }

        }

    }

    /**

     * Dibuja sobre el graphics el nombre de la capa que se pasa como

     * par?metro.

     *

     * @param g Graphics2D sobre el que dibujar.

     * @param name Nombre de la capa.

     * @param re Rect?ngulo a ocupar por el nombre.

     * @param sizefont tama?o de la fuente.

     * @param x Posici?n X.

     * @param y Posici?n Y.

     * @param h Altura.

     * @param typeFont DOCUMENT ME!

     */

    private void drawNameLegend(Graphics2D g, String name, Rectangle2D re,

        float sizefont, double x, double y, double h, int typeFont) {

        Font f = new Font("SansSerif", typeFont, (int) sizefont);

        g.setFont(f);

        g.setColor(Color.black);

        g.drawString(name, (float) (x + (re.getWidth() / 4)),

            (float) (y + (h / 2)));

    }

    /**

     * A?ade al Layout un nuevo FFrameText a partir de los par?metros de

     * entrada.

     *

     * @param layout Layout sobre el que se crea el nuevo FFrame.

     * @param name Texto.

     * @param re Rect?ngulo del FFrame.

     * @param sizefont tama?o de la fuente.

     * @param x Posici?n X.

     * @param y Posici?n Y.

     * @param h Altura.

     */

    private void toFFrameText(Layout layout, String name, Rectangle2D re,

        float sizefont, double x, double y, double h) {

        double wl = (re.getWidth() / 1.5);

        double haux = (sizefont * 0.7);

        Rectangle2D rAux = new Rectangle2D.Double(x, y, wl, haux);

        FFrameText text = new FFrameText();

        text.setFixedFontSize(true);

        text.setFontSize((int) sizefont);

        text.setBoundBox(FLayoutUtilities.toSheetRect(rAux, layout.getAT()));

        text.addText(name);

        layout.addFFrame(text, false, true);

    }

    /**

     * Dibuja sobre el Graphics2D el s?mbolo.

     *

     * @param g Graphics2D.

     * @param re Rect?ngulo a cubrir por el s?mbolo.

     * @param x Posici?n X.

     * @param y Posici?n Y.

     * @param fs2d S?mbolo a dibujar.

     * @param sizefont Tama?o de la fuente.

     * @param type Tipo de s?mbolo.

     * @param h Altura.

     */

    private void drawSymbolLegend(Graphics2D g, Rectangle2D re, double x,

        double y, FSymbol fs2d, float sizefont, int type, double h) {

        double pW = 5;

        double wl = (re.getWidth() / pW);

        double haux = (sizefont * 0.7);

        Font font = fs2d.getFont();

        if (font != null) {

            fs2d.setFont(new Font(font.getFontName(), font.getStyle(),

                    (int) (wl / 6)));

        }

        FGraphicUtilities.DrawSymbol(g, new AffineTransform(),

            new Rectangle((int) x, (int) ((y + (h / 2)) - haux), (int) wl,

                (int) haux), fs2d);

    }

    /**

     * A?ade al Layout un nuevo FFrameSymbol.

     *

     * @param layout Layout sobe el que se a?ade el FFrame.

     * @param re Rect?ngulo del FFrame.

     * @param x Posici?n X.

     * @param y Posici?n Y.

     * @param fs2d S?mbolo a a?adir.

     * @param sizefont tama?o de la fuente.

     * @param type Tipo de s?mbolo.

     * @param h Altura.

     */

    private void toFFrameSymbol(Layout layout, Rectangle2D re, double x,

        double y, FSymbol fs2d, float sizefont, int type, double h) {

        double pW = 5;

        double wl = (re.getWidth() / pW);

        double haux = (sizefont * 0.7);

        Rectangle2D rAux3 = new Rectangle2D.Double(x, ((y + (h / 2)) - haux),

                wl, haux);

        FFrameSymbol symbol = new FFrameSymbol();

        symbol.setBoundBox(FLayoutUtilities.toSheetRect(rAux3, layout.getAT()));

        symbol.setSymbol(fs2d, type);

        layout.addFFrame(symbol, false, true);

    }

    /**

     * Devuelve el n?mero total de capas incluyendo las subcapas.

     *

     * @param layers Capa a contar.

     *

     * @return N?mero de capas y subcapas.

     */

    private int getSizeNum(FLayers layers) {

        int n = 0;

        /////Aqu? hay que calcular cuantos layers y sublayers hay, para saber que distancias dejar entre uno y otro.

        ///y adem?s el tama?o de cada uno de ellos para saber que anchura dejar.

        for (int i = 0; i < layers.getLayersCount(); i++) {

            FLayer layer = (FLayer) layers.getLayer(i);

            if (layer.isVisible()) {

                if (layer.getName().length() > m_max) {

                    m_max = layer.getName().length();

                }

                if (layer instanceof FLayers) {

                    n = n + 3;

                    n += getSizeNum((FLayers) layer); //m_numLayers += getNumInLyrGroup((FLayers) layer);

                } else if (layer instanceof AlphanumericData) {

                    AlphanumericData cO = (AlphanumericData) layer;

                    n++;

                    if (((Classifiable) cO).getLegend() instanceof ClassifiedLegendInfo) {

                        ClassifiedLegendInfo cli = (ClassifiedLegendInfo) ((Classifiable) cO).getLegend();

                        for (int j = 0; j < cli.getValues().length; j++) {

                            String s = cli.getDescriptions()[j];

                            if (s.length() > m_max) {

                                m_max = s.length();

                            }

                            n++;

                        }

                    }

                }

            }

        }

        return n;

    }

    /**

     * Transforma el FFrameLegend en diferentes FFrameSymbol y FFrameText.

     *

     * @param layout Layout sobre el que a?adir los FFrame nuevos y sobre el

     *        que elimnar el FFrameLegend anterior.

     */

    public void toFFrames(Layout layout) {

        Rectangle2D rectangle = getBoundingBox(null);

        double h = rectangle.getHeight() / m_numLayers;

        FLayers lays = layers;

        toFFrames(layout, lays, rectangle, h, 0);

        layout.getFFrames().remove(this);

    }

    /**

     * Transforma el FFrameLegend en diferentes FFrameSymbol y FFrameText.

     *

     * @param layout Referencia al Layout.

     * @param lays Layers a a?adir

     * @param rectangle Rect?ngulo del FFrameLegend.

     * @param h Altura

     * @param n n?mero de Capa a?adida.

     *

     * @return n?mero de Capa a a?adir.

     */

    public int toFFrames(Layout layout, FLayers lays, Rectangle2D rectangle,

        double h, int n) {

        //////        Se recorren los layers dibujando el s?mbolo y su nombre sobre el graphics        

        for (int i = 0; i < lays.getLayersCount(); i++) {

            FLayer layer = (FLayer) lays.getLayer(i);

            if (layer.isVisible()) {

                if (layer instanceof FLayers) {

                    rectangle.setRect(rectangle.getX(),

                        rectangle.getY() + (h * n), rectangle.getWidth(),

                        rectangle.getHeight());

                    n += toFFrames(layout, lays, rectangle, h, n); //drawTheme(g, re, h, layers, n);

                } else if (layer instanceof AlphanumericData) {

                    AlphanumericData cO = (AlphanumericData) layer;

                    if (((Classifiable) cO).getLegend() instanceof ClassifiedLegendInfo) {

                        ClassifiedLegendInfo cli = (ClassifiedLegendInfo) ((Classifiable) cO).getLegend();

                        double dX = rectangle.getWidth() / 4;

                        double dY = n * h;

                        double xl = (rectangle.getX() + dX);

                        double yl = (rectangle.getY() + dY);

                        float sizefont = 0;

                        if ((rectangle.getHeight() / m_numLayers) < (rectangle.getWidth() / 8)) {

                            sizefont = (float) (rectangle.getHeight() / m_numLayers);

                        } else {

                            sizefont = (float) (rectangle.getWidth() / 8);

                        }

                        toFFrameText(layout, layer.getName(), rectangle,

                            sizefont, xl, yl + (h / 4), h);

                        n++;

                        for (int j = 0; j < cli.getValues().length; j++) {

                            dY = n * h;

                            xl = (rectangle.getX() + dX);

                            yl = (rectangle.getY() + dY);

                            String s = cli.getDescriptions()[j];

                            toFFrameText(layout, s, rectangle, sizefont, xl,

                                yl + (h / 4), h);

                            FSymbol fs2d = cli.getSymbols()[j];

                            try {

                                toFFrameSymbol(layout, rectangle,

                                    rectangle.getX(), yl, fs2d, sizefont,

                                    ((Classifiable) cO).getShapeType(), h);

                            } catch (DriverException e) {

                                e.printStackTrace();

                            }

                            n++;

                        }

                    } else {

                        double dX = rectangle.getWidth() / 4;

                        double dY = n * h;

                        double xl = (rectangle.getX() + dX);

                        double yl = (rectangle.getY() + dY);

                        float sizefont = 0;

                        if ((rectangle.getHeight() / m_numLayers) < (rectangle.getWidth() / 8)) {

                            sizefont = (float) (rectangle.getHeight() / m_numLayers);

                        } else {

                            sizefont = (float) (rectangle.getWidth() / 8);

                        }

                        toFFrameText(layout, layer.getName(), rectangle,

                            sizefont, xl, yl + (h / 4), h);

                        FSymbol fs2d = ((Classifiable) cO).getLegend()

                                        .getDefaultSymbol();

                        try {

                            toFFrameSymbol(layout, rectangle, rectangle.getX(),

                                yl, fs2d, sizefont,

                                ((Classifiable) cO).getShapeType(), h);

                        } catch (DriverException e) {

                            e.printStackTrace();

                        }

                        n++;

                    }

                }

            }

        }

        return n;

    }

    /**

     * Rellena la fuente a utilizar al dibujar los String sobre el graphics.

     *

     * @param f Font.

     */

    public void setFont(Font f) {

        m_f = f;

    }

    /**

     * Devuelve la fuente que esta utilizando.

     *

     * @return Font.

     */

    public Font getFont() {

        if (m_f != null) {

            return new Font(m_f.getFontName(), m_f.getStyle(), 9);

        }

        return null;

    }

    /**

     * @see com.iver.cit.gvsig.gui.layout.fframes.IFFrame#getXMLEntity()

     */

    public XMLEntity getXMLEntity() throws SaveException{

        XMLEntity xml = new XMLEntity();

        try{

        xml.putProperty("className", this.getClass().getName());

        xml.putProperty("m_name", m_name);

        xml.putProperty("x", getBoundBox().x);

        xml.putProperty("y", getBoundBox().y);

        xml.putProperty("w", getBoundBox().width);

        xml.putProperty("h", getBoundBox().height);

        xml.putProperty("m_Selected", m_Selected);

        xml.putProperty("type", Layout.RECTANGLELEGEND);

        xml.putProperty("m_numLayers", m_numLayers);

        xml.putProperty("m_max", m_max);

        xml.putProperty("m_quality", m_quality);

        xml.putProperty("m_viewing", m_viewing);

        xml.putProperty("fontName", m_f.getFontName());

        xml.putProperty("fontStyle", m_f.getStyle());

        xml.putProperty("tag", getTag());

        xml.putProperty("m_rotation", getRotation());

        Layout layout = fframeview.getLayout();

        IFFrame[] fframes = layout.getAllFFrames();

        for (int i = 0; i < fframes.length; i++) {

            if ((fframeview != null) &&

                    fframeview.equals(fframes[i])) {

                xml.putProperty("index", i);

            }

        }

        }catch (Exception e) {

                        throw new SaveException(e,this.getClass().getName());

                }

        return xml;

    }

    /**

     * @see com.iver.cit.gvsig.gui.layout.fframes.IFFrame#setXMLEntity(com.iver.utiles.XMLEntity,

     *      com.iver.cit.gvsig.project.Project)

     */

    public void setXMLEntity03(XMLEntity xml, Layout l) {

        if (xml.getIntProperty("m_Selected") != 0) {

            this.setSelected(true);

        } else {

            this.setSelected(false);

        }

        this.m_numLayers = xml.getIntProperty("m_numLayers");

        this.m_max = xml.getIntProperty("m_max");

        this.m_quality = xml.getIntProperty("m_quality");

        this.m_viewing = xml.getIntProperty("m_viewing");

        this.m_f = new Font(xml.getStringProperty("fontName"),

                xml.getIntProperty("fontStyle"), 9);

        ArrayList fframes = l.getFFrames();

        fframeview = (FFrameView) fframes.get(xml.getIntProperty("index"));

    }

    /**

     * @see com.iver.cit.gvsig.gui.layout.fframes.IFFrame#setXMLEntity(com.iver.utiles.XMLEntity,

     *      com.iver.cit.gvsig.project.Project)

     */

    public void setXMLEntity(XMLEntity xml) {

        if (xml.getIntProperty("m_Selected") != 0) {

            this.setSelected(true);

        } else {

            this.setSelected(false);

        }

        this.m_numLayers = xml.getIntProperty("m_numLayers");

        this.m_max = xml.getIntProperty("m_max");

        this.m_quality = xml.getIntProperty("m_quality");

        this.m_viewing = xml.getIntProperty("m_viewing");

        this.m_f = new Font(xml.getStringProperty("fontName"),

                xml.getIntProperty("fontStyle"), 9);

        setRotation(xml.getDoubleProperty("m_rotation"));

        if (xml.contains("index")) {

            dependenceIndex = xml.getIntProperty("index");

        }

    }

    /**

     * @see com.iver.cit.gvsig.gui.layout.fframes.IFFrame#getNameFFrame()

     */

    public String getNameFFrame() {

        return PluginServices.getText(this, "leyenda") + num;

    }

    /**

     * @see com.iver.cit.gvsig.gui.layout.fframes.IFFrame#print(java.awt.Graphics2D,

     *      java.awt.geom.AffineTransform)

     */

    public void print(Graphics2D g, AffineTransform at)

        throws DriverException {

        draw(g, at, null, null);

    }

    /**

     * Actualiza las dependencias que tenga este FFrame con el resto.

     *

     * @param fframes Resto de FFrames.

     */

    public void initDependence(IFFrame[] fframes) {

        fframeview = (FFrameView) fframes[dependenceIndex];

    }

}