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.services.dynformset.base;

import java.awt.BorderLayout;

import java.awt.Color;

import java.awt.Component;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import javax.swing.Action;

import javax.swing.BorderFactory;

import javax.swing.BoxLayout;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynform.AbortActionException;

import org.gvsig.tools.dynform.DynFormDefinition;

import org.gvsig.tools.dynform.JDynForm;

import org.gvsig.tools.dynform.JDynForm.JDynFormListener;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.FormSetListener;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_CANCEL_NEW;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_CLOSE;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_DELETE;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_FIRST;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_LAST;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_NEW;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_NEXT;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_PREVIOUS;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_SAVE;

import static org.gvsig.tools.dynform.services.dynformset.base.FormSetButtonBar.ID_ACTION_SEARCH;

import org.gvsig.tools.dynform.spi.dynformset.AbstractJDynFormSet;

import org.gvsig.tools.dynform.spi.dynformset.ActionStore;

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

import org.gvsig.tools.dynform.spi.dynformset.JDynFormSetFactory;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectSet;

import org.gvsig.tools.dynobject.Tags;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.visitor.VisitCanceledException;

import org.gvsig.tools.visitor.Visitor;

@SuppressWarnings("UseSpecificCatch")

public class BaseJDynFormSet extends AbstractJDynFormSet implements FormSetListener, JDynFormListener {

    private JLabel jlabel_messages = null;

    private JDynForm form = null;

    private FormSetButtonBar buttonBar = null;

    private int current = 0;

    public BaseJDynFormSet(

            DynFormSPIManager manager, 

            JDynFormSetFactory factory,

            JDynForm.DynFormContext context,

            DynFormDefinition definition,

            Tags contextTags

        ) {

        super(manager, factory,context, definition, contextTags);

    }

    @Override

    public JComponent asJComponent() {

        if (this.contents == null) {

            this.initComponents();

            if (this.buttonBar != null) {

                this.buttonBar.setReadOnly(this.isReadOnly());

            }

            if (this.form != null) {

                this.form.setReadOnly(this.isReadOnly());

            }

        }

        this.fireFormMovedToEvent(current);

        return this.contents;

    }

    public JDynForm getForm() {

        return this.form;

    }

    public JLabel getMessagesJLabel() {

        if (this.jlabel_messages == null) {

            this.jlabel_messages = new JLabel();

//                        this.jlabel_messages.setBorder( BorderFactory.createLoweredBevelBorder());

            this.jlabel_messages.setText(" ");

            this.jlabel_messages.addMouseListener(new MouseAdapter() {

                @Override

                public void mouseClicked(MouseEvent evt) {

                    int count = evt.getClickCount();

                    if (count == 2) {

                        JOptionPane.showMessageDialog(contents, jlabel_messages.getText(), "Status", JOptionPane.INFORMATION_MESSAGE);

                    }

                }

            });

        }

        return this.jlabel_messages;

    }

    @Override

    public void message() {

        this.getMessagesJLabel().setText(" ");

    }

    @Override

    public void message(String msg) {

        this.getMessagesJLabel().setText(msg);

    }

    private FormSetButtonBar getButtonBar() {

        if (this.buttonBar == null) {

            initComponents();

        }

        return this.buttonBar;

    }

    private void initComponents() {

        this.contents = new JPanel();

        this.contents.setBorder(BorderFactory.createLineBorder(Color.GRAY));

        this.contents.setLayout(new BorderLayout());

        this.form = this.getManager().getDynFormManager().createJDynForm(this.getContext(), this.getDefinition());

        this.form.setReadOnly(this.isReadOnly());

        this.form.setLayoutMode(this.getLayoutMode());

        this.form.setUseScrollBars(this.getUseScrollBars());

        this.form.addListener(this);

        if (!actionsBuffer.isEmpty()) {

            for (ActionStore actStore : actionsBuffer) {

                if (actStore.isSeparator()) {

                    form.addSeparatorToPopupMenu(

                            actStore.getDataType());

                } else {

                    form.addActionToPopupMenu(

                            actStore.getDataType(),

                            actStore.getActionName(),

                            actStore.getAction());

                }

            }

        }

        if (this.getUseScrollBars()) {

            if (this.formHeight > -1 && this.formWidth > -1) {

                this.setFormSize(this.formWidth, this.formHeight);

            }

        }

        this.form.setShowMessageStatus(false);

        //this.form.setLayoutMode(this.layoutMode);

        this.form.addListener(this);

        this.buttonBar = new FormSetButtonBar();

        this.buttonBar.addListener(this);

        this.buttonBar.setActionActive(ID_ACTION_DELETE, this.allowDelete());

        this.buttonBar.setActionActive(ID_ACTION_NEW, this.allowNew());

        this.buttonBar.setActionActive(ID_ACTION_CANCEL_NEW, this.allowNew());

        this.buttonBar.setActionActive(ID_ACTION_SAVE, this.allowUpdate());

        this.buttonBar.setActionActive(ID_ACTION_SEARCH, this.allowSearch());

        this.buttonBar.setActionActive(ID_ACTION_CLOSE, this.allowClose());

        this.buttonBar.setVisible(ID_ACTION_CANCEL_NEW, false);

        this.buttonBar.setReadOnly(this.isReadOnly());

        this.contents.add(this.form.asJComponent(), BorderLayout.CENTER);

        JPanel p = new JPanel();

        p.setLayout(new BoxLayout(p, BoxLayout.PAGE_AXIS));

        this.buttonBar.asJComponent().setAlignmentX(Component.LEFT_ALIGNMENT);

        this.getMessagesJLabel().setAlignmentX(Component.LEFT_ALIGNMENT);

        p.add(this.buttonBar.asJComponent());

        p.add(this.getMessagesJLabel());

        this.contents.add(p, BorderLayout.SOUTH);

        doChangeValues();

    }

