Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * 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.tools.dynform.spi.dynformfield;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.FocusListener;

import java.awt.event.ItemEvent;

import java.awt.event.KeyAdapter;

import java.awt.event.KeyEvent;

import java.util.Objects;

import javax.swing.BorderFactory;

import javax.swing.ComboBoxModel;

import javax.swing.DefaultComboBoxModel;

import javax.swing.JComboBox;

import javax.swing.JLabel;

import javax.swing.JSpinner;

import javax.swing.JTextField;

import javax.swing.UIManager;

import javax.swing.event.ChangeEvent;

import javax.swing.event.DocumentEvent;

import javax.swing.event.DocumentListener;

import javax.swing.text.JTextComponent;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.dataTypes.DataType;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynform.DynFormFieldDefinition;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.spi.DynFormSPIManager;

import org.gvsig.tools.dynform.spi.DynFormSPIManager.ComponentsFactory;

import static org.gvsig.tools.dynform.spi.DynFormSPIManager.TAG_DYNFORM_DROPDOWN;

import org.gvsig.tools.dynform.spi.dynformfield.AbstractJDynFormField.IllegalFieldValue;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynField_v2;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectValueItem;

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

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

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

public abstract class AbstractJDynFormFieldWithValueList extends AbstractJDynFormField implements JDynFormField, FocusListener {

    protected Object assignedValue = null;

    protected DropDown dropDown = null;

    public AbstractJDynFormFieldWithValueList(

            DynFormSPIManager serviceManager,

            ComponentsFactory componentsFactory,

            JDynFormFieldFactory factory,

            DynFormFieldDefinition definition,

            Object value

    ) {

        super(serviceManager, componentsFactory, factory, definition, value);

        this.assignedValue = value;

    }

    @Override

    public Object getAssignedValue() {

        return this.assignedValue;

    }

    protected JTextField getJTextField() {

        if (this.contents instanceof JTextField) {

            return (JTextField) this.contents;

        }

        return null;

    }

    protected JSpinner getJSpinnerField() {

        if (this.contents instanceof JSpinner) {

            return (JSpinner) this.contents;

        }

        return null;

    }

    protected DropDown getDropDown() {

        return this.dropDown;

    }

    protected DynObjectValueItem[] getAvailableValues() {

        DynFormFieldDefinition theDefinition = this.getDefinition();

        if( theDefinition == null ) {

            return null;

        }

        if(  theDefinition instanceof DynField_v2 ) {

            DynObject context = this.getForm().getDefinition().createElement();

            DynField[] fields = context.getDynClass().getDynFields();

            for (DynField field : fields) {

                String name = field.getName();

                JDynFormField jfield = (JDynFormField) this.getForm().getField(name);

                if (jfield != null ) {

                    try {

                        jfield.fetch(context);

                    } catch (Exception ex) {

//                        LOGGER.warn("Can't get value of field '" + name + "'.", ex);

                          // No deberia ser un error. Estamos cogiendo los valores

                          // del formulario para rellenar otros campos, puede

                          // que aun no se hayan rellenado valores obligatorios

                          // en el formulario.

                    }

                }

            }

            return theDefinition.getAvailableValues(context);

        }

        return theDefinition.getAvailableValues();

    }

    @Override

