GPLayerDisplayBinding.java

/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2017 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   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, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.gui.client.widget.tab.binding;

import com.extjs.gxt.ui.client.core.El;
import com.extjs.gxt.ui.client.core.XDOM;
import com.extjs.gxt.ui.client.event.ButtonEvent;
import com.extjs.gxt.ui.client.event.ComponentEvent;
import com.extjs.gxt.ui.client.event.Events;
import com.extjs.gxt.ui.client.event.Listener;
import com.extjs.gxt.ui.client.event.MessageBoxEvent;
import com.extjs.gxt.ui.client.event.SelectionListener;
import com.extjs.gxt.ui.client.event.SliderEvent;
import com.extjs.gxt.ui.client.store.ListStore;
import com.extjs.gxt.ui.client.store.Record;
import com.extjs.gxt.ui.client.widget.Component;
import com.extjs.gxt.ui.client.widget.ComponentPlugin;
import com.extjs.gxt.ui.client.widget.Dialog;
import com.extjs.gxt.ui.client.widget.Slider;
import com.extjs.gxt.ui.client.widget.button.Button;
import com.extjs.gxt.ui.client.widget.form.ComboBox;
import com.extjs.gxt.ui.client.widget.form.Field;
import com.extjs.gxt.ui.client.widget.form.FieldSet;
import com.extjs.gxt.ui.client.widget.form.FormPanel;
import com.extjs.gxt.ui.client.widget.form.NumberField;
import com.extjs.gxt.ui.client.widget.form.SliderField;
import com.extjs.gxt.ui.client.widget.layout.FlowLayout;
import com.extjs.gxt.ui.client.widget.layout.FormLayout;
import com.google.gwt.i18n.client.NumberFormat;
import com.google.gwt.user.client.ui.AbstractImagePrototype;
import java.util.logging.Level;
import org.geosdi.geoplatform.gui.client.BasicWidgetResources;
import org.geosdi.geoplatform.gui.client.config.MementoModuleInjector;
import org.geosdi.geoplatform.gui.client.i18n.LayerModuleConstants;
import org.geosdi.geoplatform.gui.client.model.RasterTreeNode;
import org.geosdi.geoplatform.gui.client.model.RasterTreeNode.GPRasterKeyValue;
import org.geosdi.geoplatform.gui.client.model.memento.save.IMementoSave;
import org.geosdi.geoplatform.gui.client.model.memento.save.storage.AbstractMementoOriginalProperties;
import org.geosdi.geoplatform.gui.client.widget.binding.GeoPlatformBindingWidget;
import org.geosdi.geoplatform.gui.client.widget.binding.field.GPSliderField;
import org.geosdi.geoplatform.gui.client.widget.form.binding.GPFieldBinding;
import org.geosdi.geoplatform.gui.client.widget.tab.DisplayLayersTabItem;
import org.geosdi.geoplatform.gui.configuration.message.GeoPlatformMessage;
import org.geosdi.geoplatform.gui.impl.map.event.MaxScaleLayerMapEvent;
import org.geosdi.geoplatform.gui.impl.map.event.MinScaleLayerMapEvent;
import org.geosdi.geoplatform.gui.impl.map.event.OpacityLayerMapEvent;
import org.geosdi.geoplatform.gui.impl.map.event.SingleTileLayerRequestMapEvent;
import org.geosdi.geoplatform.gui.model.GPBooleanBeanModel;
import org.geosdi.geoplatform.gui.model.GPRasterBean;
import org.geosdi.geoplatform.gui.model.tree.GPLayerTreeModel;
import org.geosdi.geoplatform.gui.puregwt.GPHandlerManager;

/**
 *
 * @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
 * @email giuseppe.lascaleia@geosdi.org
 */
public class GPLayerDisplayBinding extends GeoPlatformBindingWidget<GPRasterBean> {

    private NumberField maxScale;
    private NumberField minScale;
    private Slider slider;
    private GPSliderField sliderField;
    private GPRasterOpacityFieldBinding opacityFieldBinding;
    private GPRasterMaxScaleFieldBinding maxScaleFieldBinding;
    private GPRasterMinScaleFieldBinding minScaleFieldBinding;
    private final OpacityLayerMapEvent opacityEvent = new OpacityLayerMapEvent();
    private final MaxScaleLayerMapEvent maxScaleEvent = new MaxScaleLayerMapEvent();
    private final MinScaleLayerMapEvent minScaleEvent = new MinScaleLayerMapEvent();
    private ComboBox<GPBooleanBeanModel> singleTileComboBox;
    private ListStore<GPBooleanBeanModel> singleTileComboBoxStore;
    private GPRasterComboSingleTileRequestBinding singleTileRequestBinding;

