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

import java.awt.Component;

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

import javax.swing.BorderFactory;

import javax.swing.JButton;

import javax.swing.JComponent;

import javax.swing.JList;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

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.service.ServiceException;

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;

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

/**

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

 * 

 */

public class JNDynFieldComponent extends DelegatedJFieldComponent implements

    JDynFieldComponent, ListSelectionListener, ValueChangedListener {

    private static final int MINIMUM_LIST_SIZE = 5;

    private static final Object UNKNOWN = "unknown";

    private JList list;

    private JButton sbutton;

    private JButton jbutton;

    // private DefaultListModel model;

    private JPanel panel;

    private JScrollPane listScrollPane;

    private NValueField items;

    private JPanel upperSubPanel;

    // private DynField defaultField;

    /**

     * @param serviceManager

     * @param dynObject

     * @param dynField

     */

    public JNDynFieldComponent(ValueField parent, DynField dynField) {

        super(parent, dynField);

        this.addValueChangedListener(this);

    }

    private void addElement(Object element) {

        Object[] values =

            this.getDynField().getElementsType().getAvailableValues();

        if (values != null)

            items.addElement(element, values[(Integer) element]);

        else

            if (this.getDynField().getElementsType().getType() == DataTypes.BOOLEAN)

                if (element == null)

                    items.addElement(element, UNKNOWN);

                else

                    items.addElement(element, element);

            else

                items.addElement(element, element);

        this.list.setSelectedIndex(items.getSize() - 1);

    }

    private void setValue(Object element, int index) {

        Object[] values =

            this.getDynField().getElementsType().getAvailableValues();

        if (element instanceof Integer) {

            int ind = (Integer) element;

            if ((values != null) && (ind > -1))

                items.setValue(index, element, values[(Integer) element]);

            else

                items.setValue(index, element, element);

        } else

            if (this.getDynField().getElementsType().getType() == DataTypes.BOOLEAN)

                if (element == null)

                    items.setValue(index, element, UNKNOWN);

                else

                    items.setValue(index, element, element);

            else

                items.setValue(index, element, element);

        this.list.setSelectedIndex(index);

    }

    // private void addElement(int index, Object item, boolean

    // addItemToInnerList) {

    // addItem(index,item);

    // // if (addItemToInnerList)

    // // this.items.add(index,item);

    //        

    // if (index>=0)

    // this.list.setSelectedIndex(index);

    // }

    // /**

    // * @param parent

    // * @param dynField

    // * @return

    // */

    // private static JDynFieldComponent createComponent(ValueField parent,

    // DynField dynField) {

    // ToolsSwingLocator.getDynObjectSwingManager()

    // .createJDynFieldComponent(this, dynField.getElementsType());

    //

    // }

    // /**

    // * @param object

    // * @param object2

    // */

    // private void addItem(Integer index, Object value) {

    // if (value==null) return;

    // if (index!=null){

    // this.items.add(index, value);

    // }else

    // this.items.add(value);

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

    // }

    /**

     * 

     */

    protected void afterUI() {

        //

        // Object valueItems = getFieldValue();

        // if (valueItems instanceof List) {

        // populateItems((List) valueItems);

        // }

        refresh();

    }

    private JButton createButton(String text) {

        return ToolsSwingLocator.getUsabilitySwingManager().createJToolButton(

            text.toString());

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    public JComponent asJComponent() {

        return this.panel;

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

     */

    public Object getDefaultValue() {

        return this.getDynField().getDefaultValue();

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    @Override

    public Object getFieldValue() {

        Object value = getParentValueField().getValue();

        if (value == null)

            value = getParentValueField().getDefaultValue();

        return value;

        // Object value = this..getValue();

        // if (value==null)

        // value = parentValues.getDefaultValue();

        // return value;

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    @Override

    public Object getValue() {

        if (this.list == null)

            return null;

        if (this.getDynField().getType() == DataTypes.STRING)

            return this.list.getSelectedValue();

        return this.list.getSelectedIndex();

    }

    /**

     *  

     */

    private void initBoxLayout() {

        panel = new JPanel(new BorderLayout(2, 2));

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

        JPanel subPanel = new JPanel(new GridBagLayout());

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

        list.setVisibleRowCount(4);

        // list.setLayout(new GridBagLayout());

        GridBagConstraints c = new GridBagConstraints();

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

        // c.anchor = GridBagConstraints.PAGE_START;

        // c.ipadx = 0;

        // c.fill = GridBagConstraints.HORIZONTAL;

        listScrollPane = new JScrollPane(list);

        listScrollPane.setViewportView(this.list);

        // Adding elements

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

        c.anchor = GridBagConstraints.LINE_START;

        c.ipadx = 0;

        c.weightx = 0.75;

        c.fill = GridBagConstraints.HORIZONTAL;

        c.gridx = 0;

        c.gridy = 0;

        subPanel.add((Component) component.asJComponent(), c);

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

        c.gridx = 1;

        c.gridy = 0;

        c.weightx = 0.0; // 0

        c.fill = GridBagConstraints.NONE;

        c.anchor = GridBagConstraints.LINE_END;

        subPanel.add(jbutton, c);

        panel.add(subPanel, BorderLayout.NORTH);

        this.upperSubPanel = panel;

        subPanel = new JPanel(new GridBagLayout());

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

        c.anchor = GridBagConstraints.LINE_START;

        c.ipadx = 0;

        c.weightx = 0.75;

        c.ipady = 40;

        c.fill = GridBagConstraints.HORIZONTAL;

        c.gridx = 0;

        c.gridy = 0;

        subPanel.add(this.listScrollPane, c);

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

        c.gridx = 1;

        c.gridy = 0;

        c.ipady = 0;

        c.weightx = 0.0; // 0

        c.fill = GridBagConstraints.RELATIVE;

        c.anchor = GridBagConstraints.PAGE_START;

        subPanel.add(sbutton, c);

        panel.add(subPanel);

        // c.fill = GridBagConstraints.HORIZONTAL;

        // // c.anchor = GridBagConstraints.LAST_LINE_END;

        // // c.gridx = 7; // Cell start at (2,0)

        // // c.gridy = 5;

        // // c.gridheight = 0; // span of 2

        // // c.gridwidth = 0; // no span

        // //// c.gridheight = 0; // no span

        // //// c.weightx = 0.5; //

        // panel.add(sbutton,c);

        // panel.add((Component) component.getComponent(),

        // BorderLayout.PAGE_START);

        // c.fill = GridBagConstraints.HORIZONTAL;

        // c.ipady = 2; //reset to default

        // c.weighty = 1.0; //request any extra vertical space

        // c.anchor = GridBagConstraints.PAGE_END; //bottom of space

        // c.insets = new Insets(10,0,0,0); //top padding

        // c.gridx = 1; //aligned with button 2

        // c.gridwidth = 2; //2 columns wide

        // c.gridy = 2; //third row

        // pane.add(button, c);

        //        

        // JPanel pane = createGridBagLayout((Component)

        // component.getComponent(),jbutton, 1,1,null);

    }

    protected void initData() {

        // Creates a list that allows adds and removes

        this.items = getValueField();

    }

    public void initJButtons() {

        sbutton = createButton("-");

        sbutton.setActionCommand("-");

        sbutton.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                removeElement(list.getSelectedIndex());

                refresh();

            }

        });

        jbutton = createButton("+");

        jbutton.setActionCommand("+");

        jbutton.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                // add at the end of the list

                if (component.isValid()) {

                    addElement(component.getValue());

                    refresh();

                }

            }

        });

    }

    /**

     * 

     */

    private void initJList() {

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

        this.list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);

        this.list.addListSelectionListener(this);

        if (this.items.getSize() > 0)

            this.list.setSelectedIndex(0);

    }

    /**

     * @throws ServiceException

     * 

     */

    protected void initUI() {

        initJList();

        initJButtons();

        initBoxLayout();

        // initListPanel();

        refresh();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

     */

    public boolean isValid() {

        return this.component.isValid();

    }

    /**

     * 

     */

    private void populateItems(List items) {

        if (items == null)

            return;

        else

            this.items.setValue(items);

        // if (!items.isEmpty())

        // this.list.setSelectedIndex(0);

    }

    public void refresh() {

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

            this.sbutton.setEnabled(false);

            this.component.requestFocus();

        } else

            this.sbutton.setEnabled(true);

    }

    private void removeElement(int ind) {

        if ((ind >= 0) && (ind < this.items.getSize()))

            removeItem(ind);

        if (items.getSize() < 0)

            sbutton.setEnabled(false);

        else {

            if (ind > 0)

                this.list.setSelectedIndex(ind - 1);

        }

        resize();

    }

    /**

     * @param ind

     */

    private void removeItem(int ind) {

        // model.removeElement(model.get(ind));

        this.items.removeElement(ind);

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#requestFocus

     * ()

     */

    public void requestFocus() {

        this.component.requestFocus();

    }

    /**

     * 

     */

    private void resize() {

        // int list_height = this.list.getSize().height;

        // int scrollpane_width = this.listScrollPane.getSize().width;

        // int scrollpane_height = this.listScrollPane.getSize().height;

        // int min_height = this.listScrollPane.getMinimumSize().height;

        //

        // if (scrollpane_height!=list_height)

        // if (list_height < min_height)

        // this.listScrollPane.setSize(scrollpane_width,min_height);

        // else

        // this.listScrollPane.setSize(scrollpane_width,list_height);

        // this.listScrollPane.revalidate();

        // this.panel.revalidate();

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    public void saveStatus() {

        // for (int i=0;i<this.model.size();i++){

        // this.items.addItem(i,this.model.get(i));

        // }

        setFieldValue(this.items);

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#setEnabled

     * (boolean)

     */

    public void setEnabled(boolean isEnabled) {

        if ((isEnabled) && (this.getDynField().isReadOnly()))

            return;

        this.sbutton.setVisible(isEnabled);

        this.upperSubPanel.setEnabled(isEnabled);

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#setFieldValue

     * (java.lang.Object)

     */

    public void setFieldValue(Object value) {

        this.getParentValueField().setValue(value);

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    @Override

    protected void setReadOnly() {

        this.setEnabled(false);

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.spi.DelegatedJFieldComponent#setValue(java.lang

     * .Object)

     */

    @Override

    public void setValue(Object value) {

        if (value instanceof List) {

            this.items.setValue((List) value);

        } else {

            this.list.setSelectedValue(value, true);

        }

        this.fireValueChangedEvent();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * javax.swing.event.ListSelectionListener#valueChanged(javax.swing.event

     * .ListSelectionEvent)

     */

    public void valueChanged(ListSelectionEvent e) {

        if (list.getSelectedIndex() >= 0) {

            this.component.setValue(this.items.getElementAt(list

                .getSelectedIndex()));

            // this.list.setVisibleRowCount(model.getSize());

            this.sbutton.setVisible(true);

            // this.listScrollPane.setVisible(true);

        } else {

            if (this.items.getSize() < 1) {

                // this.sbutton.setVisible(false);

                // this.listScrollPane.setVisible(false);

            } else {

                int index = this.items.indexOf(this.items.firstElement());

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

                    this.list.setSelectedIndex(index);

            }

        }

        refresh();

        this.fireValueChangedEvent();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

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

     */

    public void handleValueChanged(JDynFieldComponent field) {

        Object value = field.getValue();

        int index = this.list.getSelectedIndex();

        if (index > -1) {

            setValue(value, index);

        }

    }

    // /* (non-Javadoc)

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

    // */

    // @Override

    // public DynField getDynField() {

    // return this.defaultField;

    // }

}