    @Override

    public void setAllowDelete(boolean allowDelete) {

        super.setAllowDelete(allowDelete);

        if( this.buttonBar!=null ) {

            this.buttonBar.setActionActive(ID_ACTION_DELETE, this.allowDelete());

        }

    }

    @Override

    public void setAllowNew(boolean allowNew) {

        super.setAllowNew(allowNew);

        if( this.buttonBar!=null ) {

            this.buttonBar.setActionActive(ID_ACTION_NEW, this.allowNew());

        }

    }

    private void doChangeValues() {

        this.current = 0;

        if (this.values == null || this.values.isEmpty()) {

            this.form.setReadOnly(true);

            this.getButtonBar().setEnabled(ID_ACTION_DELETE, false);

            this.getButtonBar().setEnabled(ID_ACTION_SAVE, false);

            this.getButtonBar().setEnabled(ID_ACTION_NEW,

                    this.allowNew() && !this.isReadOnly());

            this.getButtonBar().setNumrecords(0);

            this.form.clear();

        } else {

            this.form.setValues((DynObject) this.values.get(this.current));

            this.getButtonBar().setEnabled(ID_ACTION_DELETE,

                    this.allowDelete() && !this.isReadOnly());

            this.getButtonBar().setEnabled(ID_ACTION_SAVE,

                    this.allowUpdate() && !this.isReadOnly());

            this.getButtonBar().setNumrecords(this.values.size());

        }

        this.getButtonBar().setCurrent(this.current);

    }

    @Override

    public void setValues(List values) {

        super.setValues(values);

        if (this.contents != null) {

            doChangeValues();

        }

    }

    @Override

    public void setValues(DynObjectSet values) {

        super.setValues(values);

        if (this.contents != null) {

            doChangeValues();

        }

    }

    @Override

    public void setReadOnly(boolean readOnly) {

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

//            return;

//        }

        super.setReadOnly(readOnly);

        if (this.buttonBar != null) {

            this.buttonBar.setReadOnly(readOnly);

        }

        if (this.form != null) {

            this.form.setReadOnly(readOnly);

        }

    }

    @Override

    public boolean doActionFirst() {

        if (this.values.isEmpty()) {

            return false;

        }

        if (autosave) {

            if (this.form.isModified() || this.isInNewState() ) {

                if (!doActionSave()) {

                    return false;

                }

            }

        }

        callUserEvent("form_beforeFirst", this.getForm());

        this.current = 0;

        this.form.setValues((DynObject) this.values.get(this.current));

        this.buttonBar.setCurrent(this.current);

        try {

            this.getButtonBar().setEnabled(ID_ACTION_DELETE,

                    this.allowDelete() && !this.isReadOnly());

            this.getButtonBar().setEnabled(ID_ACTION_SAVE,

                    this.allowUpdate() && !this.isReadOnly());

        } catch (Exception ex) {

            LOGGER.warn("Can't enable/disable delete and save buttons",ex);

        }

        callUserEvent("form_afterFirst", this.getForm());

        this.fireFormMovedToEvent(this.current);

        return true;

    }

    @Override

    public boolean doActionPrevious() {

        if (this.values.isEmpty()) {

            return false;

        }

        if (autosave) {

            if (this.form.isModified() || this.isInNewState() ) {

                if (!doActionSave()) {

                    return false;

                }

            }

        }

        callUserEvent("form_beforePrevious", this.getForm());

        if (this.current > 0) {

            this.current--;

        }

        this.form.setValues((DynObject) this.values.get(this.current));

        this.buttonBar.setCurrent(this.current);

        callUserEvent("form_afterPrevious", this.getForm());

        this.fireFormMovedToEvent(this.current);

        return true;

    }

