Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2014 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 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., 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.featureform.swing.impl;

import java.awt.BorderLayout;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.ComponentAdapter;

import java.awt.event.ComponentEvent;

import java.util.AbstractList;

import java.util.List;

import javax.swing.AbstractAction;

import static javax.swing.Action.ACTION_COMMAND_KEY;

import static javax.swing.Action.NAME;

import static javax.swing.Action.SHORT_DESCRIPTION;

import static javax.swing.Action.SMALL_ICON;

import javax.swing.JComponent;

import javax.swing.JPanel;

import org.gvsig.featureform.swing.JFeatureReferencesForm;

import org.gvsig.fmap.dal.exception.DataException;

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

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

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

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

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

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

import org.gvsig.fmap.dal.swing.impl.DefaultDataSwingManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.dynform.AbortActionException;

import org.gvsig.tools.dynform.DynFormDefinition;

import org.gvsig.tools.dynform.DynFormLocator;

import org.gvsig.tools.dynform.DynFormManager;

import org.gvsig.tools.dynform.JDynForm;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.JDynFormSet;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_NAVIGATION;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_SAVE;

import org.gvsig.tools.dynform.JDynFormSet.JDynFormSetListener;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.i18n.I18nManager;

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

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

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

import org.gvsig.tools.swing.api.windowmanager.WindowManager;

import org.gvsig.tools.swing.api.windowmanager.WindowManager.MODE;

import org.gvsig.tools.swing.icontheme.IconTheme;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * @author fdiaz

 *

 */

@SuppressWarnings("UseSpecificCatch")

public class DefaultJFeatureReferencesForm implements Disposable, JFeatureReferencesForm {

    private final String REFRESHFORM_ACTION = "refreshForm";

    public static class FeaturesList extends AbstractList<Feature> {

        private final List<FeatureReference> references;

        public FeaturesList(List<FeatureReference> references) {

            this.references = references;

        }

        @Override

        public Feature get(int index) {

            try {

                return this.references.get(index).getFeature();

            } catch (DataException ex) {

                throw new RuntimeException("Can't get feature "+index, ex);

            }

        }

        @Override

        public int size() {

            return this.references.size();

        }

    }

    public static class DynObjectsList extends AbstractList<DynObject> {

        private final List<FeatureReference> references;

        public DynObjectsList( List<FeatureReference> references) {

            this.references = references;

        }

        @Override

        public DynObject get(int index) {

            try {

                Feature feature = this.references.get(index).getFeature();

                return feature.getAsDynObject();

            } catch (DataException ex) {

                throw new RuntimeException("Can't get dynobject "+index, ex);

            }

        }

        @Override

        public int size() {

            return this.references.size();

        }

    }

    private static final Logger LOGGER = LoggerFactory.getLogger(DefaultJFeatureReferencesForm.class);

    private JPanel panel;

    private JDynFormSet formset;

    private DynFormDefinition definition = null;

    private final ActionListenerSupport actionListeners;

    private List<FeatureReference> references;

    private List<Feature> features;

    private List<DynObject> dynobjects;

    private FeatureStore store;

    public DefaultJFeatureReferencesForm() {

        this.panel = new JPanel(new BorderLayout());

        this.panel.addComponentListener(new ComponentAdapter() {

            @Override

            public void componentHidden(ComponentEvent e) {

                dispose();

            }

        });

        this.actionListeners = ToolsSwingLocator.getToolsSwingManager().createActionListenerSupport();

    }

    @Override

    public void setPreferredSize(Dimension dimension) {

        panel.setPreferredSize(dimension);

    }

    private void updateForm() {

        if (this.formset == null) {

            this.getFormset();

        }

        try {

            this.formset.setValues(this.dynobjects);

        } catch (Exception ex) {

            throw new RuntimeException("Can't update form", ex);

        }

        updateButtonEnabledStatus();

    }

    @Override

    public JComponent asJComponent() {

//        if (this.features == null) {

//            try {

                updateForm();

//            } catch (Exception ex) {

//                throw new RuntimeException(ex);

//            }

//        }

        return this.panel;

    }

    @Override

    public void bind(FeatureStore store, List<FeatureReference> references) {

        this.bind(store, null, references);

    }

    public void bind(FeatureStore store, DynClass definition, List<FeatureReference> references) {

        if (store == null || references == null) {

            throw new IllegalArgumentException("bind need a store as parameter, not a null.");

        }

        try {

            DynFormManager formManager = DynFormLocator.getDynFormManager();

            if (definition == null) {

                DefaultDataSwingManager manager = (DefaultDataSwingManager) DALSwingLocator.getSwingManager();

                definition = manager.featureType2DynClass(store, store.getDefaultFeatureType());

            }

            this.store = store;

            this.definition = formManager.getDefinition(definition);

            this.setFeatures(references);

        } catch (Exception ex) {

            throw new RuntimeException("Can't bind features of '" + store.getName() + "' to form", ex);

        }

    }

