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

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * 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.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 Institute of New Imaging Technologies (INIT): 

 *   http://www.init.uji.es

 * Geographic Information research group: 

 *   http://www.geoinfo.uji.es

 * Universitat Jaume I, Spain

 */

package org.gvsig.tools.swing.impl.dynobject;

import java.awt.Component;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTabbedPane;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.service.ServiceException;

import org.gvsig.tools.swing.api.dynobject.DynFieldModel;

import org.gvsig.tools.swing.api.dynobject.DynObjectModel;

import org.gvsig.tools.swing.api.dynobject.JDynObjectComponent;

import org.gvsig.tools.swing.api.dynobject.ValueChangedListener;

import org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent;

import org.gvsig.tools.swing.api.dynobject.dynfield.ValueField;

import org.gvsig.tools.swing.impl.dynobject.valuefield.DynObjectValueField;

import org.gvsig.tools.swing.spi.AbstractDynObjectComponent;

/**

 * Initial implementation based on a simple swing form generation.

 * 

 * @author 2008-2009 Jose Manuel Viv�

 * @author 2010- Cesar Ordinyana - gvSIG team

 */

public class DefaultJDynObjectComponent extends AbstractDynObjectComponent

                implements JDynObjectComponent, ValueField, ValueChangedListener {

        private static final Logger LOG = LoggerFactory

                        .getLogger(DefaultJDynObjectComponent.class);

        private final I18nManager i18nManager = ToolsLocator.getI18nManager();

        protected Map<String, Object> tempValue = new HashMap<String, Object>();

        private HashMap<DynField, StatusLabel> labelList;

        private JTabbedPane tabPanel;

        private JDynFieldComponent input;

        private int maxColumns = 3;

        private int tabPosition;

        private JPanel firstPanel;

        private HashMap tabComponents;

        public DefaultJDynObjectComponent(DynStruct definition,

                        DynObject currentValue, DynObjectModel model, int tabPosition)

                        throws ServiceException {

                super();

                this.tabPosition = tabPosition;

                this.setDynField(definition);

                this.tabComponents = new HashMap();

                this.setModel(model);

                setValue(currentValue);

        }

        private StatusLabel addGridBagComponent(JPanel panel, ValueField field,

                        int row, int numItems) throws ServiceException {

                DynField dynField = field.getDynField();

                input = getJDynFieldComponent(field, this);

                input.setValue(field.getFieldValue());

                // Setting label

                String srcText = dynField.getName();

                String text = i18nManager.getTranslation(srcText);

                JLabel label = new JLabel(text);

                boolean isDynObject = field.getDynField().getType() == DataTypes.DYNOBJECT;

                boolean isList = field.getDynField().getType() == DataTypes.LIST;

                // Setting component's wrapper

                StatusLabel right = new StatusLabel(input, label, dynField);

                this.getLabelList().put(input.getDynField(), right);

                input.addValueChangedListener(right);

                // Arranging label and component into panel

                GridBagConstraints constr = new GridBagConstraints();

                constr.anchor = GridBagConstraints.PAGE_START;

                constr.insets = new Insets(5, 5, 5, 5);

                if (row >= numItems - 1) {

                        constr.weighty = 1;

                }

                int column = -1;

                if (isDynObject || isList) {

                        if (numItems == 1) {

                                column += 1;

                                constr.gridx = column + 1;

                                constr.ipady = 2;

                                constr.weightx = 4;

                                constr.fill = GridBagConstraints.HORIZONTAL;

                                constr.anchor = GridBagConstraints.NORTHWEST;

                                constr.gridwidth = 2;

                                if (isDynObject) {

                                        constr.gridwidth = 4;

                                }

                                panel.add(right.getValidationPanel(false), constr);

                        } else {

                                column += 1;

                                constr.gridx = column;

                                constr.gridy = row;

                                constr.anchor = GridBagConstraints.NORTHWEST;

                                constr.fill = GridBagConstraints.NONE;

                                panel.add(right.getValidationLabel(), constr);

                                column += 1;

                                constr.gridx = column;

                                constr.ipady = 2;

                                constr.weightx = 4;

                                constr.fill = GridBagConstraints.HORIZONTAL;

                                constr.anchor = GridBagConstraints.NORTHWEST;

                                constr.gridwidth = 2;

                                if (isDynObject) {

                                        constr.gridwidth = 4;

                                }

                                panel.add(right.getValidationPanel(isDynObject), constr);

                        }

                } else {

                        constr.weightx = 0;

                        constr.ipadx = 2;

                        constr.ipady = 2;

                        constr.gridy = row;

                        if (!isDynObject) {

                                constr.gridx = column;

                                panel.add(label, constr);

                        }

                        column += 1;

                        constr.gridx = column;

                        constr.ipady = 14;

                        constr.fill = GridBagConstraints.NONE;

                        constr.anchor = GridBagConstraints.NORTHWEST;

                        panel.add(right.getValidationLabel(), constr);

                        column += 1;

                        if (maxColumns > column) {

                                constr.gridwidth = maxColumns - column;

                        } else {

                                maxColumns = column;

                        }

                        constr.gridx = column;

                        constr.ipady = 2;

                        constr.weightx = 2;

                        constr.fill = GridBagConstraints.HORIZONTAL;

                        constr.anchor = GridBagConstraints.NORTHWEST;

                        panel.add(right.getValidationPanel(false), constr);

                }

                Component component = right.getFieldComponent();

                this.getSelectedComponents().addComponentToList(component, input);

                input.fireValueChangedEvent();

                return right;

        }

        private Map<DynField, StatusLabel> getLabelList() {

                if (this.labelList == null) {

                        this.labelList = new HashMap<DynField, StatusLabel>();

                }

                return this.labelList;

        }

        protected void closeWindow() {

                LOG.debug("Result DynObject: {}", this.getDynObject());

        }

        /*

         * (non-Javadoc)

         * 

         * @see org.gvsig.tools.swing.api.dynobject.JComponent#getComponent()

         */

        public JComponent asJComponent() {

                return getMainComponent();

        }

        private JComponent getMainComponent() {

                if (this.tabPanel != null) {

                        return this.tabPanel;

                }

                return this.firstPanel;

        }

        public int size() {

                return this.tabPanel.getTabCount();

        }

        private StatusLabel getFieldLabel(DynField field) {

                return this.getLabelList().get(field);

        }

        private void initTabComponent() throws ServiceException {

                if (this.tabPanel == null) {

                        this.tabPanel = new JTabbedPane();

                        // this.tabPanel.setBorder(BorderFactory.createTitledBorder(this

                        // .getDefinition().getName()));

                        // Uncomment the following line to use scrolling tabs.

                        this.tabPanel.setTabLayoutPolicy(JTabbedPane.SCROLL_TAB_LAYOUT);

                }

                MyTab tab;

                JPanel pane;

                for (String group : getGroups()) {

                        tab = (MyTab) this.tabComponents.get(group);

                        if (tab == null) {

                                pane = (MyTab) createPanel(group);

                                this.getTabComponent().addTab(getGroupText(group),

                                                new JScrollPane(pane));

                                tabComponents.put(group, pane);

                        } else {

                                tab.load(this.getDynObject());

                        }

                }

                this.tabPanel.setTabPlacement(tabPosition);

        }

        private String getGroupText(String groupName) {

                if (this.getModel().isGroupCompulsory(groupName)) {

                        return groupName + "*";

                }

                return groupName;

        }

        private String[] getGroups() {

                return this.getModel().getGroups();

        }

        private int getGroupsCount() {

                return getGroups().length;

        }

        protected void addParametersFromModel() throws ServiceException {

                if ((getDefinition() == null) && (getGroupsCount() < 1)) {

                        return;

                }

                switch (getGroupsCount()) {

                case 1:

                        initSinglePanel();

                        break;

                default:

                        initTabPanel();

                        break;

                }

        }

        private JTabbedPane getTabComponent() throws ServiceException {

                if (this.tabPanel == null) {

                        this.initTabComponent();

                }

                return this.tabPanel;

        }

        private JPanel createPanel(String group) throws ServiceException {

                List<DynFieldModel> items = this.getModel().getGroupElements(group);

                DynField field = null;

                JPanel pane = new MyTab(this.getDefinition(), group, items);

                return pane;

        }

        private void initTabPanel() throws ServiceException {

                this.setDynObject(this.getDynObject());

                initTabComponent();

        }

        private void initSinglePanel() throws ServiceException {

                if (this.firstPanel == null) {

                        this.firstPanel = createPanel(getGroups()[0]);

                        // this.firstPanel.setBorder(BorderFactory.createTitledBorder(""));

                }

        }

        /*

         * (non-Javadoc)

         * 

         * @see org.gvsig.tools.swing.spi.AbstractDynObjectComponent#getValue()

         */

        public Object getValue() {

                return this.getDynObject();

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * 

         * 

         * 

         * org.gvsig.tools.swing.api.dynobject.ValueChangedListener#handleValueChanged

         * (org.gvsig.tools.swing.api.dynobject.JDynObjectComponent,

         * org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent)

         */

        public void handleValueChanged(JDynFieldComponent field) {

                // StatusLabel label = getFieldLabel(field.getDynField());

                // if (label != null) {

                // label.handleValueChanged(field);

                // }

                String fieldName = field.getDynField().getName();

                // DynField currentDynField =

                // this.getDefinition().getDynField(fieldName);

                if (hasDynField(fieldName)) {

                        if (field.isValid()

                                        || (field.getDynField().getType() == DataTypes.DYNOBJECT)) {

                                this.getDynObject().setDynValue(fieldName, field.getValue());

                        } else {

                                this.getDynObject().setDynValue(fieldName, null);

                        }

                }

        }

        private boolean hasDynField(String fieldName) {

                return this.getDefinition().getDynField(fieldName) != null;

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * org.gvsig.tools.swing.api.dynobject.JDynObjectComponent#requestFocus()

         */

        public void requestFocus() {

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * org.gvsig.tools.swing.api.dynobject.dynfield.ValueField#setValue(java

         * .lang.Object)

         */

        public void setValue(Object value) {

                fillValues((DynObject) value);

        }

        public DynField getDynField() {

                return input.getDynField();

        }

        public Object getDefaultFieldValue() {

                return input.getDefaultFieldValue();

        }

        public Object getFieldValue() {

                return input.getFieldValue();

        }

        public void setFieldValue(Object value) {

                input.setFieldValue(value);

        }

        public DynField getParentDynField() {

                return this.getDynField();

        }

        public class MyTab extends JPanel {

                private DynStruct definition;

                private String groupName;

                private HashMap mapComponents;

                public MyTab(DynStruct definition, String group,

                                List<DynFieldModel> items) throws ServiceException {

                        super();

                        this.setLayout(new GridBagLayout());

                        this.definition = definition;

                        this.groupName = group;

                        initUI(items);

                }

                public void load(DynObject dynObject) {

                        StatusLabel statusLabel;

                        String fieldName;

                        Iterator iter = mapComponents.entrySet().iterator();

                        while (iter.hasNext()) {

                                Map.Entry keySet = (Map.Entry) iter.next();

                                fieldName = (String) keySet.getKey();

                                statusLabel = (StatusLabel) keySet.getValue();

                                statusLabel.setValue(dynObject.getDynValue(fieldName));

                        }

                }

                public boolean isGroup(String groupName) {

                        if (groupName == null) {

                                return false;

                        }

                        return groupName.equals(this.groupName);

                }

                public boolean hasField(DynField field) {

                        return this.mapComponents.containsKey(field.getName());

                }

                private void initUI(List<DynFieldModel> items) throws ServiceException {

                        this.setName(this.definition.getName());

                        StatusLabel statusLabel;

                        mapComponents = new HashMap();

                        DynField field = null;

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

                                field = items.get(i).getDynField();

                                if (field.getType() != DataTypes.OBJECT) {

                                        statusLabel = addGridBagComponent(this,

                                                        new DynObjectValueField(this.definition,

                                                                        getDynObject(), field.getName()), i,

                                                        items.size());

                                        mapComponents.put(field.getName(), statusLabel);

                                }

                        }

                }

                public void load(String fieldName, Object value) {

                        StatusLabel statusLabel = (StatusLabel) this.mapComponents

                                        .get(fieldName);

                        if (statusLabel == null) {

                                return;

                        }

                        statusLabel.setValue(value);

                }

        }

}