    @Override

    public boolean doActionNext() {

        if (this.values.isEmpty()) {

            return false;

        }

        if (autosave) {

            if (this.form.isModified() || this.isInNewState() ) {

                if (!doActionSave()) {

                    return false;

                }

            }

        }

        callUserEvent("form_beforeNext", this.getForm());

        if (this.current < this.values.size() - 1) {

            this.current++;

        }

        this.form.setValues((DynObject) this.values.get(this.current));

        this.buttonBar.setCurrent(this.current);

        callUserEvent("form_afterNext", this.getForm());

        this.fireFormMovedToEvent(this.current);

        return true;

    }

    @Override

    public boolean doActionLast() {

        if (this.values.isEmpty()) {

            return false;

        }

        if (autosave) {

            if (this.form.isModified() || this.isInNewState() ) {

                if (!doActionSave()) {

                    return false;

                }

            }

        }

        callUserEvent("form_beforeLast", this.getForm());

        this.current = this.values.size() - 1;

        this.form.setValues((DynObject) this.values.get(this.current));

        this.buttonBar.setCurrent(this.current);

        callUserEvent("form_afterLast", this.getForm());

        this.fireFormMovedToEvent(this.current);

        return true;

    }

    @Override

    public boolean doActionSave() {

        if ( !this.isInNewState() && this.values.isEmpty()) {

            return false;

        }

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formBeforeSave(BaseJDynFormSet.this);

                }

            });

        } catch (AbortActionException e) {

            return false;

        } catch (BaseException e) {

            LOGGER.warn("Can't notify to listeners before save.",e);

            return false;

        }

        callUserEvent("form_beforeSave", this.getForm());

        List<String> fieldsName = new ArrayList<>();

        if (!this.form.hasValidValues(fieldsName)) {

            String errores = "";

            Iterator<String> it = fieldsName.iterator();

            while (it.hasNext()) {

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

                errores = errores + "     - " + name + "\n";

            }

            int r = confirmDialog(

                    "There are incorrect data in the following fields:\n" + errores + "\nContinuing the incorrect values ​will not be saved. Do you want to continue?", "warning",

                    JOptionPane.WARNING_MESSAGE,

                    JOptionPane.YES_NO_OPTION);

            if (r != JOptionPane.YES_OPTION) {

                return false;

            }

        }

        if( !this.isInNewState() ) {

            if (this.current >= 0 && this.current < this.values.size()) {

                this.form.getValues((DynObject) this.values.get(this.current));

            } else {

                LOGGER.warn("current out of range.");

            }

        }

        this.leaveTheNewState();

        callUserEvent("form_afterSave", this.getForm());

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formAfterSave(BaseJDynFormSet.this);

                }

            });

        } catch (AbortActionException e) {

            return false;

        } catch (BaseException e) {

            LOGGER.warn("Can't notify to listeners after save.",e);

            return false;

        }

        return true;

    }

    @Override

    public boolean doActionNew() {

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formBeforeNew(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        callUserEvent("form_beforeNew", this.getForm());

        this.enterStateNew();

        callUserEvent("form_afterNew", this.getForm());

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formAfterNew(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        return true;

    }

    @Override

    public boolean doActionCancelNew() {

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formBeforeCancelNew(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        callUserEvent("form_beforeCancelNew", this.getForm());

        this.leaveTheNewState();

        callUserEvent("form_afterCancelNew", this.getForm());

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formAfterCancelNew(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        return true;

    }

    @Override

    protected void enterStateNew() {

        if( this.isInNewState() ) {

            return;

        }

        try {

            FormSetButtonBar bar = this.getButtonBar();

            super.enterStateNew();

            bar.setCurrentLabel(ToolsLocator.getI18nManager().getTranslation("nuevo"));

            bar.setNumrecords(this.countValues());

            bar.setVisible(ID_ACTION_CANCEL_NEW, true);

            bar.setVisible(ID_ACTION_NEW, false);

            bar.setEnabled(ID_ACTION_SAVE,true);

            bar.setEnabled(ID_ACTION_CANCEL_NEW,true);

            bar.setEnabled(ID_ACTION_DELETE,false);

            bar.setEnabled(ID_ACTION_FIRST,false);

            bar.setEnabled(ID_ACTION_NEXT,false);

            bar.setEnabled(ID_ACTION_PREVIOUS,false);

            bar.setEnabled(ID_ACTION_LAST,false);

            bar.setEnabled(ID_ACTION_SEARCH,false);

        } catch (Exception ex) {

            LOGGER.warn("Can't enable/disable delete and save buttons",ex);

        }

    }

    @Override

    protected void leaveTheNewState() {

        if( !(this.isInNewState()) ) {

            return;

        }

        super.leaveTheNewState();

        try {

            FormSetButtonBar bar = this.getButtonBar();

            bar.setVisible(ID_ACTION_CANCEL_NEW, false);

            bar.setVisible(ID_ACTION_NEW, true);

            bar.setEnabled(ID_ACTION_SAVE,true);

            bar.setEnabled(ID_ACTION_NEW,true);

            bar.setEnabled(ID_ACTION_DELETE,true);

            bar.setEnabled(ID_ACTION_SEARCH,true);

            bar.setCurrentLabel(null);

            bar.setNumrecords(this.countValues());

            bar.setCurrent(this.current);

        } catch (Exception ex) {

            LOGGER.warn("Can't enable/disable delete and save buttons",ex);

        }

    }

    @Override

    public boolean doActionDelete() {

        if (this.values.isEmpty()) {

            return false;

        }

        if (this.countValues() < 1) {

            return true;

        }

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formBeforeDelete(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        if (this.current >= countValues()) {

            this.current = countValues() - 1;

        }

        if (this.current > -1) {

            this.form.setValues((DynObject) this.values.get(this.current));

        }

        this.buttonBar.setNumrecords(this.countValues());

        this.buttonBar.setCurrent(this.current);

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formAfterDelete(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        return true;

    }

    @Override

    public boolean doActionSearch() {

        if (this.values.isEmpty()) {

            return false;

        }

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formBeforeSearch(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        // Do search

        try {

            this.listeners.accept(new Visitor() {

                @Override

                public void visit(Object listener) throws VisitCanceledException, BaseException {

                    ((JDynFormSetListener) listener).formAfterSearch(BaseJDynFormSet.this);

                }

            });

        } catch (BaseException e) {

            return true;

        }

        return true;

    }

    @Override

    public boolean doActionClose() {

        fireCloseEvent();

        return true;

    }

    @Override

    public void doSetCurrentRecord(int index) {

        this.setCurrentIndex(index);

    }

    @Override

    public void setFormSize(int width, int height) {

        super.setFormSize(width, height);

        if (this.form != null) {

            this.form.setFormSize(width, height);

        }

    }

    @Override

    public int getCurrentIndex() {

        return this.current;

    }

    @Override

    public void setCurrentIndex(int index) {

        if (index < 0 || index > countValues()) {

            throw new IllegalArgumentException("Index (" + index + ") out of range [0.." + countValues() + "].");

        }

        // Don't call doActionSave, crash with stack overflow

        this.current = index;

        this.form.setValues((DynObject) this.values.get(this.current));

        this.buttonBar.setCurrent(this.current);

        this.fireFormMovedToEvent(this.current);

    }

    @Override

    public void fieldChanged(JDynFormField field) {

        LOGGER.debug("Ha cambiado el field: " + field.getName() + " con el valor => " + field.getValue());

    }

    @Override

    public DynObject get(int position) {

        LOGGER.debug("Recojo el field: " + position);

        return (DynObject) this.values.get(position);

    }

    @Override

    public List getValues() {

        if (this.current >= 0 && this.current < this.values.size()) {

            this.form.getValues((DynObject) this.values.get(this.current));

        }

        return this.values;

    }

    @Override

    public boolean hasValidValues() {

        return this.form.hasValidValues();

    }

    @Override

    public boolean hasValidValues(List<String> fieldsName) {

        return this.form.hasValidValues(fieldsName);

    }

    public void clear() {

        if (this.form != null) {

            this.form.clear();

        }

    }

    @Override

    public void getFormValues(DynObject values) {

        this.form.getValues(values);

    }

    @Override

    public void addAction(Action action) {

        this.getButtonBar().addAction(action);

    }

    @Override

    public Action getAction(String actionId) {

        return this.getButtonBar().getAction(actionId);

    }

    @Override

    public List<Action> getActions() {

        return this.getButtonBar().getActions();

    }

    @Override

    public void setActionVisible(String action, boolean visible) {

        this.getButtonBar().setVisible(action, visible);

    }

    @Override

    public void setActionEnabled(String action, boolean enabled) {

        this.getButtonBar().setEnabled(action, enabled);

    }

    @Override

    public boolean isActionEnabled(String action) {

        return this.getButtonBar().isEnabled(action);

    }

    @Override

    public boolean isActionVisible(String action) {

        return this.getButtonBar().isVisible(action);

    }

    @Override

    public JComponent getActionButton(String action) {

        return this.getButtonBar().getActionButton(action);

    }

    @Override

    public void fireEvent(String action, Object value) {

        this.getButtonBar().fireEvent(action, value);

    }

}