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

import java.awt.Component;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import org.gvsig.tools.dynobject.DynObject;

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

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

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

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 2010 - <a href="cordinyana@gvsig.org">C?sar Ordi?ana</a> - gvSIG Team

 * @author 2010 - <a href="mailto:reinhold@uji.es">Cristian Mart?n&nbsp;</a> -

 *         gvSIG Team

 * @version $Id$

 * 

 */

public abstract class AbstractDynObjectComponent implements

    JDynObjectComponent, ValueField {

    private static final long serialVersionUID = 4088620749911859250L;

    private final DynObject dynObject;

    private DynObjectModel model;

    private final DynObjectSwingManager manager;

    private Map<Component, JDynFieldComponent> componentField;

    /**

     * Constructor.

     * 

     * @param dynObject

     *            the {@link DynObject} to render

     */

    public AbstractDynObjectComponent(DynObject dynObject, DynObjectModel model) {

        this.dynObject = dynObject;

        if (model == null) {

            try {

                this.model =

                    ToolsSwingLocator.getDynObjectSwingManager()

                        .createDynObjectModel(this.dynObject.getDynClass());

            } catch (ServiceException e) {

                // TODO Auto-generated catch block

                e.printStackTrace();

            }

        } else {

            this.model = model;

        }

        manager = ToolsSwingLocator.getDynObjectSwingManager();

    }

    /**

     * Adds a new JDynFieldComponent to the list.

     * 

     * @param component

     *            the java awt Component

     * @param input

     *            the correspondent JDynFieldComponent object

     */

    protected void addComponentToList(Component component,

        JDynFieldComponent input) {

        this.getComponents().put(component, input);

    }

    /*

     * (non-Javadoc)

     * 

     * @seeorg.gvsig.tools.swing.api.dynobject.JDynObjectComponent#

     * addValueChangedListener

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

     */

    public void addValueChangedListener(ValueChangedListener listener) {

        Iterator<JDynFieldComponent> componentFields =

            this.getComponents().values().iterator();

        JDynFieldComponent comp;

        while (componentFields.hasNext()) {

            comp = componentFields.next();

            comp.addValueChangedListener(listener);

        }

    }

    /**

     * 

     * Sets all FieldValues of this {@link JDynObjectComponent} to null.

     * 

     */

    protected void emptyAll() {

        Map<Component, JDynFieldComponent> items = this.getComponents();

        for (JDynFieldComponent item : items.values()) {

            item.setValue(null);

        }

    }

    /**

     * Sets all FieldValues of this {@link JDynObjectComponent} to its the

     * current values

     * of the same FieldValues at the {@link DynObject} given as input.

     * 

     * @param value

     */

    protected void fillValues(DynObject dynObject) {

        Map<Component, JDynFieldComponent> items = this.getComponents();

        for (JDynFieldComponent item : items.values()) {

            item.setValue(dynObject.getDynValue(item.getDynField().getName()));

        }

    }

    /**

     * Gets the map of all graphic JDynFieldComponents of this

     * JDynObjectComponent.

     * 

     * @return

     *         the map containing the graphic Components.

     */

    private Map<Component, JDynFieldComponent> getComponents() {

        if (componentField == null) {

            componentField = new HashMap<Component, JDynFieldComponent>();

        }

        return componentField;

    }

    /*

     * (non-Javadoc)

     * 

     * @see

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

     */

    public Object getDefaultValue() {

        return this.getDynObject();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.impl.dynobject.JDynbjectComponent#getDynObject()

     */

    public DynObject getDynObject() {

        return dynObject;

    }

    //

    // public Object getValue() {

    // return this.getDynObject();

    // }

    /**

     * 

     * Returns a {@link JDynFieldComponent} that best matches with the given

     * {@link ValueField} and adds, if any, the given listener to the

     * JDynFieldComponent listeneres.

     * 

     * @param valueItem

     *            the {@link ValueField} element.

     * @param listener

     *            the current {@link ValueChangedListener} to be added to the

     *            JDynFieldComponent listeners.

     * @return

     *         the {@link JDynFieldComponent}.

     * 

     * @throws ServiceException

     */

    protected JDynFieldComponent getJDynFieldComponent(ValueField valueItem,

        ValueChangedListener listener) throws ServiceException {

        JDynFieldComponent jfield =

            ((DynObjectSwingManager) this.getManager())

                .createJDynFieldComponent(valueItem);

        if (listener != null) {

            jfield.addValueChangedListener(listener);

            jfield.fireValueChangedEvent();

        }

        return jfield;

    }

    /*

     * (non-Javadoc)

     * 

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

     */

    public Manager getManager() {

        return manager;

    }

    /*

     * (non-Javadoc)

     * 

     * @see org.gvsig.tools.swing.impl.dynobject.JDynbjectComponent#getModel()

     */

    public DynObjectModel getModel() {

        return model;

    }

    public boolean isValid() {

        Map<Component, JDynFieldComponent> items = this.getComponents();

        for (JDynFieldComponent item : items.values()) {

            if (!item.isValid()) {

                return false;

            }

        }

        return true;

    }

    /**

     * Walks through all JDynFieldComponents to save its current values into

     * their DynObject.

     */

    public void saveStatus() {

        Iterator<JDynFieldComponent> componentFields =

            this.getComponents().values().iterator();

        JDynFieldComponent comp;

        while (componentFields.hasNext()) {

            comp = componentFields.next();

            comp.saveStatus();

        }

    }

}