    @Override
    public FormPanel createFormPanel() {
        FormPanel fp = new FormPanel();
        fp.setHeaderVisible(false);
        fp.setFrame(true);
        fp.setLayout(new FlowLayout());

        setSliderProperties();

        this.maxScale = new NumberField() {

            @Override
            public void setValue(Number value) {
                super.setValue(value);
                if (value != null) {
                    NumberFormat nf = NumberFormat.getDecimalFormat();
                    String formattedValue = nf.format(value.floatValue()).replaceAll(",", "");
                    maxScale.setRawValue(formattedValue);
                    logger.log(Level.INFO, "Updating maxScale field: " + formattedValue);
                }
            }
        };
        this.maxScale.setPropertyEditorType(Float.class);
        this.maxScale.setFieldLabel(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_maxScaleNumberFieldText());

        this.minScale = new NumberField() {

            @Override
            public void setValue(Number value) {
                super.setValue(value);
                if (value != null) {
                    NumberFormat nf = NumberFormat.getDecimalFormat();
                    String formattedValue = nf.format(value.floatValue()).replaceAll(",", "");
                    minScale.setRawValue(formattedValue);
                    logger.log(Level.INFO, "Updating minScale field: " + formattedValue);
                }
            }
        };
        this.minScale.setPropertyEditorType(Float.class);
        this.minScale.setFieldLabel(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_minScaleNumberFieldText());
        Button removeScale = new Button(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_removeLimitsButtonText(),
                AbstractImagePrototype.create(BasicWidgetResources.ICONS.delete()),
                new SelectionListener<ButtonEvent>() {

                    @Override
                    public void componentSelected(ButtonEvent ce) {
                        GeoPlatformMessage.confirmMessage(
                                LayerModuleConstants.INSTANCE.
                                GPLayerDisplayBinding_removeLimitsMessageTitleText(),
                                LayerModuleConstants.INSTANCE.
                                GPLayerDisplayBinding_removeLimitsMessageBodyText(),
                                new Listener<MessageBoxEvent>() {
                                    @Override
                                    public void handleEvent(MessageBoxEvent be) {
                                        if (Dialog.YES.equals(be.getButtonClicked().getItemId())) {
                                            removeScaleLimits();
                                        }
                                    }
                                });
                    }
                });

        final FieldSet scaleFieldSet = new FieldSet();
        scaleFieldSet.setLayout(new FormLayout());
        scaleFieldSet.setHeadingHtml(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_limitsByScaleFieldText());
        scaleFieldSet.add(maxScale);
        scaleFieldSet.add(minScale);
        scaleFieldSet.add(removeScale);

        final FieldSet opacityFieldSet = new FieldSet();
        opacityFieldSet.setHeadingHtml(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_opacityHeadingText());
        opacityFieldSet.setCollapsible(true);

        opacityFieldSet.addListener(Events.Collapse,
                new Listener<ComponentEvent>() {

                    @Override
                    public void handleEvent(ComponentEvent be) {
                        ((DisplayLayersTabItem) opacityFieldSet.getParent().getParent()).updateWindowSize();
                    }

                });

        sliderField = new GPSliderField(this.slider);
        sliderField.setName(GPRasterKeyValue.OPACITY.toString());

        sliderField.removeAllListeners();

        opacityFieldSet.add(sliderField);

        final FieldSet singleTileFieldSet = new FieldSet();
        singleTileFieldSet.setHeadingHtml(LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_singleTileRequestHeadingText());

        this.singleTileComboBox = new ComboBox<GPBooleanBeanModel>() {
            @Override
            protected void onSelect(GPBooleanBeanModel model, int index) {
                super.onSelect(model, index);
                singleTileRequestBinding.updateModel();
            }
        };
        this.singleTileComboBoxStore = new ListStore<GPBooleanBeanModel>();
        this.singleTileComboBoxStore.add(GPBooleanBeanModel.getBooleanInstances());
        this.singleTileComboBox.setStore(this.singleTileComboBoxStore);
        this.singleTileComboBox.setWidth(200);
//        this.singleTileComboBox.setEmptyText();
        this.singleTileComboBox.setTypeAhead(true);
        this.singleTileComboBox.setTriggerAction(ComboBox.TriggerAction.ALL);
        this.singleTileComboBox.setDisplayField(GPBooleanBeanModel.GPBooleanKeyValue.Boolean.getValue());
        singleTileFieldSet.add(this.singleTileComboBox);

        fp.add(scaleFieldSet);
        fp.add(opacityFieldSet);
        fp.add(singleTileFieldSet);

        this.singleTileRequestBinding = new GPRasterComboSingleTileRequestBinding(
                this.singleTileComboBox, GPBooleanBeanModel.GPBooleanKeyValue.Boolean.getValue());

        return fp;
    }