    @Override

    public void dispose() {

        this.panel = null;

        this.formset = null;

        this.features = null;

        this.definition = null;

    }

    @Override

    public JDynFormSet getFormset() {

        if (this.formset == null) {

            DynFormManager formManager = DynFormLocator.getDynFormManager();

            this.formset = formManager.createJDynFormSet(

                    new DefaultFeaturesFormContext(this.store),

                    this.definition,

                    null

            );

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

            if (groups.size() == 1 && groups.get(0) == null) {

                this.formset.setLayoutMode(JDynForm.USE_PLAIN);

            } else {

                this.formset.setLayoutMode(JDynForm.USE_TABS);

            }

            this.formset.setAllowNew(false);

            this.formset.setAllowDelete(false);

            this.formset.setAllowUpdate(true);

            this.formset.setAllowClose(true);

            this.formset.setAllowSearch(false);

            this.formset.setAutosave(true);

            this.formset.addAction(new RefreshAction());

            this.formset.addListener(new FormSetListener());

            this.formset.getForm().addListener(new JDynForm.JDynFormListener() {

                @Override

                public void message(String string) {

                }

                @Override

                public void fieldChanged(JDynFormField jdff) {

                    updateButtonEnabledStatus();

                }

            });

            ToolsSwingLocator.getToolsSwingManager().removeBorder(this.formset.asJComponent());

            this.panel.add(this.formset.asJComponent(), BorderLayout.CENTER);

            this.panel.revalidate();

            ToolsSwingUtils.ensureRowsCols(this.panel, 8, 70, 25, 100);

        }

        updateButtonEnabledStatus();

        return this.formset;

    }

    @Override

    public long getCurrentIndex() {

        if (this.formset == null) {

            return -1;

        }

        return this.formset.getCurrentIndex();

    }

    @Override

    public Feature get(long index) {

        if (this.formset == null || this.features == null) {

            return null;

        }

        return this.features.get((int)index); 

    }

    private class RefreshAction extends AbstractAction {

        @SuppressWarnings({"OverridableMethodCallInConstructor", "LeakingThisInConstructor"})

        public RefreshAction() {

            I18nManager i18nManager = ToolsLocator.getI18nManager();

            IconTheme iconTheme = ToolsSwingLocator.getIconThemeManager().getDefault();

            this.putValue(NAME, null);

            this.putValue(SHORT_DESCRIPTION, i18nManager.getTranslation("_Reload_data"));

            this.putValue(SMALL_ICON, iconTheme.get("form-refresh-data"));

            this.putValue(ACTION_COMMAND_KEY, REFRESHFORM_ACTION);

            this.setEnabled(!formset.isInNewState());

        }

        @Override

        public void actionPerformed(ActionEvent ae) {

            try {

                I18nManager i18n = ToolsLocator.getI18nManager();

                formset.message(i18n.getTranslation("_Form_reloaded"));

                int x = formset.getCurrentIndex();

                updateForm();

                formset.setCurrentIndex(x);

            } catch (Exception ex) {

                LOGGER.warn("Can't reload form", ex);

            }

        }

    }

    @Override

    public void showForm(MODE mode) {

        WindowManager winmgr = ToolsSwingLocator.getWindowManager();

        String title = this.definition.getLabel();

        winmgr.showWindow(this.asJComponent(), title, mode);

    }

    private void saveChanges(JDynFormSet theFormSet) {

        I18nManager i18n = ToolsLocator.getI18nManager();

        try {

            int index = theFormSet.getCurrentIndex();

            DynObject currentElement = theFormSet.get(index);

            theFormSet.getFormValues(currentElement);            

            store.update(((FacadeOfAFeature) currentElement).getEditableFeature());

            this.formset.message(i18n.getTranslation("_Record_saved"));

            try {

                this.formset.setCurrentIndex(index);

            } catch (Exception ex) {

                LOGGER.warn("Can't reload form data after insert.", ex);

            }

        } catch (Exception ex) {

            theFormSet.message(i18n.getTranslation("error_saving_data_will_not_save"));

            throw new RuntimeException("Can't save values", ex);

        } finally {

            updateButtonEnabledStatus();

        }

    }

    @Override

    public void saveChanges() {

        if (this.formset != null && this.formset.countValues() > 0) {

            this.saveChanges(this.formset);

        }

    }

