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.swing.api.ComponentService;

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

/**

 * Object created by {@link JDynFieldComponentFactory} via its

 * createJDynFieldComponent()

 * function.

 * 

 * JDynFieldComponent is the Java graphic representation of a DynField's value.

 * It has, apart from all the {@link ValueField} functionalities, a function

 * inherited

 * from the {@link ComponentService} interface to obtain the Java Component.

 * 

 * @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 JDynFieldComponent extends ValueField, JDynComponent,

    ComponentService {

    /**

     * DynObject parameters used for DynObjectServices for the exchange

     * of information.

     */

    public static class PARAMETERS {

        public static String DYNFIELD = "dynfield";

        public static String PARENT = "parent";

        public static String WRITABLE = "writable";

    }

    /**

     * Returns the {@link DynField} to be rendered.

     * 

     * @return the DynField

     */

    public DynField getDynField();

    /**

     * Returns the {@link DynObject} to be rendered.

     * 

     * @return the DynObject

     */

    // public DynObject getDynObject();

    /**

     * Gets the {@link DynField}'s value at this particular moment, if any.

     * 

     * 

     * @return

     *         the current {@link DynField}'s value, <b>null</b> otherwise.

     */

    public Object getInitialValue();

    /**

     * Returns if the {@link DynField} is set to be compulsory or not.

     * 

     * @return

     *         <b>true </b> the field is compulsory. <br>

     *         <b>false </b> the field is optional.

     */

    public boolean isMandatory();

    /**

     * Specifies if this JDynFieldComponent is to be enabled or not.

     * 

     * @param isEnabled

     * <br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>true </b> the component is enabled.<br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>false </b> the component is

     *            disabled.

     */

    public void setEnabled(boolean isEnabled);

    /**

     * Walks through the list of {@link ValueChangedListener} objects and

     * calls the <b>handleValueChanged</b> function by specifying this

     * JDynFieldComponent object

     * as the one that has been changed.

     * 

     * @see ValueChangedListener#handleValueChanged(JDynFieldComponent)

     */

    public void fireValueChangedEvent();

}