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.

 * 

 */

package org.gvsig.tools.swing.spi;

import java.awt.BorderLayout;

import java.awt.Component;

import java.util.ArrayList;

import java.util.List;

import javax.swing.BorderFactory;

import javax.swing.Box;

import javax.swing.BoxLayout;

import javax.swing.JButton;

import javax.swing.JPanel;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.exception.DynFieldValidateException;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.ServiceException;

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

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

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;

/**

 * Component which is able to render a {@link DynObject} attribute value.

 * 

 * @author 2010- C?sar Ordi?ana - gvSIG team

 */

public abstract class AbstractJDynFieldComponent extends AbstractJDynField

        implements JDynFieldComponent {

    private static final long serialVersionUID = 7833217085675382320L;

    private final DynObjectSwingManager manager;

    private final List<ValueChangedListener> listeners;

    private final ValueField fieldValue;

    /**

     * Constructor.

     * 

     * @param dynField

     *            the field of the {@link DynObject} to render

     * @param dynObject

     *            the {@link DynObject} with the attribute to render

     */

    public AbstractJDynFieldComponent(DynField dynField, ValueField value)

            throws ServiceException {

        super(dynField);

        fieldValue = value;

        listeners = new ArrayList<ValueChangedListener>();

        // this.dynObject = dynObject.getDynObject();

        manager = ToolsSwingLocator.getDynObjectSwingManager();

        this.init();

    }

    /*

     * (non-Javadoc)

     * 

     * @seeorg.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#

     * addValueChangedListener

     * (org.gvsig.tools.swing.api.dynobject.ValueChangedListener)

     */

    public void addValueChangedListener(ValueChangedListener listener) {

        // If it was the first item, we need to

        // initialize Component listeners

        // add listener to the dynfield set of listeners

        listeners.add(listener);

        // set supplementary listeners.

        this.setJDynFieldComponentListeners();

    }

    protected JPanel createBoxLayout(Component component1,

            Component component2, Integer marginLeft, Integer marginRight,

            JPanel container) {

        return this.createBoxRowPanel(container, component1, component2,

                marginLeft, marginRight);

    }

    public void setValue(Object value){

        if (value==null)

            setNullValue();

        else 

            setNonNullValue(value);

        this.fireValueChangedEvent();

    }

    /**

     * @param value

     */

    protected abstract void setNonNullValue(Object value);

    /**

     * 

     */

    protected abstract void setNullValue();

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.usability.UsabilitySwingManager#createBoxRowPanel

     * (javax.swing.JPanel, java.awt.Component, java.awt.Component,

     * java.lang.Integer, java.lang.Integer)

     */

    public JPanel createBoxRowPanel(JPanel panel, Component labelComponent,

            Component fieldLabel, Integer marginLeft, Integer marginRight) {

        // Create a panel that uses GridLayout.

        JPanel pane = new JPanel();

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

        pane.add(labelComponent);

        if (marginLeft != null)

            pane.add(Box.createHorizontalStrut(marginLeft));

        // pane.add(new JSeparator(SwingConstants.VERTICAL));

        if (marginRight != null)

            pane.add(Box.createHorizontalStrut(marginRight));

        pane.add(fieldLabel, BorderLayout.NORTH);

        // if (buttonComponent!=null)

        // pane.add(buttonComponent);

        pane.setBorder(BorderFactory.createEmptyBorder(1, 1, 1, 1));

        return pane;

    }

    protected JButton createButton(String text) {

        return ToolsSwingLocator.getUsabilitySwingManager().createJToolButton(

                this.translate(text));

    }

    /*

     * (non-Javadoc)

     * 

     * @seeorg.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent#

     * raiseValueChangedEvent()

     */

    public void fireValueChangedEvent() {

        for (ValueChangedListener listener : listeners)

            listener.handleValueChanged(this);

    }

    /**

     * Returns the default value of the {@link DynObject}'s field to manage.

     * 

     * @return the default field's value if any, else null

     */

    protected Object getDefaultFieldValue() {

        return this.getDynField().getDefaultValue();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

     */

    public Object getDefaultValue() {

        return fieldValue.getDefaultValue();

    }

    protected String getFieldName() {

        return this.getDynField().getName();

    }

    /**

     * @return

     */

    @Override

    public Object getFieldValue() {

        Object value = fieldValue.getValue();

        if (value == null)

            return fieldValue.getDefaultValue();

        return value;

    }

    /**

     * Returns the value of the {@link DynObject}'s field to manage.

     * 

     * @return the field's value

     */

    protected Object getFieldValue(ValueField fieldValue) {

        return fieldValue.getValue();

    }

    /*

     * (non-Javadoc)

     * 

     * @see org.gvsig.tools.service.Service#getManager()

     */

    public Manager getManager() {

        return manager;

    }

    public boolean isMandatory() {

        return this.getDynField().isMandatory();

    }

    /**

     * @return

     */

    protected boolean isReadOnly() {

        return this.getDynField().isReadOnly();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

     */

    public boolean isValid() {

        // Object value = getValue();

        // if ((value==null)||(value.equals("")))

        // if (isMandatory())

        // return false;

        // else if (value==null)

        // return true;

        return this.validate(this.getValue());

    }

    /**

     * Stores the edited data into the DynObject field.

     */

    public void saveStatus() {

        this.setFieldValue(this.getValue());

    }

    /**

     * Sets the value of the {@link DynObject}'s field to manage.

     * 

     * @param value

     *            the value for the field

     */

    public void setFieldValue(Object value) {

        if (validate(value))

            fieldValue.setValue(value);

    }

    /**

         * 

         */

    protected abstract void setJDynFieldComponentListeners();

    protected String translate(String text) {

        return ToolsLocator.getI18nManager().getTranslation(text);

    }

    /**

     * @param value

     */

    private boolean validate(Object value) {

        try {

            this.getDynField().validate(value);

            return true;

        } catch (DynFieldValidateException e) {

            return false;

        }

    }

}