    private void updateButtonEnabledStatus() {

        if (this.formset == null) {

            return;

        }

        if (this.store == null || store.isBroken() || this.references == null) {

            this.formset.setReadOnly(true);

            formset.setActionEnabled(ACTION_SAVE, false);

            formset.setActionEnabled(REFRESHFORM_ACTION, false);

            formset.setActionEnabled(ACTION_NAVIGATION, false);

            return;

        }

        this.formset.setReadOnly(false);

        if (this.features != null && this.features.isEmpty()) {

            formset.getForm().setReadOnly(true);

            formset.setActionEnabled(ACTION_SAVE, false);

            formset.setActionEnabled(REFRESHFORM_ACTION, false);

            formset.setActionEnabled(ACTION_NAVIGATION, false);

        } else if (formset.getForm().isModified()) {

            formset.setActionEnabled(ACTION_SAVE, true);

            formset.setActionEnabled(REFRESHFORM_ACTION, true);

            formset.setActionEnabled(ACTION_NAVIGATION, true);

        } else {

            formset.setActionEnabled(ACTION_SAVE, false);

            formset.setActionEnabled(REFRESHFORM_ACTION, true);

            formset.setActionEnabled(ACTION_NAVIGATION, true);

        }

    }

    private void clearUniqueFields() {

        for (FeatureAttributeDescriptor attr : this.store.getDefaultFeatureTypeQuietly()) {

            if ((attr.isPrimaryKey() && !attr.isAutomatic()) || (attr.isIndexed() && !attr.allowIndexDuplicateds())) {

                JDynFormField field = formset.getForm().getField(attr.getName());

                if (field != null) {

                    field.clear();

                }

            }

        }

    }

    private void setEnabledUniqueFields(boolean enabled) {

        for (FeatureAttributeDescriptor attr : this.store.getDefaultFeatureTypeQuietly()) {

            if ((attr.isPrimaryKey() && !attr.isAutomatic()) || (attr.isIndexed() && !attr.allowIndexDuplicateds())) {

                JDynFormField field = formset.getForm().getField(attr.getName());

                if (field != null) {

                    field.setReadOnly(!enabled);

                }

            }

        }

    }

    @Override

    public long getDataSetSize() {

        if (this.references != null) {

            return references.size();

        }

        return 0;

    }

    @Override

    public FeatureStore getFeatureStore() {

        return this.store;

    }

    private class FormSetListener implements JDynFormSetListener {

        @Override

        public void formMessage(String message) {

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formMessage"));

        }

        @Override

        public void formClose() {

            panel.setVisible(false);

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formClose"));

        }

        @Override

        public void formMovedTo(int currentPosition) throws AbortActionException {

            LOGGER.trace("formMovedTo " + currentPosition);

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formMovedTo"));

        }

        @Override

        public void formBeforeSave(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formBeforeSave");

            saveChanges(dynformSet);

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formBeforeSave"));

        }

        @Override

        public void formBeforeNew(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formBeforeNew");

            clearUniqueFields();

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formBeforeNew"));

        }

        @Override

        public void formBeforeDelete(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formBeforeDelete");

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formBeforeDelete"));

        }

        @Override

        public void formAfterSave(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formAfterSave");

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formAfterSave"));

        }

        @Override

        public void formAfterNew(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formAfterNew");

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formAfterNew"));

        }

        @Override

        public void formAfterDelete(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formAfterDelete");

        }

        @Override

        public void formBeforeSearch(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formBeforeSearch");

        }

        @Override

        public void formAfterSearch(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formAfterSearch");

        }

        @Override

        public void formBeforeCancelNew(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formBeforeCancelNew");

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formBeforeCancelNew"));

        }

        @Override

        public void formAfterCancelNew(JDynFormSet dynformSet) throws AbortActionException {

            LOGGER.trace("formAfterCancelNew");

            updateButtonEnabledStatus();

            actionListeners.fireActionEvent(new ActionEvent(this, 1, "formAfterCancelNew"));

        }

    }

    @Override

    public void addActionListener(ActionListener listener) {

        this.actionListeners.addActionListener(listener);

    }

    @Override

    public ActionListener[] getActionListeners() {

        return this.actionListeners.getActionListeners();

    }

    @Override

    public void removeActionListener(ActionListener listener) {

        this.actionListeners.removeActionListener(listener);

    }

    @Override

    public void removeAllActionListener() {

        this.actionListeners.removeAllActionListener();

    }

    @Override

    public void fireActionEvent(ActionEvent event) {

        this.actionListeners.fireActionEvent(event);

    }

    @Override

    public boolean hasActionListeners() {

        return this.actionListeners.hasActionListeners();

    }

    @Override

    public void setFeatures(List<FeatureReference> references) {

        this.references = references;

        this.features = new FeaturesList(references);

        this.dynobjects = new DynObjectsList(references);

        if (formset != null) {

            this.panel.remove(formset.asJComponent());

            this.panel.revalidate();

            this.formset = null;

        }

        this.updateForm();

    }

}