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;

/**

 * 

 * Minimal interface to start interacting with both the value of a

 * {@link DynObject} and its default value of its {@link DynField}.

 * It also provides information about the readOnly property of the

 * {@link DynField} object.

 * 

 * @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 ValueField {

    /**

     * Returns the value by default that this ValueField has. It must correspond

     * to the default

     * value of the {@link DynField} object.

     * 

     * @return the default value.

     */

    public Object getDefaultFieldValue();

    /**

     * Returns the current DynField.

     * 

     * @return

     *         the current DynField.

     */

    public DynField getDynField();

    /**

     * Returns the current value of this ValueField.It must correspond to the

     * given

     * value of the {@link DynObject} object.

     * 

     * @return the default value.

     */

    public Object getFieldValue();

    /**

     * Modifies the current value of the ValueField. It must correspond to the

     * setValue

     * function of the {@link DynObject} object.

     * 

     * @return the default value.

     */

    public void setFieldValue(Object value);

    /**

     * Sets the current value to the DynObject element.

     * 

     * @param value

     *            the value to be set.

     */

    public void setValue(Object value);

    /**

     * 

     * Gets the parent definition

     * 

     * @return the parent definition

     */

    public DynField getParentDynField();

}