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

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

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.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.dynobject.exception.DynFieldValidateException;

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.api.usability.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 JNullValueMuttableTextFieldComponent extends JPanel implements

                NullValueMuttableModel, KeyListener, FocusListener {

        /**

     * 

     */

        private static final long serialVersionUID = -7772372354714908644L;

        private JTextField textField;

        private JButton btnEmptyLabel;

        private DynFieldEditor editor;

        private ValueField 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 JNullValueMuttableTextFieldComponent(ValueField field,

                        Object initialValue, Locale locale, ImageIcon btnEmptyImageIcon) {

                super();

                this.setLocale(locale);

                this.field = field;

                this.isReadOnly = field.getDynField().isReadOnly();

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

                }

        }

        public String getValidationMessage() {

                try {

                        this.getDynField().validate(this.getValue());

                        return "";

                } catch (DynFieldValidateException e) {

                        return e.getMessage(3);

                }

        }

        /**

         * Gets the image button component

         * 

         * @return the Image button component

         */

        private JButton getBtnEmpty() {

                if (btnEmptyLabel != null) {

                        return btnEmptyLabel;

                }

                String description = "Empties the field value.";

                btnEmptyLabel = new JButton();

                btnEmptyLabel.setActionCommand("BTN_CLEAR");

                btnEmptyLabel.setOpaque(false);

                btnEmptyLabel.setBorderPainted(false);

                btnEmptyLabel.setBorder(BorderFactory.createEmptyBorder());

                btnEmptyLabel.setHorizontalAlignment(SwingConstants.RIGHT);

                btnEmptyLabel.setVerticalAlignment(SwingConstants.TOP);

                if (icon != null) {

                        icon.setDescription(description);

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

                                        icon.getIconHeight()));

                        btnEmptyLabel.setIcon(icon);

                }

                btnEmptyLabel.addActionListener(new ActionListener() {

                        public void actionPerformed(ActionEvent e) {

                                setEmptyValue();

                        }

                });

                return btnEmptyLabel;

        }

        protected Object getDefaultValue() {

                return this.editor.getDefaultValue();

        }

        public DynField getDynField() {

                return this.field.getDynField();

        }

        /**

         * 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.addFocusListener(new FocusListener() {

                        public void focusGained(FocusEvent e) {

                                setValue(editor.getDefaultValue());

                        }

                        public void focusLost(FocusEvent e) {

                                setValue(editor.getTextFieldValue());

                                fireValueChangedEvent();

                        }

                });

                return textField;

        }

        public Object getTextFieldValue() {

                return this.editor.getTextFieldValue();

        }

        /**

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

         * 

         * @return

         */

        public Object getValue() {

                return this.getTextFieldValue();

        }

        /**

         * Sets the appropiate components properties for when the value is not null.

         */

        private void setNonEmptyValue(Object value) {

                this.editor.setTextFieldValue(value);

                getJSpinner().setValue(this.editor.getTextFieldValue());

                getJSpinner().requestFocus();

                getJSpinner().setVisible(true);

                fireValueChangedEvent();

        }

        /**

         * Inits the main graphic user interface

         */

        private void initUI() {

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

                this.editor = ToolsSwingLocator.getUsabilitySwingManager()

                                .createNullSpinnerEditor(this, this.field.getDynField(),

                                                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.setTextFieldValue(null);

        }

        /**

         * Sets a value if it is not readonly.

         * 

         * @param value

         */

        public void setValue(Object value) {

                if (isReadOnly()) {

                        value = this.getDefaultValue();

                }

                if (value == null) {

                        setEmptyValue();

                } else {

                        setNonEmptyValue(value);

                }

                boolean hasValue = (this.getValue() != null);

                this.textField.setVisible(!hasValue);

                getJSpinner().setVisible(hasValue);

                fireValueChangedEvent();

        }

        public JNullValueMuttableTextFieldComponent getModel() {

                return this;

        }

        public Object getDefaultFieldValue() {

                return field.getDefaultFieldValue();

        }

        public Object getFieldValue() {

                return field.getFieldValue();

        }

        public void setFieldValue(Object value) {

                field.setFieldValue(value);

        }

        public void focusGained(FocusEvent arg0) {

                Object value = getValue();

                if (value == null) {

                        this.setValue(null);

                }

        }

        public void focusLost(FocusEvent arg0) {

                setValue(getValue());

                fireValueChangedEvent();

        }

        public DynField getParentDynField() {

                return field.getDynField();

        }

}