    @Override
    public void bindModel(GPRasterBean model) {
        super.bindModel(model);
        RasterTreeNode raster = (RasterTreeNode) model;
        this.singleTileComboBox.setValue(GPBooleanBeanModel.getBooleanInstance(raster.isSingleTileRequest()));
    }

    private void removeScaleLimits() {
        //Copying the value on memento before changes
        IMementoSave mementoSave = MementoModuleInjector.MainInjector.getInstance().getMementoSave();
        AbstractMementoOriginalProperties memento = mementoSave.copyOriginalProperties(
                (GPLayerTreeModel) GPLayerDisplayBinding.this.getModel());
        Float scaleValue = null;
        ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).
                setMaxScale(null);
        ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).
                setMinScale(null);
        mementoSave.putOriginalPropertiesInCache(memento);
        maxScaleEvent.setLayer((GPRasterBean) GPLayerDisplayBinding.this.getModel());
        maxScaleEvent.setMaxScale(scaleValue);
        GPHandlerManager.fireEvent(maxScaleEvent);
        minScaleEvent.setLayer((GPRasterBean) GPLayerDisplayBinding.this.getModel());
        minScaleEvent.setMinScale(scaleValue);
        GPHandlerManager.fireEvent(minScaleEvent);

        this.maxScale.clear();
        this.minScale.clear();
    }

    @Override
    public void addFieldsBinding() {
        this.opacityFieldBinding = new GPRasterOpacityFieldBinding(sliderField,
                GPRasterKeyValue.OPACITY.toString());
        this.maxScaleFieldBinding = new GPRasterMaxScaleFieldBinding(this.maxScale,
                GPRasterKeyValue.MAX_SCALE.toString());
        this.minScaleFieldBinding = new GPRasterMinScaleFieldBinding(this.minScale,
                GPRasterKeyValue.MIN_SCALE.toString());
        this.formBinding.addFieldBinding(this.opacityFieldBinding);
        this.formBinding.addFieldBinding(this.maxScaleFieldBinding);
        this.formBinding.addFieldBinding(this.minScaleFieldBinding);
        this.formBinding.addFieldBinding(this.singleTileRequestBinding);
    }

    /**
     * Create and set Slider Properties
     *
     */
    private void setSliderProperties() {
        this.slider = new Slider();
        slider.setMaxValue(100);

        slider.addPlugin(createSliderPlugin());

        slider.setMessage("{0}% " + LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_sliderMessageText());

        slider.addListener(Events.Change, new Listener<SliderEvent>() {

            @Override
            public void handleEvent(SliderEvent be) {
                opacityFieldBinding.setModelProperty(be.getNewValue());
            }

        });

        slider.setData("text", LayerModuleConstants.INSTANCE.
                GPLayerDisplayBinding_sliderDataText());
    }

    /**
     * Create Plugin for Slider
     *
     * @return ComponentPlugin
     */
    private ComponentPlugin createSliderPlugin() {
        ComponentPlugin plugin = new ComponentPlugin() {

            @Override
            public void init(Component component) {
                component.addListener(Events.Render,
                        new Listener<ComponentEvent>() {

                            @Override
                            public void handleEvent(ComponentEvent be) {
                                El elem = sliderField.el();
                                // should style in external CSS  rather than directly  
                                elem.appendChild(XDOM.create(
                                                "<div style='color: #615f5f;padding: 1 0 2 0px;'>"
                                                + slider.getData("text") + "</div>"));
                            }

                        });
            }

        };

        return plugin;
    }

    /**
     * @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
     * @email giuseppe.lascaleia@geosdi.org
     *
     * Internal Class GPLayerAliasFieldBinding to map bi-directional Binding
     *
     */
    private class GPRasterOpacityFieldBinding extends GPFieldBinding {

        public GPRasterOpacityFieldBinding(SliderField field, String property) {
            super(field, property);
        }

        @Override//From view to model
        public void setModelProperty(Object val) {
            //Copying the value on memento before changes
            IMementoSave mementoSave = MementoModuleInjector.MainInjector.getInstance().getMementoSave();
            AbstractMementoOriginalProperties memento = mementoSave.copyOriginalProperties(
                    (GPLayerTreeModel) GPLayerDisplayBinding.this.getModel());
            ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).
                    setOpacity(((Integer) val).floatValue() / 100);
            mementoSave.putOriginalPropertiesInCache(memento);
            opacityEvent.setLayerBean(
                    (GPRasterBean) GPLayerDisplayBinding.this.getModel());
            GPHandlerManager.fireEvent(opacityEvent);
        }

        /**
         * Updates the field's value and original value with the model value.
         * Updating the original value will reset the field to a non-dirty
         * state.
         *
         * @param updateOriginalValue true to update the original value
         */
        @Override//From model to view
        public void updateField(boolean updateOriginalValue) {
            Float opacity = new Float(
                    ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).getOpacity() * 100);
            ((SliderField) field).setValue(opacity.intValue());
        }

        @Override
        public void setRecordProperty(Record r, Object val) {
        }

    }

    private class GPRasterMaxScaleFieldBinding extends GPFieldBinding {

        public GPRasterMaxScaleFieldBinding(NumberField field, String property) {
            super(field, property);
        }

        @Override//From view to model
        public void setModelProperty(Object val) {
            //Copying the value on memento before changes
            IMementoSave mementoSave = MementoModuleInjector.MainInjector.getInstance().getMementoSave();
            AbstractMementoOriginalProperties memento = mementoSave.copyOriginalProperties(
                    (GPLayerTreeModel) GPLayerDisplayBinding.this.getModel());
            Float scaleValue = val != null ? ((Float) val).floatValue() : null;
            ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).
                    setMaxScale(scaleValue);
            mementoSave.putOriginalPropertiesInCache(memento);
            maxScaleEvent.setLayer((GPRasterBean) GPLayerDisplayBinding.this.getModel());
            maxScaleEvent.setMaxScale(scaleValue);
            GPHandlerManager.fireEvent(maxScaleEvent);
        }

        @Override
        public void setRecordProperty(Record r, Object val) {
        }

    }

    private class GPRasterMinScaleFieldBinding extends GPFieldBinding {

        public GPRasterMinScaleFieldBinding(NumberField field, String property) {
            super(field, property);
        }

        @Override//From view to model
        public void setModelProperty(Object val) {
            //Copying the value on memento before changes
            IMementoSave mementoSave = MementoModuleInjector.MainInjector.getInstance().getMementoSave();
            AbstractMementoOriginalProperties memento = mementoSave.copyOriginalProperties(
                    (GPLayerTreeModel) GPLayerDisplayBinding.this.getModel());
            Float scaleValue = val != null ? ((Float) val).floatValue() : null;
            ((GPRasterBean) GPLayerDisplayBinding.this.getModel()).
                    setMinScale(scaleValue);
            mementoSave.putOriginalPropertiesInCache(memento);
            minScaleEvent.setLayer((GPRasterBean) GPLayerDisplayBinding.this.getModel());
            minScaleEvent.setMinScale(scaleValue);
            GPHandlerManager.fireEvent(minScaleEvent);
        }

        @Override
        public void setRecordProperty(Record r, Object val) {
        }

    }

    private class GPRasterComboSingleTileRequestBinding extends GPFieldBinding {

        //TODO: creare evento update richiesta single tile
        private SingleTileLayerRequestMapEvent singleTileLayerRequestMapEvent
                = new SingleTileLayerRequestMapEvent();

        public GPRasterComboSingleTileRequestBinding(Field field, String property) {
            super(field, property);
        }

        @Override //From model to view
        public void updateField(boolean updateOriginalValue) {
//            System.out.println("Updating view");
            RasterTreeNode raster = ((RasterTreeNode) model);
            singleTileComboBox.setValue(GPBooleanBeanModel.getBooleanInstance(raster.isSingleTileRequest()));
        }

        @Override //From view to model
        public void setModelProperty(Object val) {
//            System.out.println("Updating model");
            if (val != null && val instanceof GPBooleanBeanModel) {
                GPBooleanBeanModel booleanString = (GPBooleanBeanModel) val;
                RasterTreeNode raster = (RasterTreeNode) model;
                if (booleanString.getBooleanValue() != raster.isSingleTileRequest()) {
                    IMementoSave mementoSave = MementoModuleInjector.MainInjector.getInstance().getMementoSave();
                    AbstractMementoOriginalProperties memento = mementoSave.copyOriginalProperties(raster);
                    raster.setSingleTileRequest(booleanString.getBooleanValue());
                    mementoSave.putOriginalPropertiesInCache(memento);
                    singleTileLayerRequestMapEvent.setSingleTileRequest(booleanString.getBooleanValue());
                    singleTileLayerRequestMapEvent.setLayerBean(raster);
                    GPHandlerManager.fireEvent(singleTileLayerRequestMapEvent);
                }
            }
        }

        @Override
        public void setRecordProperty(Record r, Object val) {
        }
    }

}