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.api.dynobject.dynfield;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

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

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

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

/**

 * Set of functions shared by both the {@link JDynFieldComponent} and

 * {@link JDynObjectComponent}.

 * 

 * @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 interface JDynComponent {

    /**

     * Returns whether the {@link DynField} value passes the validation phase or

     * not.

     * 

     * @return

     *         <b>true </b> the field value is valid. <br>

     *         <b>false </b> the field value is not valid.

     */

    public boolean isValid();

    /**

     * Specifies which is the component of this class to gain the focus

     * when this function is called.

     */

    public void requestFocus();

    /**

     * Stores the edited data into the {@link DynObject} field.

     * @throws DynFieldValidateException 

     */

    public void saveStatus() throws DynFieldValidateException;

    /**

     * Allows adding a listener to the list of listeners of this JDynComponent.

     * 

     * @param listener

     *            the {@link ValueChangedListener}

     * 

     * @see ValueChangedListener#handleValueChanged(JDynFieldComponent)

     */

    public void addValueChangedListener(ValueChangedListener listener);

    /**

     * @return

     */

    public Object getValue();

        /**

         * Returns if the current component has changes not saved into the source

         * data.

         * 

         * @return if the current component has changes TODO: add the method when

         *         the edition options are enabled again

         */

        // public boolean hasChanges();

}