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.impl;

import java.awt.Component;

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

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import javax.swing.Action;

import javax.swing.JComponent;

import javax.swing.JTabbedPane;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.dataTypes.DataType;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynform.DynFormDefinition;

import org.gvsig.tools.dynform.DynFormFieldDefinition;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.JDynFormField.JDynFormFieldListener;

import org.gvsig.tools.dynform.spi.dynformfield.SupportPopupMenu;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynField_v2;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.service.ServiceException;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.util.Collection;

import javax.swing.JLabel;

import javax.swing.JPanel;

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.tools.dynform.spi.dynformfield.JDynFormFieldFactory;

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

import org.gvsig.tools.i18n.I18nManager;

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

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

@SuppressWarnings("UseSpecificCatch")

public class DefaultJDynForm extends AbstractJDynForm implements JDynFormFieldListener {

    private Map components = null;

    private final ComponentsFactory componentsFactory;

    private JComponent fieldsContainer;

    public DefaultJDynForm(

            DynFormSPIManager manager, 

            JDynFormFactory factory,

            DynFormDefinition definition,

            DynFormContext context

        ) {

        super(manager, factory, definition, context);

        this.components = new HashMap();

        this.componentsFactory = manager.createDefaultComponentsFactory();

    }

    @Override

    public JComponent getFieldsContainer() {

        if( this.fieldsContainer != null )  {

            return this.fieldsContainer;

        }

        try {

            JComponent component;

            switch (this.getLayoutMode()) {

                case USE_PLAIN:

                case USE_TREE:

                default:

                    component = getFieldsContainerPlain();

                    break;

                case USE_TABS:

                    component = getFieldsContainerUseTabs();

                    break;

                case USE_SEPARATORS:

                    component = getFieldsContainerUseSeparators();

                    break;

            }

            this.callUserEvent(USERCODE_FORM_ONLOAD, this);

            this.fieldsContainer = component;

            return component;

        } catch (ServiceException ex) {

            throw new RuntimeException(ex);

        }

    }

    private JComponent getFieldsContainerPlain() throws ServiceException {

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        GridBagConstraints c = new GridBagConstraints();

        c.insets = new Insets(2, 2, 2, 2);

        c.anchor = GridBagConstraints.PAGE_START;

        JPanel fieldsPanel = new JPanel();

        fieldsPanel.setLayout(new GridBagLayout());

        int gridy = 0;

        List<DynFormFieldDefinition> fields = this.getDefinition().getDefinitions();

        for (DynFormFieldDefinition fieldDefinition : fields) {

            if (fieldDefinition.isHidden()) {

                continue;

            }

            JDynFormFieldFactory factory = getServiceManager().getJDynFormFieldFactory(

                    this.getContext(),

                    fieldDefinition

            );

            JDynFormField jfield = factory.create(

                    getServiceManager(), 

                    this.componentsFactory,

                    fieldDefinition, 

                    null

            );

            if (jfield instanceof AbstractJDynFormField) {

                ((AbstractJDynFormField) jfield).setForm(this);

            }

            jfield.addListener(this);

            if (this.isReadOnly()) {

                jfield.setReadOnly(this.isReadOnly());

            }

            this.configurePopupMenu(jfield);

            String sep = jfield.getSeparatorTitleToUseBefore();

            if( !StringUtils.isBlank(sep) ) {

                c.gridx = 0;

                c.gridy = gridy;

                c.gridwidth = 2;

                c.gridheight = 1;

                c.fill = GridBagConstraints.HORIZONTAL;

                c.weightx = 1;

                c.weighty = 0;

                fieldsPanel.add(toolsSwingManager.createTitledSeparator(ToolsLocator.getI18nManager().getTranslation(sep)), c);

                gridy++;

            }

            if( jfield.useEmptyLabel() ) {

                c.gridx = 0;

                c.gridy = gridy;

                c.gridwidth = 2;

                c.gridheight = 1;

            } else {

                c.gridx = 0;

                c.gridy = gridy;

                c.gridwidth = 1;

                c.gridheight = 1;

                c.fill = GridBagConstraints.HORIZONTAL;

                c.weightx = 0;

                c.weighty = 0;

                jfield.getJLabel().setAlignmentY(Component.TOP_ALIGNMENT);

                fieldsPanel.add(jfield.getJLabel(), c);

                c.gridx = 1;

                c.gridy = gridy;

                c.gridwidth = 1;

                c.gridheight = 1;

            }

            double weighty = jfield.getResizeWeight();

            if( weighty>0 ) {

                c.fill = GridBagConstraints.BOTH;

                c.weightx = 1;

                c.weighty = weighty;

                fieldsPanel.add(jfield.asJComponent(), c);

            } else {

                c.fill = GridBagConstraints.HORIZONTAL;

                c.weightx = 1;

                c.weighty = 0;

                fieldsPanel.add(jfield.asJComponent(), c);

            }

            this.components.put(jfield.getName(), jfield);

            gridy++;

        }

        // Con esto forzamos a alinear los componentes arriba.

        c.gridx = 0;

        c.gridy = gridy;

        c.gridwidth = 1;

        c.gridheight = 1;

        c.fill = GridBagConstraints.VERTICAL;

        c.weightx = 0;

        c.weighty = 0.001;

        fieldsPanel.add(new JLabel(), c);

        return fieldsPanel;

    }

