Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3

 * 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.app.gui.styling;

import java.awt.Color;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.ItemEvent;

import java.awt.geom.Point2D;

import java.io.File;

import java.net.URL;

import java.util.ArrayList;

import java.util.List;

import javax.swing.JPanel;

import javax.swing.JPopupMenu;

import javax.swing.SpinnerNumberModel;

import javax.swing.event.ChangeEvent;

import javax.swing.event.DocumentEvent;

import javax.swing.event.DocumentListener;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.expressionevaluator.Expression;

import org.gvsig.expressionevaluator.swing.ExpressionEvaluatorSwingLocator;

import org.gvsig.expressionevaluator.swing.ExpressionEvaluatorSwingManager;

import org.gvsig.expressionevaluator.swing.ExpressionPickerController;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.swing.DALSwingLocator;

import org.gvsig.fmap.dal.swing.DataSwingManager;

import org.gvsig.fmap.mapcontext.MapContextLocator;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.IWarningSymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.SymbolDrawingException;

import org.gvsig.i18n.Messages;

import org.gvsig.symbology.SymbologyLocator;

import org.gvsig.symbology.SymbologyManager;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IPictureMarkerSymbol;

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

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

import org.gvsig.tools.swing.api.pickercontroller.ColorPickerController;

import org.gvsig.tools.swing.api.pickercontroller.FilePickerController;

import org.gvsig.tools.util.URLUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * PictureMarker allows the user to store and modify the properties that define

 * a

 * <b>picture marker symbol</b>.<p>

 * <p>

 * This functionality is carried out thanks to a tab (simple marker)which is

 * included in the panel to edit the properities of a symbol (SymbolEditor)how

 * is explained in AbstractTypeSymbolEditor.

 * <p>

 * First of all, in the above mentioned tab the user will have options to change

 * the files from where the pictures for the symbol are taken (one for the

 * symbol when it is not selected in the map and the other when it is done)

 * .<p>

 * <p>

 * Secondly, the user will have options to modify the pictures which had been

 * selected before (width and offset) .

 *

 * @see AbstractTypeSymbolEditor

 * @author gvSIG Team

 */

@SuppressWarnings("UseSpecificCatch")

