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

import java.awt.Component;

import java.awt.Dimension;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import javax.swing.Action;

import javax.swing.BorderFactory;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTabbedPane;

import javax.swing.JViewport;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.dataTypes.DataType;

import org.gvsig.tools.dynform.DynFormDefinition;

import org.gvsig.tools.dynform.DynFormFieldDefinition;

import org.gvsig.tools.dynform.JDynForm;

import org.gvsig.tools.dynform.JDynFormField;

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

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

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

import org.gvsig.tools.service.ServiceException;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import com.jgoodies.forms.builder.DefaultFormBuilder;

import com.jgoodies.forms.layout.FormLayout;

import com.jgoodies.forms.layout.RowSpec;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.ToolsLocator;

@SuppressWarnings({ "unchecked", "rawtypes" })

public class DefaultJDynForm implements JDynForm, JDynFormFieldListener {

        protected static final Logger logger = LoggerFactory

                        .getLogger(DefaultJDynForm.class);

        private int formWidth= 320;

        private int formHeight = 540;

        private DefaultDynFormManager manager = null;

        private DynFormDefinition definition = null;

        private int layoutMode = USE_PLAIN;

        private JComponent contents = null;

        private Map components = null;

        private JLabel jlabel_messages = null;

        private boolean readOnly = false;

        private Set listeners = null;

        private DynObject values = null;

        private boolean useScrollBars = true;

        private Map customActions;

        public DefaultJDynForm(DefaultDynFormManager manager, DynFormDefinition definition) throws ServiceException {

                this.manager = manager;

                this.definition = definition;

                this.components = new HashMap();

                this.listeners = new HashSet();

                this.customActions = new HashMap<String,List<Action>>();

        }

        public DynFormSPIManager getServiceManager() {

                return this.manager.getServiceManager();

        }

        public JComponent asJComponent() {

                if( this.contents == null ) {

                        try {

                                this.initComponents();

                        } catch (ServiceException e) {

                                throw new RuntimeException(e.getLocalizedMessage(),e);

                        }

                }

                return this.contents;

        }

        public void addListener(JDynFormListener listener) {

                this.listeners.add(listener);

        }

        public void removeListener(JDynFormListener listener) {

                this.listeners.remove(listener);

        }

