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

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import javax.swing.BorderFactory;

import javax.swing.DefaultListModel;

import javax.swing.JButton;

import javax.swing.JComponent;

import javax.swing.JList;

import javax.swing.JPanel;

import javax.swing.ListSelectionModel;

import javax.swing.event.ListSelectionEvent;

import javax.swing.event.ListSelectionListener;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynobject.DynField;

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

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;

/**

 * @author <a href="mailto:reinhold@uji.es">cmartin</a>

 * 

 */

public class JNDynFieldComponent extends AbstractNValueFieldComponent implements

                JDynFieldComponent, ValueChangedListener, ListSelectionListener {

        private JList list;

        private JButton removeButton;

        private JButton addButton;

        private JPanel subPanel;

        /**

         * @param writable

         * @param definition

         * @param serviceManager

         * @param dynObject

         * @param dynField

         */

        public JNDynFieldComponent(DynField definition, ValueField valueField,

                        boolean writable) {

                super(definition, valueField, writable);

                this.setEnabled(valueField.getDynField().isReadOnly());

                this.getComponent().addValueChangedListener(this);

        }

        private int findIndex(Object objectValue) {

                Object[] values = this.getDynField().getElementsType()

                                .getAvailableValues();

                int index = -1;

                if (values == null) {

                        return -1;

                }

                for (Object value : values) {

                        index++;

                        if (value != null) {

                                if (value.equals(objectValue)) {

                                        return index;

                                }

                        }

                }

                return -1;

        }

        /**

     * 

     */

        @Override

        protected void afterUI() {

                refresh();

        }

        private JButton createButton(String text) {

                return ToolsSwingLocator.getUsabilitySwingManager().createJToolButton(

                                text.toString());

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * org.gvsig.tools.swing.api.dynobject.dynfield.ValueField#getDefaultValue()

         */

        @Override

        public Object getDefaultValue() {

                return this.getDynField().getDefaultValue();

        }

        /*

         * (non-Javadoc)

         * 

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

         */

        public Object getValue() {

                if (getSize() <= 0) {

                        return null;

                }

                Object valueItem;

                List listItems = new ArrayList();

                for (int i = 0; i < this.list.getModel().getSize(); i++) {

                        valueItem = this.list.getModel().getElementAt(i);

                        listItems.add(valueItem);

                }

                return listItems;

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * 

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

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

         */

        public void handleValueChanged(JDynFieldComponent component) {

                if (getComponent().isValid() && getComponent().getValue() != null) {

                        int index = this.list.getSelectedIndex();

                        if (index >= 0) {

                                setListValue(getComponent().getValue(), index);

                        }

                } else {

                        this.list.setSelectedIndex(-1);

                }

        }

        /**

     *  

     */

        private void initBoxLayout() {

                subPanel = new JPanel(new GridBagLayout());

                subPanel.setBorder(BorderFactory.createTitledBorder(""));

                list.setVisibleRowCount(4);

                list.setBorder(BorderFactory.createTitledBorder(""));

                // listScrollPane = new JScrollPane(list);

                // listScrollPane.setViewportView(this.list);

                // listScrollPane.setLocale(this.list.getLocale());

                // int span = 3;

                GridBagConstraints c = new GridBagConstraints();

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

                // c.gridx = 0;

                // c.gridy = 0;

                // c.gridwidth = span;

                // c.fill = GridBagConstraints.BOTH;

                c.weightx = 1.0;

                c.fill = GridBagConstraints.HORIZONTAL;

                c.anchor = GridBagConstraints.NORTHWEST;

                JComponent comp = getComponent().asJComponent();

                subPanel.add(comp, c);

                c = new GridBagConstraints();

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

                c.weightx = 0.0;

                // c.gridx = span;

                // c.gridy = 0;

                // c.ipady = 0;

                c.fill = GridBagConstraints.HORIZONTAL;

                c.anchor = GridBagConstraints.NORTHEAST;

                subPanel.add(addButton, c);

                // list of items

                c = new GridBagConstraints();

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

                c.gridx = 0;

                c.gridy = 1;

                c.weightx = 1.0;

                // c.gridwidth = span;

                c.fill = GridBagConstraints.BOTH;

                c.anchor = GridBagConstraints.NORTHWEST;

                subPanel.add(this.list, c);

                // remove Button

                c = new GridBagConstraints();

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

                // c.gridx = span;

                c.gridy = 1;

                c.ipady = 0;

                c.weightx = 0.0;

                c.fill = GridBagConstraints.NONE;

                c.anchor = GridBagConstraints.NORTHWEST;

                subPanel.add(removeButton, c);

        }

        /*

         * (non-Javadoc)

         * 

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

         */

        public JComponent asJComponent() {

                // return this.listScrollPane;

                return this.subPanel;

        }

        @Override

        protected void initData() {

        }

        public void initJButtons() {

                removeButton = createButton("-");

                removeButton.setActionCommand("-");

                removeButton.addActionListener(new ActionListener() {

                        public void actionPerformed(ActionEvent e) {

                                removeElement(list.getSelectedIndex());

                                refresh();

                                fireValueChangedEvent();

                        }

                });

                addButton = createButton("+");

                addButton.setActionCommand("+");

                addButton.addActionListener(new ActionListener() {

                        public void actionPerformed(ActionEvent e) {

                                // add at the end of the list

                                if (getComponent().isValid()

                                                && getComponent().getValue() != null) {

                                        addElement(getComponent());

                                }

                                refresh();

                                fireValueChangedEvent();

                        }

                });

        }

        @Override

        protected void initUI() {

                initJButtons();

                this.initComponents();

        }

        private void initComponents() {

                initJList(this);

                initBoxLayout();

        }

        public void initJList(ListSelectionListener listener) {

                this.list = new JList(getModel());

                this.list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);

                this.list.addListSelectionListener(listener);

                if (getSize() > 0) {

                        this.list.setSelectedIndex(0);

                }

        }

        protected void setSelectedIndex(int index) {

                if (index > -2) {

                        this.list.setSelectedIndex(index);

                }

        }

        /*

         * (non-Javadoc)

         * 

         * @see

         * org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#isValid()

         */

        public boolean isValid() {

                if (getSize() > 0) {

                        return getComponent().isValid();

                }

                return !isReadOnly();

        }

        public void refresh() {

                this.setEnabled(!isEmpty());

                // this.fireValueChangedEvent();

        }

        protected void removeElement(int ind) {

                super.removeElement(ind);

                if (getSize() < 0) {

                        this.getComponent().setValue(null);

                }

                refresh();

        }

        public void requestFocus() {

                this.getComponent().requestFocus();

        }

        public void saveStatus() {

                setFieldValue(getModel());

        }

        public void setEnabled(boolean isEnabled) {

                this.removeButton.setEnabled(isEnabled);

                if ((getModel().isEmpty()) || (list.getSelectedIndex() < 0)) {

                        if (this.getComponent().getDynField().getType() != DataTypes.DYNOBJECT) {

                                this.getComponent().requestFocus();

                        }

                }

                this.list.updateUI();

                getComponent().asJComponent().updateUI();

                this.removeButton.setEnabled(isEnabled);

                if (isReadOnly()) {

                        if (this.getValue() == null) {

                                this.addButton.setEnabled(true);

                                this.getComponent().setEnabled(true);

                                this.removeButton.setEnabled(false);

                        } else {

                                this.addButton.setEnabled(isEmpty());

                                this.getComponent().setEnabled(!isEmpty());

                                this.removeButton.setEnabled(true);

                        }

                }

                this.list.updateUI();

                getComponent().asJComponent().updateUI();

        }

        private boolean isEmpty() {

                return (getModel().isEmpty() || (list.getSelectedIndex() < 0));

        }

        @Override

        protected void setJDynFieldComponentListeners() {

        }

        @Override

        protected void setNonNullValue(Object value) {

                if (this.list == null) {

                        initComponents();

                }

                if (value instanceof List) {

                        // this.getModel().setValue(value);

                        Iterator<Object> itemsIter = ((List) value).iterator();

                        if (itemsIter.hasNext()) {

                                this.getModel().clear();

                        }

                        while (itemsIter.hasNext()) {

                                this.getModel().addElement(itemsIter.next());

                        }

                } else {

                        this.list.setSelectedValue(value, true);

                }

        }

        @Override

        protected void setNullValue() {

                setNonNullValue(null);

        }

        /*

         * (non-Javadoc)

         * 

         * @see org.gvsig.tools.swing.spi.AbstractJDynField#setReadOnly()

         */

        @Override

        protected void setReadOnly() {

                this.setEnabled(false);

        }

        private void setListValue(Object element, int index) {

                super.setValue(element, index);

                refresh();

                // this.list.setSelectedIndex(index);

        }

        public void valueChanged(ListSelectionEvent e) {

                int index = list.getSelectedIndex();

                if (index >= 0) {

                        this.getComponent().setValue(

                                        getModel().getElementAt(list.getSelectedIndex()));

                }else{

                        int size = getSize();

                        if (size > 0) {

                                index = getModel().indexOf(getModel().firstElement());

                                if (index != this.list.getSelectedIndex()) {

                                        this.list.setSelectedIndex(index);

                                }

                        }

                }

                refresh();

        }

        public String getValidationMessage() {

                return null;

        }

        @Override

        protected DefaultListModel getModel() {

                if (this.list == null) {

                        return super.getModel();

                }

                return (DefaultListModel) this.list.getModel();

        }

}