    public void initComponent() {

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        ComponentsFactory theFactory = this.getComponentsFactory();

        if (theFactory.containsJComboBox(this.getDefinition(), null)) {

            JComboBox combo = this.getComponentsFactory().getJComboBox(this.getDefinition(), null);

            this.dropDown = ToolsSwingLocator.getToolsSwingManager().createDropDown(combo);

            if( this.getDefinition().isAvailableValuesCalculated() ) {

                this.dropDown.addDropdownListener((ActionEvent e) -> {

                    dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                });

            } else {

                this.dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

            }

            this.contents = combo;

            this.fixPreferredWidth(this.contents);

            this.dropDown.addItemListener((ItemEvent e) -> {

                if (e.getStateChange() == ItemEvent.SELECTED) {

                    fireFieldChangedEvent();

                }

            });

        } else if (theFactory.containsJLabel(this.getDefinition(), "Ddn")) {

            JLabel label = this.getComponentsFactory().getJLabel(this.getDefinition(), "Ddn");

            this.dropDown = ToolsSwingLocator.getToolsSwingManager().createDropDown(label);

            if( this.getDefinition().isAvailableValuesCalculated() ) {

                this.dropDown.addDropdownListener((ActionEvent e) -> {

                    dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                });

            } else {

                this.dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

            }

            this.dropDown.setVisibleDropdownArrow(true);

            this.contents = label;

            this.fixPreferredWidth(this.contents);

            this.dropDown.addItemListener((ItemEvent e) -> {

                if (e.getStateChange() == ItemEvent.SELECTED) {

                    fireFieldChangedEvent();

                }

            });

        } else if (theFactory.containsJSpinner(this.getDefinition(), null)) {

            JSpinner spinner = this.getComponentsFactory().getJSpinner(this.getDefinition(), null);

            DataType dataType = this.getDefinition().getDataType();

            if (dataType.isNumeric()) {

                spinner = ToolsSwingLocator.getToolsSwingManager().spinnerOfNumber(spinner, dataType.getDefaultClass());

            } else if (this.getDefinition().getDataType().getType()==DataTypes.TIME) {

                spinner = ToolsSwingLocator.getToolsSwingManager().spinnerOfTime(spinner, null);

            } 

            this.contents = spinner;

            this.fixPreferredWidth(this.contents);

            this.dropDown = null;

            spinner.addChangeListener((ChangeEvent e) -> {

                fireFieldChangedEvent();

            });

        } else if (theFactory.containsJTextField(this.getDefinition(), null)) {

            JTextComponent text = theFactory.getJTextField(this.getDefinition(), null);

            this.contents = text;

            toolsSwingManager.addClearButton(text);

            this.fixPreferredWidth(this.contents);

            this.dropDown = null;

            text.getDocument().addDocumentListener(new DocumentListener() {

                @Override

                public void insertUpdate(DocumentEvent e) {

                    fireFieldChangedEvent();

                }

                @Override

                public void removeUpdate(DocumentEvent e) {

                    fireFieldChangedEvent();

                }

                @Override

                public void changedUpdate(DocumentEvent e) {

                    fireFieldChangedEvent();

                }

            });

        } else {

            DynObjectValueItem[] availableValues = this.getAvailableValues();

            if (availableValues == null) {

                this.dropDown = null;

                JTextComponent text = this.getComponentsFactory().getJTextField(this.getDefinition(), null);

                this.contents = text;

                toolsSwingManager.addClearButton(text);

                this.fixPreferredWidth(this.contents);

                text.getDocument().addDocumentListener(new DocumentListener() {

                    @Override

                    public void insertUpdate(DocumentEvent e) {

                        fireFieldChangedEvent();

                    }

                    @Override

                    public void removeUpdate(DocumentEvent e) {

                        fireFieldChangedEvent();

                    }

                    @Override

                    public void changedUpdate(DocumentEvent e) {

                        fireFieldChangedEvent();

                    }

                });

            } else {

                String dropdownType = this.getTagValueAsString(TAG_DYNFORM_DROPDOWN,

                        availableValues.length <= 20 ? "label" : "combo"

                ).toLowerCase().trim();

                switch (dropdownType) {

                    case "label": {

                        JLabel label = this.getComponentsFactory().getJLabel(this.getDefinition(), "Ddn");

                        this.dropDown = ToolsSwingLocator.getToolsSwingManager().createDropDown(label);

                        this.dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                        if( this.getDefinition().isAvailableValuesCalculated() ) {

                            this.dropDown.addDropdownListener((ActionEvent e) -> {

                                dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                            });

                        }

                        this.dropDown.setVisibleDropdownArrow(true);

                        label.setBorder(BorderFactory.createLineBorder(UIManager.getColor("TextField.darkShadow")));

                        label.setForeground(UIManager.getColor("TextField.foreground"));

                        label.setBackground(UIManager.getColor("TextField.background"));

                        label.setOpaque(true);

                        this.contents = label;

                        this.fixPreferredWidth(this.contents);

                        break;

                    }

                    default:

                    case "combo": {

                        JComboBox combo = this.getComponentsFactory().getJComboBox(this.getDefinition(), null);

                        this.dropDown = ToolsSwingLocator.getToolsSwingManager().createDropDown(combo);

                        this.dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                        if( this.getDefinition().isAvailableValuesCalculated() ) {

                            this.dropDown.addDropdownListener((ActionEvent e) -> {

                                dropDown.setModel(new DefaultComboBoxModel(this.getAvailableValues()));

                            });

                        }

                        this.contents = combo;

                        this.fixPreferredWidth(this.contents);

                        break;

                    }

                }

                this.dropDown.addItemListener((ItemEvent e) -> {

                    if (e.getStateChange() == ItemEvent.SELECTED) {

                        fireFieldChangedEvent();

                    }

                });

            }

        }

        this.contents.addFocusListener(this);

        this.setReadOnly(readOnly); // Forzamos a actualiza rel estado del component

        //component dont have support to set null values

        this.setValue(this.assignedValue);

    }