        protected void fireMessageEvent(String message) {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

                        JDynFormListener listener = (JDynFormListener) it.next();

                        try {

                        listener.message(message);

                        } catch (Exception ex) {

                                logger.info("Error calling listener " + listener.toString()

                                                + "(" + listener.getClass().getName() + ") from "

                                                + this.toString() + "(" + this.getClass().getName()

                                                + ").", ex);

                        }

                }

        }

        public JLabel getMessagesJLabel() {

                if( this.jlabel_messages == null ) {

                        this.jlabel_messages = new JLabel();

                        this.jlabel_messages.addMouseListener(new MouseAdapter()  {

                    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;

        }

        public void setShowMessageStatus(boolean showMessageStatus) {

                this.getMessagesJLabel().setVisible(showMessageStatus);

        }

        public boolean isShowMessageStatus() {

                return this.getMessagesJLabel().isVisible();

        }

        public void message() {

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

        }

        public void message(String msg) {

                this.getMessagesJLabel().setText(msg);

                fireMessageEvent(msg);

        }

        private void initComponents() throws ServiceException {

                switch(this.layoutMode) {

                case USE_PLAIN:

                case USE_TREE:

                default:

                        initComponentsPlain();

                        break;

                case USE_TABS:

                        initComponentsUseTabs();

                        break;

                case USE_SEPARATORS:

                        initComponentsUseSeparators();

                        break;

                }

                if( this.values != null ) {

                        this.setValues(values);

                }

                message();

        }

        private void initComponentsPlain() throws ServiceException {

                 FormLayout layout = new FormLayout(

                                   "left:pref,  8px,  fill:80dlu:grow", "pref");

            DefaultFormBuilder builder = new DefaultFormBuilder(layout);

                List fields = this.definition.getDefinitions();

                Iterator it = fields.iterator();

                while( it.hasNext() ) {

                        DynFormFieldDefinition fieldDefinition = (DynFormFieldDefinition) it.next();

                        JDynFormField jfield = getServiceManager().createJDynFormField(fieldDefinition, null);

                        jfield.setReadOnly(this.readOnly);

                        jfield.addListener(this);

                        if( this.readOnly ) {

                                jfield.setReadOnly(readOnly);

                        }

                        builder.append(jfield.getJLabel(),   jfield.asJComponent());

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

                }

                this.contents = addScrollsAndMessageBar(builder.getPanel());

        }

        private void initComponentsUseSeparators() throws ServiceException {

                List groups = this.definition.getGroups();

                FormLayout layout = new FormLayout(

                              "left:pref,  8px,  fill:80dlu:grow", "pref");

            DefaultFormBuilder builder = new DefaultFormBuilder(layout);

            builder.setDefaultRowSpec(new RowSpec(

                                RowSpec.TOP,

                                builder.getLayout().getRowSpec(1).getSize(),

                                builder.getLayout().getRowSpec(1).getResizeWeight()));

            for( int i=0; i<groups.size(); i++ ) {

                    String group = (String) groups.get(i);

                    builder.appendSeparator(group);

                        List fields = this.definition.getDefinitions(group);

                        Iterator it = fields.iterator();

                        while( it.hasNext() ) {

                                DynFormFieldDefinition fieldDefinition = (DynFormFieldDefinition) it.next();

                                JDynFormField jfield = getServiceManager().createJDynFormField(fieldDefinition, null);

                                jfield.addListener(this);

                                if( this.readOnly ) {

                                        jfield.setReadOnly(readOnly);

                                }

                                List<Action> customActions = getCustomFields(fieldDefinition.getDataType());

                            if(customActions!= null && !customActions.isEmpty()){

                                    Iterator it2 = customActions.iterator();

                                    while(it2.hasNext()){

                                            Object obj = it2.next();

                                            if(obj != null){

                                                    Action act = (Action)obj;

                                                    jfield.addActionToPopupMenu((String) act.getValue(Action.NAME), act);

                                            }else{

                                                    jfield.addSeparatorToPopupMenu();

                                            }

                                    }

                            }

                                builder.append(jfield.getJLabel(),   jfield.asJComponent());

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

                        }

            }

                this.contents = addScrollsAndMessageBar(builder.getPanel());

        }

        private void initComponentsUseTabs() throws ServiceException {

            JTabbedPane tabbedPane = new JTabbedPane();

            List groups = this.definition.getGroups();

            for( int i=0; i<groups.size(); i++ ) {

                    String group = (String) groups.get(i);

                        FormLayout layout = new FormLayout(

                                      "left:pref,  8px,  fill:80dlu:grow", "pref");

                    DefaultFormBuilder builder = new DefaultFormBuilder(layout);

                        builder.setDefaultRowSpec(new RowSpec(

                                        RowSpec.TOP,

                                        builder.getLayout().getRowSpec(1).getSize(),

                                        builder.getLayout().getRowSpec(1).getResizeWeight()));

                        List fields = this.definition.getDefinitions(group);

                        Iterator it = fields.iterator();

                        while( it.hasNext() ) {

                                DynFormFieldDefinition fieldDefinition = (DynFormFieldDefinition) it.next();

                                JDynFormField jfield = getServiceManager().createJDynFormField(fieldDefinition, null);

                                jfield.setReadOnly(this.readOnly);

                                jfield.addListener(this);

                                if( this.readOnly ) {

                                        jfield.setReadOnly(readOnly);

                                }

                                builder.append(jfield.getJLabel(),   jfield.asJComponent());

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

                        }

                String tablabel = group;

                if( StringUtils.isEmpty(tablabel) ) {

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

                }

                    tabbedPane.addTab(tablabel, builder.getPanel());

            }

                this.contents = addScrollsAndMessageBar(tabbedPane);

        }

        private List<Action> getCustomFields(DataType dataType) {

                return (List<Action>) customActions.get(dataType.getName());

        }

        private JPanel addScrollsAndMessageBar(JComponent formPanel) {

                formPanel.setBorder(BorderFactory.createEmptyBorder(4, 4, 4, 4));

                JScrollPane scroll = new JScrollPane(formPanel);

                if(useScrollBars){

                        scroll.setPreferredSize(new Dimension(formWidth, formHeight));

                }else{

                        scroll.setPreferredSize(formPanel.getPreferredSize());

                }

                scroll.setBorder(BorderFactory.createEmptyBorder());

                JPanel jpanel = new JPanel();

                jpanel.setLayout(new BorderLayout());

                jpanel.add(scroll, BorderLayout.CENTER);

                jpanel.add(getMessagesJLabel(), BorderLayout.PAGE_END);

                return jpanel;

        }

        public int getLayoutMode() {

                return this.layoutMode;

        }

        public void setLayoutMode(int layoutMode) {

                if( layoutMode<0 || layoutMode>USE_SEPARATORS) {

                        throw new IllegalArgumentException("layoutMode ("+layoutMode+") out of range. Valid values are 0 .. "+ USE_SEPARATORS+".");

                }

                this.layoutMode = layoutMode;

        }

        public void setValues(DynObject values) {

                /*

                 * TODO: Probablemente fuese mas acertado recorrer los controles de

                 * components y a partir de ellos acceder a los valores del DynObject

                 * recivido. Eso permitiria trabajar mejor con herencia de DynObject.

                 * Habria que hacer lo mismo con el getValues. 

                 */

                if( this.contents == null ) {

                        this.values = values;

                        return;

                }

                DynClass def = values.getDynClass();

                DynField[] fields = def.getDynFields();

                for( int i=0; i<fields.length; i++ ) {

                        String name = fields[i].getName();

                        if( name == null || name.isEmpty() ) {

                                logger.warn("Field name "+i+" of '"+ def.getFullName() +"' 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.getFullName() +"'.");

                                continue;

                        }

                        jfield.setValue(values.getDynValue(name));

                }

        }

        public void getValues(DynObject values) {

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

                for( int i=0; i<fields.length; i++ ) {

                        String name = fields[i].getName();

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

                        try {

                                Object value = jfield.getValue();

                                values.setDynValue(name,value);

                        } catch(Exception ex) {

                                logger.info(ex.getLocalizedMessage(), ex);

                        }

                }

        }

        public boolean haveValidValues() {

                Iterator it = this.getFieldsIterator();

                while( it.hasNext() ) {

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

                        if( ! jfield.hasValidValue() ) {

                                return false;

                        }

                }

                return true;

        }

        public boolean haveValidValues(List<String> fieldsName) {

                if(fieldsName == null){

                        fieldsName = new ArrayList<String>();

                }

                Iterator it = this.getFieldsIterator();

                while( it.hasNext() ) {

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

                        if( ! jfield.hasValidValue() ) {

                                fieldsName.add(jfield.getName());

                        }

                }

                if(!fieldsName.isEmpty()){

                        return false;

                }else

                        return true;

        }

        public boolean isModified() {

                Iterator it = this.getFieldsIterator();

                while( it.hasNext() ) {

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

                        if( jfield.isModified() ) {

                                return true;

                        }

                }

                return false;

        }

        public void fieldEnter(JDynFormField field) {

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

        }

        public void fieldExit(JDynFormField field) {

                message();

        }

        public void message(JDynFormField field, String message) {

                message(message);

        }

        public void fieldChanged(JDynFormField field) {

                // TODO Auto-generated method stub

        }

        public boolean isReadOnly() {

                return readOnly;

        }

        public void setReadOnly(boolean readOnly) {

                this.readOnly = readOnly;

                if( this.contents != null ) {

                        Iterator it = this.getFieldsIterator();

                        while( it.hasNext() ) {

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

                                field.setReadOnly(readOnly);

                        }

                }

        }

        public int getFormWidth() {

                if(this.contents == null){

                        return this.formWidth;

                }else{

                        JViewport port = ((JScrollPane)this.asJComponent()).getViewport();

                        Component comp = (Component) port.getView();

                        return comp.getWidth();

                }

        }

        public int getFormHeight() {

                if(this.contents == null){

                        return this.formHeight;

                }else{

                        JViewport port = ((JScrollPane)this.asJComponent()).getViewport();

                        Component comp = (Component) port.getView();

                        return comp.getHeight();

                }

        }

        public void setFormSize(int width, int height) {

                this.formHeight = height;

                this.formWidth = width;

                if( this.contents != null ){

                        this.asJComponent().setPreferredSize(new Dimension(width, height));

                }

        }

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

                if(this.contents==null){

                        List<Action> acts = this.getCustomFields(tipo);

                        action.putValue(Action.NAME, name);

                        if(acts == null){

                                List aux = new ArrayList<Action>();

                                aux.add(action);

                                customActions.put(tipo.getName(), aux);

                        }else{

                                acts.add(action);

                        }

                }else{

                        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);

                                                }

                                        }

                                }

                        }

                }

        }

        public void addSeparatorToPopupMenu(DataType tipo) {

                if(this.contents==null){

                        List<Action> acts = this.getCustomFields(tipo);

                        if(acts == null){

                                List aux = new ArrayList<Action>();

                                aux.add(null);

                                customActions.put(tipo.getName(), aux);

                        }else{

                                acts.add(null);

                        }

                }else{

                        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();

                                                }

                                        }

                                }

                        }

                }

        }

        public Object getValue(String fieldName) {

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

                return field.getValue();

        }

        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);

        }

        public JDynFormField getField(String fieldName) {

                if( this.contents == null ) {

                        try {

                                this.initComponents();

                        } catch (ServiceException e) {

                                throw new RuntimeException(e.getLocalizedMessage(),e);

                        }

                }

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

                return field;

        }

        public Iterator getFieldsIterator() {

                if( this.contents == null ) {

                        try {

                                this.initComponents();

                        } catch (ServiceException e) {

                                throw new RuntimeException(e.getLocalizedMessage(),e);

                        }

                }

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

        }

        public DynFormDefinition getDefinition() {

                return this.definition;

        }

        public void setUseScrollBars(boolean usesScrolls) {

                this.useScrollBars = usesScrolls;

        }

        public boolean getUseScrollBars() {

                return useScrollBars;

        }

}