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

package org.gvsig.tools.swing.serv.field.component;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.FocusEvent;

import java.awt.event.FocusListener;

import java.awt.event.KeyEvent;

import java.awt.event.KeyListener;

import java.text.ParseException;

import java.util.Locale;

import javax.swing.BorderFactory;

import javax.swing.Box;

import javax.swing.BoxLayout;

import javax.swing.ImageIcon;

import javax.swing.JButton;

import javax.swing.JPanel;

import javax.swing.JSpinner;

import javax.swing.JTextField;

import javax.swing.SwingConstants;

import org.gvsig.tools.dynobject.DynField;

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

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

import org.gvsig.tools.swing.serv.field.component.spinner.DynFieldEditor;

/**

 * 

 * This class is used a JSpinner to accept null values by

 * changing to an empty JTextField when the value is null

 * when clicking to the null component, the JTextField will

 * disappear and the currentValue will be shown in the

 * JSpinner.

 * 

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public class JNullValueMuttableTextField extends JPanel implements KeyListener {

    /**

     * 

     */

    private static final long serialVersionUID = -7772372354714908644L;

    private JTextField textField;

    private JButton btnEmptyLabel;

    private DynFieldEditor editor;

    private DynField field;

    private Object value;

    private boolean isReadOnly;

    private ImageIcon icon;

    /**

     * Constructor.

     * 

     * @param field

     *            the {@link DynField} to which the field refers to.

     * @param initialValue

     *            the initial value to be set.

     * @param locale

     */

    public JNullValueMuttableTextField(DynField field, Object initialValue,

        Locale locale, ImageIcon btnEmptyImageIcon) {

        super();

        this.setLocale(locale);

        this.field = field;

        this.value = null;

        this.isReadOnly = false;

        this.icon = btnEmptyImageIcon;

        initUI();

        afterUI(initialValue, locale);

        this.fireValueChangedEvent();

    }

    public void addEmptyButtonActionListener(ActionListener listener) {

        this.getBtnEmpty().addActionListener(listener);

    }

    public void addValueChangedListener(ValueChangedListener listener) {

        if (listener instanceof JDynFieldComponent) {

            this.listenerList.add(ValueChangedListener.class, listener);

        }

    }

    private void afterUI(Object initialValue, Locale locale) {

        if (this.field.isReadOnly()) {

            this.isReadOnly = true;

            getJTextField().setVisible(false);

            getBtnEmpty().setVisible(false);

            getJSpinner().setValue(initialValue);

            getJSpinner().setEnabled(false);

        } else {

            setValue(initialValue);

        }

    }

    public void fireValueChangedEvent() {

        ValueChangedListener[] list =

            this.listenerList.getListeners(ValueChangedListener.class);

        for (ValueChangedListener listener : list) {

            listener.handleValueChanged((JDynFieldComponent) listener);

        }

    }

    /**

     * Gets the image button component

     * 

     * @return the Image button component

     */

    private JButton getBtnEmpty() {

        if (btnEmptyLabel != null) {

            return btnEmptyLabel;

        }

        String description = "Empties the field value.";

        icon.setDescription(description);

        btnEmptyLabel = new JButton();

        btnEmptyLabel.setActionCommand("BTN_OK");

        btnEmptyLabel.setOpaque(false);

        btnEmptyLabel.setBorderPainted(false);

        btnEmptyLabel.setBorder(BorderFactory.createEmptyBorder());

        btnEmptyLabel.setSize(new java.awt.Dimension(icon.getIconWidth(), icon

            .getIconHeight()));

        btnEmptyLabel.setHorizontalAlignment(SwingConstants.RIGHT);

        btnEmptyLabel.setVerticalAlignment(SwingConstants.TOP);

        btnEmptyLabel.setIcon(icon);

        // btnEmptyPanel = new JPanel();

        // btnEmptyPanel.add(btnEmptyLabel);

        // btnEmptyLabel.setOpaque(false);

        btnEmptyLabel.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                setEmptyValue();

            }

        });

        return btnEmptyLabel;

    }

    protected Object getDefaultValue() {

        return this.editor.getDefaultValue();

    }

    protected DynField getDynField() {

        return this.field;

    }

    /**

     * Gets the current JSpinner component

     * 

     * @return the spinner component

     */

    private JSpinner getJSpinner() {

        return this.editor.getSpinner();

    }

    /**

     * Gets the current JTextField component

     * 

     * @return the JTextField component

     */

    private JTextField getJTextField() {

        if (textField != null) {

            return textField;

        }

        textField = new JTextField();

        // textField.setEditable(false);

        textField.addFocusListener(new FocusListener() {

            public void focusGained(FocusEvent e) {

                setValue(editor.getDefaultValue());

            }

            public void focusLost(FocusEvent e) {

                fireValueChangedEvent();

            }

        });

        return textField;

    }

    public Object getTextFieldValue() {

        if (this.textField.isVisible()) {

            return null;

        }

        try {

            return this.editor.getFormat().parse(

                this.editor.getTextField().getText());

        } catch (ParseException e) {

            return null;

        }

    }

    /**

     * Gets the current value of this component. This value can be null.

     * 

     * @return

     */

    public Object getValue() {

        return this.value;

    }

    /**

     * Inits the main graphic user interface

     */

    private void initUI() {

        this.setLayout(new BoxLayout(this, BoxLayout.LINE_AXIS));

        this.editor = new DynFieldEditor(this.field, this.getLocale());

        this.editor.getTextField().addKeyListener(this);

        // Adding components

        this.add(getJSpinner());

        this.add(getJTextField());

        this.add(Box.createHorizontalStrut(3));

        this.add(getBtnEmpty());

        this.add(Box.createHorizontalStrut(4));

    }

    /**

     * Determines if this field is readonly or not.

     * 

     * @return true if it is only readable, false otherwise.

     */

    private boolean isReadOnly() {

        return this.isReadOnly;

    }

    public void keyPressed(KeyEvent e) {

    }

    public void keyReleased(KeyEvent e) {

    }

    public void keyTyped(KeyEvent e) {

        this.fireValueChangedEvent();

    }

    public void setEditable(boolean isEditable) {

        this.textField.setEditable(isEditable);

        getJSpinner().setEnabled(isEditable);

    }

    /**

     * Sets the appropiate components properties for

     * when the value is null.

     */

    private void setEmptyValue() {

        this.value = null;

        // this.editor.setText(null);

        getJSpinner().setVisible(false);

        this.textField.setVisible(true);

        fireValueChangedEvent();

    }

    /**

     * Sets the appropiate components properties for

     * when the value is not null.

     */

    private void setNonEmptyValue(Object value) {

        // this.editor.setText(value);

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

        getJSpinner().setValue(value);

        this.value = getJSpinner().getValue();

        this.textField.setVisible(false);

        getJSpinner().setVisible(true);

        getJSpinner().requestFocus();

        fireValueChangedEvent();

    }

    /**

     * Sets a value if it is not readonly.

     * 

     * @param value

     */

    public void setValue(Object value) {

        if (isReadOnly()) {

            return;

        }

        if (value == null) {

            setEmptyValue();

        } else {

            setNonEmptyValue(value);

        }

    }

}