    private JComponent getFieldsContainerUseSeparators() throws ServiceException {

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        List<String> groups = this.getDefinition().getGroups();

        GridBagConstraints c = new GridBagConstraints();

        c.insets = new Insets(2, 2, 2, 2);

        c.anchor = GridBagConstraints.PAGE_START;

        JPanel fieldsPanel = new JPanel();

        fieldsPanel.setLayout(new GridBagLayout());

        int gridy = 0;

        for (String group : groups) {

            boolean firstField = true;

            List<DynFormFieldDefinition> fields = this.getDefinition().getDefinitions(group);

            for (DynFormFieldDefinition fieldDefinition : fields) {

                if (fieldDefinition.isHidden()) {

                    continue;

                }

                JDynFormFieldFactory factory = getServiceManager().getJDynFormFieldFactory(

                        this.getContext(),

                        fieldDefinition

                );

                JDynFormField jfield = factory.create(

                        getServiceManager(), 

                        this.componentsFactory,

                        fieldDefinition, 

                        null

                );

                if (jfield instanceof AbstractJDynFormField) {

                    ((AbstractJDynFormField) jfield).setForm(this);

                }

                jfield.addListener(this);

                if (this.isReadOnly()) {

                    jfield.setReadOnly(this.isReadOnly());

                }

                this.configurePopupMenu(jfield);

                if( firstField ) {

                    firstField = false;

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 2;

                    c.gridheight = 1;

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 1;

                    c.weighty = 0;

                    fieldsPanel.add(toolsSwingManager.createTitledSeparator(ToolsLocator.getI18nManager().getTranslation(group)), c);

                    gridy++;

                }

                String sep = jfield.getSeparatorTitleToUseBefore();

                if( !StringUtils.isBlank(sep) ) {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 2;

                    c.gridheight = 1;

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 1;

                    c.weighty = 0;

                    fieldsPanel.add(toolsSwingManager.createTitledSeparator(ToolsLocator.getI18nManager().getTranslation(sep)), c);

                    gridy++;

                }

                if( jfield.useEmptyLabel() ) {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 2;

                    c.gridheight = 1;

                } else {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 1;

                    c.gridheight = 1;

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 0;

                    c.weighty = 0;

                    fieldsPanel.add(jfield.getJLabel(), c);

                    c.gridx = 1;

                    c.gridy = gridy;

                    c.gridwidth = 1;

                    c.gridheight = 1;

                }

                double weighty = jfield.getResizeWeight();

                if( weighty>0 ) {

                    c.fill = GridBagConstraints.BOTH;

                    c.weightx = 1;

                    c.weighty = weighty;

                    fieldsPanel.add(jfield.asJComponent(), c);

                } else {

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 1;

                    c.weighty = 0;

                    fieldsPanel.add(jfield.asJComponent(), c);

                }

                this.components.put(jfield.getName(), jfield);

                gridy++;

            }

        }

        // Con esto forzamos a alinear los componentes arriba.

        c.gridx = 0;

        c.gridy = gridy;

        c.gridwidth = 1;

        c.gridheight = 1;

        c.fill = GridBagConstraints.VERTICAL;

        c.weightx = 0;

        c.weighty = 0.001;

        fieldsPanel.add(new JLabel(), c);

        return fieldsPanel;

    }