    @Override

    public void setReadOnly(boolean readonly) {

        if (!readonly && this.isForcedReadOnly()) {

            readonly = true;

        }

        if (this.dropDown == null) {

            super.setReadOnly(readonly);

        } else {

            this.readOnly = readonly;

            if (jlabel != null) {

                this.jlabel.setEnabled(!readonly);

            }

            this.dropDown.setReadOnly(readonly);

        }

    }

    protected String getValueFromJComponent() {

        String s;

        if (this.dropDown == null) {

            JTextField jtext = this.getJTextField();

            if (jtext == null) {

                s = null;

            } else {

                s = jtext.getText();

            }

        } else {

            DynObjectValueItem value = (DynObjectValueItem) this.dropDown.getSelectedItem();

            if (value == null) {

                s = null;

            } else {

                s = Objects.toString(value.getValue(), null);

            }

        }

        if (StringUtils.isBlank(s) && this.translateEmptyToNull()) {

            return null;

        }

        return s;

    }

    @Override

    public void setValue(Object value) {

        if (this.dropDown == null) {

            JTextField jtext = this.getJTextField();

            if (jtext != null) {

                this.setTranslateEmptyToNull(value == null);

//                String s;

//                if (value == null) {

//                    this.setTranslateEmptyToNull(true);

//                    value = this.getDefinition().getDefaultValue();

//                    if (value == null) {

//                        s = this.getDefaultValue();

//                    } else {

//                        s = value.toString();

//                    }

//                } else {

//                    this.setTranslateEmptyToNull(false);

//                    s = value.toString();

//                    try {

//                        this.getDefinition().validate(value);

//                        this.problemIndicator().clear();

//                    } catch (DynFieldValidateException e) {

//                        this.problemIndicator().set(e.getLocalizedMessage());

//                    }

//                }

                jtext.setText(Objects.toString(value, ""));

                this.fixPreferredWidth(jtext);

            } else if (this.contents instanceof JSpinner) {

                JSpinner jspinner = this.getJSpinnerField();

                this.setTranslateEmptyToNull(value == null);

                jspinner.setValue(value);

            }

        } else {

            if (value == null) {

                this.dropDown.setSelectedIndex(-1);

            } else {

                this.dropDown.setValue(value);

            }

        }

        this.assignedValue = value;

    }

    /* 

         * M?todos espec?ficos de cada tipo de datos

     */

    protected String getDefaultValue() {

        return "";

    }

    @Override

    public Object getValue() {

        Object value = null;

        String s = this.getValueFromJComponent();

        try {

            value = this.getDefinition().coerce(s);

        } catch (CoercionException e) {

            throw new IllegalFieldValue(this, "Can't convert value '" + s + "' to '" + this.getDefinition().getDataType().getName() + "'.");

        }

        this.problemIndicator().clear();

        return value;

    }

    @SuppressWarnings("unused")

    @Override

    public boolean hasValidValue() {

        try {

            Object value = this.getValue();

        } catch (Exception e) {

            return false;

        }

        return true;

    }

//

// Estos metodos los he movido a la superclase.

//

//    @Override

//    public void focusGained(FocusEvent arg0) {

//        fireFieldEnterEvent();

//        this.problemIndicator().restore();

//    }

//

//    @Override

//    public void focusLost(FocusEvent arg0) {

//        if (this.hasValidValue()) {

//            this.problemIndicator().clear();

//        } else {

//            try {

//                Object value = this.getValue();

//            } catch (Exception e) {

//                this.problemIndicator().set(e.getLocalizedMessage());

//            }

//        }

//        fireFieldExitEvent();

//    }

//

    /**

     * Este m?todo es por si se quiere a?adir una expresi?n regular al

     * JTextField Por defecto, se puede escribir cualquier cosa, pero se puede

     * sobreescribir este m?todo en la clase que lo requiera para a?adir

     * restricciones (p.ej: en los num?ricos)

     *

     * @return expresi?n regular que filtra el contenido del JTextField

     */

    public String getJTextFieldRegex() {

        return "[*]";

    }

    public class KeyAdapterRegEx extends KeyAdapter {

        /**

         * Key released on field.

         *

         * @param e

         */

        @Override

        public void keyReleased(KeyEvent e) {

            String curText = ((JTextComponent) e.getSource()).getText();

            curText = curText.replaceAll(getJTextFieldRegex(), "");

            ((JTextComponent) e.getSource()).setText(curText);

        }

    }

}