public class PictureMarker

        extends AbstractTypeSymbolEditor

        implements ActionListener {

    protected static final Logger LOGGER = LoggerFactory.getLogger(PictureMarker.class);

    public static final double MARKER_IMAGE_DEFAULT_WIDTH = 18;

    protected final PictureMarkerView view = new PictureMarkerView();

    protected List<JPanel> tabs = new ArrayList<>();

    //TODO: Comentarizado hasta que mask est? acabado

//        protected Mask mask;

    private FilePickerController picturePicker;

    private FilePickerController selectedPicturePicker;

    protected ColorPickerController colorLinePicker;

    protected ExpressionPickerController xoffsetExpPicker;

    protected ExpressionPickerController yoffsetExpPicker;

    protected ExpressionPickerController rotationExpPicker;

    protected ExpressionPickerController colorExpPicker;

    private ExpressionPickerController sizeExpPicker;

    public PictureMarker(SymbolEditor owner) {

        super(owner);

        initComponents();

    }

    private void translate() {

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        toolsSwingManager.translate(view.lblLabelFileName);

        toolsSwingManager.translate(view.lblLabelRotationExpression);

        toolsSwingManager.translate(view.lblLabelSelFileName);

        toolsSwingManager.translate(view.lblLabelSize);

        toolsSwingManager.translate(view.lblLabelRotation);

        toolsSwingManager.translate(view.lblLabelX);

        toolsSwingManager.translate(view.lblLabelXExpression);

        toolsSwingManager.translate(view.lblLabelY);

        toolsSwingManager.translate(view.lblLabelYExpression);

        toolsSwingManager.translate(view.chkDrawLineToOffset);

        toolsSwingManager.translate(view.lblColorLine);

        toolsSwingManager.translate(view.lblLabelSizeExpression);

        toolsSwingManager.translate(view.lblLabelXExpression);

        toolsSwingManager.translate(view.lblLabelYExpression);

        toolsSwingManager.translate(view.lblLabelRotationExpression);

        toolsSwingManager.translate(view.lblColorLineExpression);

    }

    /**

     * Initializes the parameters that define a picturmarker.To do it, a tab is

     * created inside the SymbolEditor panel with default values for the

     * different attributes of the picture marker.

     */

    protected void initComponents() {

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        ExpressionEvaluatorSwingManager expressionSwingManager = ExpressionEvaluatorSwingLocator.getManager();

        this.translate();

        this.picturePicker = toolsSwingManager.createFilePickerController(

                view.txtPictureFile, 

                view.btnPictureFile, 

                null, 

                "PictureMarkerFiles", 

                null, 

                true

        );

        JPopupMenu menu = view.txtPictureFile.getComponentPopupMenu();

        menu.add(expressionSwingManager.createJExpressionBuilderAction(view.txtPictureFile));

        menu.add(expressionSwingManager.createUniqueTemporalFileAction(view.txtPictureFile,"picture",".png"));

        this.selectedPicturePicker = toolsSwingManager.createFilePickerController(

                view.txtSelPictureFile, 

                view.btnSelPictureFile,

                null, 

                "PictureMarkerFiles", 

                null, 

                true

        );

        menu = view.txtSelPictureFile.getComponentPopupMenu();

        menu.add(expressionSwingManager.createJExpressionBuilderAction(view.txtSelPictureFile));

        menu.add(expressionSwingManager.createUniqueTemporalFileAction(view.txtSelPictureFile,"picture",".png"));

        this.picturePicker.addChangeListener((ChangeEvent e) -> {

            if (this.picturePicker.get() == null) {

                this.selectedPicturePicker.setEnabled(false);

            }

        });

        view.txtSize.setModel(new SpinnerNumberModel(5, 0d, Double.POSITIVE_INFINITY, 0.5));

        view.txtRotation.setModel(new SpinnerNumberModel(0, 0d, 360d, 0.5));

        view.txtX.setModel(new SpinnerNumberModel(0, Integer.MIN_VALUE, Integer.MAX_VALUE, 1));

        view.txtY.setModel(new SpinnerNumberModel(0, Integer.MIN_VALUE, Integer.MAX_VALUE, 1));

        this.colorLinePicker = toolsSwingManager.createColorPickerController(view.txtColorLine, view.btnColorLine);

        view.txtSizeExp.getDocument().addDocumentListener(new DocumentListener() {

            @Override

            public void insertUpdate(DocumentEvent e) {

                doSizeExpChange();

            }

            @Override

            public void removeUpdate(DocumentEvent e) {

                doSizeExpChange();

            }

            @Override

            public void changedUpdate(DocumentEvent e) {

                doSizeExpChange();

            }

        });

        this.sizeExpPicker = expressionSwingManager.createExpressionPickerController(

                view.txtSizeExp, 

                view.btnSizeExpression, 

                view.btnSizeExpressionBookmarks, 

                view.btnSizeExpressionHistory

        );

        this.xoffsetExpPicker = expressionSwingManager.createExpressionPickerController(

                view.txtXOffset, 

                view.btnXOffsetExpression, 

                view.btnXOffsetExpressionBookmarks, 

                view.btnXOffsetExpressionHistory

        );

        this.yoffsetExpPicker = expressionSwingManager.createExpressionPickerController(

                view.txtYOffset, 

                view.btnYOffsetExpression, 

                view.btnYOffsetExpressionBookmarks, 

                view.btnYOffsetExpressionHistory

        );

        this.rotationExpPicker = expressionSwingManager.createExpressionPickerController(

                view.txtRotationExp, 

                view.btnRotationExpression, 

                view.btnRotationExpressionBookmarks, 

                view.btnRotationExpressionHistory

        );

        this.colorExpPicker = expressionSwingManager.createExpressionPickerController(

                view.txtColorLineExp, 

                view.btnColorLineExpression, 

                view.btnColorLineExpressionBookmarks, 

                view.btnColorLineExpressionHistory

        );

        this.picturePicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.selectedPicturePicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.txtSize.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.txtRotation.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.txtX.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.txtY.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.colorLinePicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.chkDrawLineToOffset.addItemListener((ItemEvent e) -> {

            fireSymbolChangedEvent();

        });

        this.sizeExpPicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.xoffsetExpPicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.yoffsetExpPicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.rotationExpPicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        this.colorExpPicker.addChangeListener((ChangeEvent e) -> {fireSymbolChangedEvent();});

        view.setName(this.getName());

        tabs.add(view);

    }

    private void doSizeExpChange() {

        String txt = this.view.txtSizeExp.getText();

        this.view.txtSize.setEnabled(StringUtils.isBlank(txt));

    }

    @Override

    public ISymbol getLayer() {

        try {

            IPictureMarkerSymbol layer = null;

            if (this.getPictureFile()!=null ) {

                SymbologyManager symbologyManager = SymbologyLocator.getSymbologyManager();

                layer = symbologyManager.createPictureMarkerSymbol(

                        this.getPictureURL(), 

                        this.getSelectedPictureURL()

                );

                layer.setFeature(this.getSampleFeature());

                layer.setSize(getSize());

                layer.setOffset(new Point2D.Double(getX(),getY()));

                layer.setLineToOffsetColor(getLineToOffsetColor());

                layer.setDrawLineToOffset(isSelectedDrawLineToOffset());

                layer.setRotation(Math.toRadians(getRotation()));

                layer.setLineToOffsetColorExpression(getPhrase(getLineToOffsetColorExpression()));

                layer.setOffsetXExpression(getPhrase(getXOffsetExpression()));

                layer.setOffsetYExpression(getPhrase(getYOffsetExpression()));

                layer.setRotationExpression(getPhrase(getRotationExpression()));

                layer.setSizeExpression(getPhrase(getSizeExpression()));

            }

            return layer;

        } catch (Exception e) {

            IWarningSymbol warning

                    = (IWarningSymbol) MapContextLocator.getSymbolManager()

                            .getWarningSymbol(

                                    SymbolDrawingException.STR_UNSUPPORTED_SET_OF_SETTINGS,

                                    Messages.getText("failed_acessing_files"),

                                    SymbolDrawingException.UNSUPPORTED_SET_OF_SETTINGS);

            return warning;

        }

    }

    protected Color getLineToOffsetColor() {

        return this.colorLinePicker.get();

    }

    protected boolean isSelectedDrawLineToOffset() {

        return view.chkDrawLineToOffset.isSelected();

    }

    protected Expression getSizeExpression() {

        return this.sizeExpPicker.get();

    }

    protected Expression getYOffsetExpression() {

        return this.yoffsetExpPicker.get();

    }

    protected Expression getLineToOffsetColorExpression() {

        return this.colorExpPicker.get();

    }

    protected Expression getXOffsetExpression() {

        return this.xoffsetExpPicker.get();

    }

    protected Expression getRotationExpression() {

        return this.rotationExpPicker.get();

    }

    private String getPhrase(Expression expression){

        if(expression == null){

            return null;

        }

        return expression.getPhrase();

    }

    @Override

    public String getName() {

        return Messages.getText("picture_marker_symbol");

    }

    @Override

    public JPanel[] getTabs() {

        return tabs.toArray(new JPanel[tabs.size()]);

    }

    @Override

    public void refreshControls(ISymbol layer) {

        try {

            if (layer == null) {

                setValues(1d, 0d, 0d, null, null, "", "", "", null, "", "", false);

            } else {

                IPictureMarkerSymbol sym = (IPictureMarkerSymbol) layer;

                setValues(

                        sym.getSize(), 

                        sym.getRotation(), 

                        sym.getOffset().getX(), 

                        sym.getOffset().getY(), 

                        sym.getSource(), 

                        sym.getSelectedSource(),

                        sym.getSizeExpression(),

                        sym.getOffsetXExpression(),

                        sym.getOffsetYExpression(),

                        sym.getLineToOffsetColor(),

                        sym.getLineToOffsetColorExpression(),

                        sym.getRotationExpression(),

                        sym.isDrawLineToOffset()

                );

                fireSymbolChangedEvent();

            }

        } catch (Exception ex) {

            LOGGER.warn("Can't refresh picture marker symbol panel.", ex);

        }

    }

    protected void setValues(

            double size, 

            double xOffset, 

            double yOffset, 

            URL picture, 

            URL selectedPicture, 

            String sizeExpression,

            String offsetXExpression, 

            String offsetYExpression, 

            Color lineToOffsetColor, 

            String lineToOffsetColorExpression, 

            String rotationExpression,

            boolean isDrawLineToOffset) {

        setValues(size, 0d, xOffset, yOffset, picture, selectedPicture, sizeExpression, offsetXExpression, offsetYExpression, lineToOffsetColor, lineToOffsetColorExpression, rotationExpression, isDrawLineToOffset);

    }

    protected void setValues(

            double size,

            double rotation,

            double xOffset, 

            double yOffset, 

            URL picture, 

            URL selectedPicture, 

            String sizeExpression,

            String offsetXExpression, 

            String offsetYExpression, 

            Color lineToOffsetColor, 

            String lineToOffsetColorExpression, 

            String rotationExpression,

            boolean isDrawLineToOffset) {

        setSize(size);

        setRotation(Math.toDegrees(rotation));

        setX(xOffset);

        setY(yOffset);

        setPicture(picture);

        setSelectedPicture(selectedPicture);

        sizeExpPicker.coerceAndSet(sizeExpression);

        xoffsetExpPicker.coerceAndSet(offsetXExpression);

        yoffsetExpPicker.coerceAndSet(offsetYExpression);

        rotationExpPicker.coerceAndSet(rotationExpression);

        colorLinePicker.coerceAndSet(lineToOffsetColor);

        colorExpPicker.coerceAndSet(lineToOffsetColorExpression);

        view.chkDrawLineToOffset.setSelected(isDrawLineToOffset);

    }

    @Override

    public EditorTool[] getEditorTools() {

        return null;

    }

    @Override

    public void actionPerformed(ActionEvent e) {

    }

    @Override

    public boolean canManageSymbol(ISymbol symbol) {

        return symbol instanceof IPictureMarkerSymbol;

    }

    protected String getPictureFileName() {

        File f = this.picturePicker.get();

        if( f == null ) {

            return null;

        }

        return f.getAbsolutePath();

    }

    protected String getSelectedPictureFileName() {

        File f = this.selectedPicturePicker.get();

        if( f == null ) {

            return null;

        }

        return f.getAbsolutePath();

    }

    protected URL getPictureURL() {

        return URLUtils.toURL(this.picturePicker.get());

    }

    protected URL getSelectedPictureURL() {

        return URLUtils.toURL(this.selectedPicturePicker.get());

    }

    protected File getPictureFile() {

        File f = this.picturePicker.get();

        return f;

    }

    protected File getSelectedPictureFile() {

        File f = this.selectedPicturePicker.get();

        return f;

    }

    protected double getSize() {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtSize.getModel();

        return model.getNumber().doubleValue();

    }

    protected double getRotation() {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtRotation.getModel();

        return model.getNumber().doubleValue();

    }

    protected double getX() {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtX.getModel();

        return model.getNumber().doubleValue();

    }

    protected double getY() {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtY.getModel();

        return model.getNumber().doubleValue();

    }

    protected void setPicture(URL picture) {

        this.picturePicker.set(URLUtils.toFile(picture));

    }

    protected void setSelectedPicture(URL selectedPicture) {

       this.selectedPicturePicker.set(URLUtils.toFile(selectedPicture));

    }

    protected void setSize(double d) {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtSize.getModel();

        model.setValue(d);

    }

    protected void setRotation(double degrees) {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtRotation.getModel();

        model.setValue(degrees);

    }

    protected void setX(double d) {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtX.getModel();

        model.setValue(d);

    }

    protected void setY(double d) {

        SpinnerNumberModel model = (SpinnerNumberModel) view.txtY.getModel();

        model.setValue(d);

    }

    protected Color getColorLine() {

        return this.colorLinePicker.get();

    }

    protected void setColorLine(Color color) {

        this.colorLinePicker.set(color);

    }

    @Override

    public void setFeatureStore(FeatureStore store) {

        if( store==null ) {

            return;

        }

        super.setFeatureStore(store); 

        DataSwingManager dataSwingManager = DALSwingLocator.getDataSwingManager();

        dataSwingManager.configureExpressionBuilder(this.xoffsetExpPicker.getConfig(), store);

        dataSwingManager.configureExpressionBuilder(this.yoffsetExpPicker.getConfig(), store);

        dataSwingManager.configureExpressionBuilder(this.rotationExpPicker.getConfig(), store);

    }

}