    private JComponent getFieldsContainerUseTabs() throws ServiceException {

        JTabbedPane tabbedPane = new JTabbedPane();

        if (this.getDefinition().getTags().has("TabPlacement")) {

            try {

                tabbedPane.setTabPlacement(this.getDefinition().getTags().getInt("TabPlacement"));

            } catch (Exception e) {

                // Ignorada

            }

        }

        ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

        I18nManager i18n = ToolsLocator.getI18nManager();

        List<String> groups = this.getDefinition().getGroups();

        GridBagConstraints c = new GridBagConstraints();

        c.insets = new Insets(2, 2, 2, 2);

        c.anchor = GridBagConstraints.PAGE_START;

        for (String group : groups) {

            JPanel fieldsPanel = new JPanel();

            GridBagLayout gridbag = new GridBagLayout();

            fieldsPanel.setLayout(gridbag);

            List<DynFormFieldDefinition> fields = this.getDefinition().getDefinitions(group);

            int gridy = 0;

            for (DynFormFieldDefinition fieldDefinition : fields) {

                if (fieldDefinition.isHidden()) {

                    continue;

                }

                JDynFormFieldFactory factory = getServiceManager().getJDynFormFieldFactory(

                        this.getContext(),

                        fieldDefinition

                );

                JDynFormField jfield = factory.create(

                        getServiceManager(), 

                        this.componentsFactory,

                        fieldDefinition, 

                        null

                );

                if (jfield instanceof AbstractJDynFormField) {

                    ((AbstractJDynFormField) jfield).setForm(this);

                }

                jfield.setReadOnly(this.isReadOnly());

                jfield.addListener(this);

                if (this.isReadOnly()) {

                    jfield.setReadOnly(this.isReadOnly());

                }

                this.configurePopupMenu(jfield);

                String sep = jfield.getSeparatorTitleToUseBefore();

                if( !StringUtils.isBlank(sep) ) {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 2;

                    c.gridheight = 1;

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 1;

                    c.weighty = 0;

                    fieldsPanel.add(toolsSwingManager.createTitledSeparator(ToolsLocator.getI18nManager().getTranslation(sep)), c);

                    gridy++;                                        

                }                

                if( jfield.useEmptyLabel() ) {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 2;

                    c.gridheight = 1;

                } else {

                    c.gridx = 0;

                    c.gridy = gridy;

                    c.gridwidth = 1;

                    c.gridheight = 1;

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 0;

                    c.weighty = 0;

                    jfield.getJLabel().setAlignmentY(Component.TOP_ALIGNMENT);

                    fieldsPanel.add(jfield.getJLabel(), c);

                    c.gridx = 1;

                    c.gridy = gridy;

                    c.gridwidth = 1;

                    c.gridheight = 1;

                }

                double weighty = jfield.getResizeWeight();

                if( weighty>0 ) {

                    c.fill = GridBagConstraints.BOTH;

                    c.weightx = 1;

                    c.weighty = weighty;

                    fieldsPanel.add(jfield.asJComponent(), c);

                } else {

                    c.fill = GridBagConstraints.HORIZONTAL;

                    c.weightx = 1;

                    c.weighty = 0;

                    fieldsPanel.add(jfield.asJComponent(), c);

                }

                this.components.put(jfield.getName(), jfield);

                gridy++;

            }

            if( gridy>0 ) {

                String tablabel = group;

                if (StringUtils.isEmpty(tablabel)) {

                    tablabel = ToolsLocator.getI18nManager().getTranslation("General");

                }

                tablabel = i18n.getTranslation(tablabel);

                // Con esto forzamos a alinear los componentes arriba.

                c.gridx = 0;

                c.gridy = gridy;

                c.gridwidth = 1;

                c.gridheight = 1;

                c.fill = GridBagConstraints.VERTICAL;

                c.weightx = 0;

                c.weighty = 0.001;

                fieldsPanel.add(new JLabel(), c);

                tabbedPane.addTab(tablabel,fieldsPanel);

            }

        }

        try {

            String defaultGroupName = (String) this.getDefinition().getTags().get("defaultGroup", DataTypes.STRING);

            List<String> groupsNames = this.getDefinition().getGroups();

            int groupIndex = groupsNames.indexOf(defaultGroupName);

            if (groupIndex >= 0) {

                tabbedPane.setSelectedIndex(groupIndex);

            }

        } catch (Exception ex) {

            // Ignore errors and don't set a tab by default

        }

        return tabbedPane;

    }

    @Override

    public void setReadOnly(boolean readOnly) {

        if( this.isReadOnly() == readOnly ) {

            return;

        }

        super.setReadOnly(readOnly);

        if (this.isContentsInitialized()) {

            Iterator it = this.getFieldsIterator();

            while (it.hasNext()) {

                JDynFormField field = (JDynFormField) it.next();

                if( readOnly ) {

                    field.setReadOnly(true);

                } else if( field.getDefinition().isReadOnly() ) {

                    field.setReadOnly(true);

                } else {

                    field.setReadOnly(false);

                }

            }

        }

    }

    @Override

    public void setValues(DynObject values) {

        if (!this.isContentsInitialized()) {

            this.values = values;

            return;

        }

        DynFormDefinition def = this.getDefinition();

        for (DynFormFieldDefinition field : def) {

            if( field.isHidden() ) {

                continue;

            }

            String name = field.getName();

            if ( StringUtils.isBlank(name) ) {

                LOGGER.warn("Field name is null or empty ");

                continue;

            }

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

            if (jfield == null) {

                LOGGER.warn("Can't retrieve form field asociated to the field '" + name + "' of class '" + def.getName() + "'.");

                continue;

            }

            Object value = values.getDynValue(name);

            if ( value == null) {

                if (field.getDataType().getType() == DataTypes.LIST) {

                    try {

                        if (((DynField_v2) field).getDynClassOfItems() != null) {

                            values.setDynValue(name, new ArrayList<>());

                        }

                    } catch (Exception e) {

                        LOGGER.warn("Problems initializing the DynObject List", e);

                    }

                }

            }

            jfield.setValue(value);

        }

        this.callUserEvent(USERCODE_FORM_ONSETVALUES, this, values);

        try {

            if( (boolean) this.callUserFunction(USERCODE_FORM_ISREADONLY, this) ) {

                this.setReadOnly(true);

            }

        } catch (Exception ex) {

        }

    }

    @Override

    public void getValues(DynObject values) {

        if (values == null) {

            return;

        }

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

        for (DynField field : fields) {

            String name = field.getName();

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

            if (jfield != null && !jfield.isReadOnly()) {

                try {

                    jfield.fetch(values);

                } catch (Exception ex) {

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

                }

            }

        }

    }

    @Override

    public boolean hasValidValues() {

        Iterator it = this.getFieldsIterator();

        while (it.hasNext()) {

            JDynFormField jfield = (JDynFormField) it.next();

            if (!jfield.hasValidValue()) {

                return false;

            }

        }

        try {

            return (boolean) this.callUserFunction(USERCODE_FORM_VALIDATE, this);

        } catch (Exception ex) {

        }

        return true;

    }

    @Override

    public boolean hasValidValues(List<String> fieldsName) {

        if (fieldsName == null) {

            fieldsName = new ArrayList<>();

        }

        Iterator it = this.getFieldsIterator();

        while (it.hasNext()) {

            JDynFormField jfield = (JDynFormField) it.next();

            if (!jfield.hasValidValue()) {

                fieldsName.add(jfield.getName());

            }

        }

        return fieldsName.isEmpty();

    }

    @Override

    public Object getValue(String fieldName) {

        JDynFormField field = (JDynFormField) this.getField(fieldName);

        return field.getValue();

    }

    @Override

    public void setValue(String fieldName, Object value) {

        JDynFormField field = (JDynFormField) this.getField(fieldName);

        try {

            value = field.getDefinition().getDataType().coerce(value);

        } catch (CoercionException e) {

            String msg = "Invalid value '" + ((value == null) ? "(null)" : value.toString()) + "' for field '" + fieldName + "'.";

            LOGGER.warn(msg, e);

            throw new RuntimeException(msg, e);

        }

        field.setValue(value);

    }

    @Override

    public boolean isModified() {

        if( this.isReadOnly() ) {

            return false;

        }

        try {

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

                return (boolean) this.callUserFunction(USERCODE_FORM_ISMODIFIED, this, values);

            }

        } catch (NoSuchMethodException ex) {

        } catch (Exception ex) {

            LOGGER.warn("Error calling user function form_IsModified.",ex);

        }

        Iterator it = this.getFieldsIterator();

        while (it.hasNext()) {

            JDynFormField jfield = (JDynFormField) it.next();

            if (jfield.isModified()) {

                return true;

            }

        }

        return false;

    }

    @Override

    public void fieldEnter(JDynFormField field) {

        message(field.getDefinition().getDescription());

        this.callUserEvent(USERCODE_FORM_ONFIELDENTER, this, field);

    }

    @Override

    public void fieldExit(JDynFormField field) {

        message();

        this.callUserEvent(USERCODE_FORM_ONFIELDEXIT, this, field);

    }

    @Override

    public void message(JDynFormField field, String message) {

        message(message);

    }

    @Override

    public void fieldChanged(JDynFormField field) {

        fireFieldChangeEvent(field);

        this.callUserEvent(USERCODE_FORM_ONFIELDCHANGED, this, field);

    }

    @Override

    public JDynFormField getField(String fieldName) {

        JDynFormField field = (JDynFormField) this.components.get(fieldName);

        return field;

    }

    public Iterator getFieldsIterator() {

        if (!this.isContentsInitialized()) {

            this.initComponents();

        }

        return this.components.values().iterator();

    }

    public Collection getShowFields() {

        return this.components.values();

    }

    @Override

    public void clear() {

        Iterator it = this.components.entrySet().iterator();

        while (it.hasNext()) {

            Map.Entry entry = (Map.Entry) it.next();

            ((JDynFormField) (entry.getValue())).clear();

        }

        this.callUserEvent(USERCODE_FORM_CLEAR, this);

    }

    @Override

    public void addActionToPopupMenu(DataType tipo, String name, Action action) {

        super.addActionToPopupMenu(tipo, name, action);

        if ( this.isContentsInitialized() ) {

            Iterator it = this.components.keySet().iterator();

            while (it.hasNext()) {

                String key = (String) it.next();

                Object obj = this.components.get(key);

                if (obj instanceof JDynFormField) {

                    JDynFormField field = (JDynFormField) obj;

                    if (tipo == field.getDefinition().getDataType()) {

                        if (field.asJComponent() instanceof SupportPopupMenu) {

                            field.addActionToPopupMenu(name, action);

                        }

                    }

                }

            }

        }

    }

    @Override

    public void addSeparatorToPopupMenu(DataType tipo) {

        super.addSeparatorToPopupMenu(tipo);

        if ( this.isContentsInitialized() ) {

            Iterator it = this.components.keySet().iterator();

            while (it.hasNext()) {

                String key = (String) it.next();

                Object obj = this.components.get(key);

                if (obj instanceof JDynFormField) {

                    JDynFormField field = (JDynFormField) obj;

                    if (tipo == field.getDefinition().getDataType()) {

                        if (field.asJComponent() instanceof SupportPopupMenu) {

                            ((SupportPopupMenu) field.asJComponent()).addSeparatorToPopupMenu();

                        }

                    }

                }

            }

        }

    }

    @Override

    public void setBorder(boolean border) {

        super.setBorder(border && this.getShowFields().size() >1);

    }

}