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;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynStruct;

/**

 * 

 * The view model of a given {@link DynField}. It provides layout information

 * about its

 * group and its readonly properties.

 * 

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

    /**

     * Returns the {@link DynStruct} being rendered.

     * 

     * @return the DynClass

     */

    public DynStruct getDefinition();

    /**

     * Returns the {@link DynField} being rendered.

     * 

     * @return the DynField

     */

    public DynField getDynField();

    /**

     * Returns the group in which the {@link DynField} belongs.

     * 

     * @return

     */

    public String getGroup();

    /**

     * Returns if the {@link DynField} is ReadOnly or not.

     * 

     * @return

     */

    public boolean isReadOnly();

    /**

     * Sets the group in which the {@link DynField} belongs.

     * 

     * @param group

     *            the group name.

     * 

     */

    public void setGroup(String group);

    /**

     * Returns if the {@link DynField} is ReadOnly or not.

     * 

     * @param isReadOnly

     * <br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>true </b> the ValueField is read

     *            only, so not writable.<br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>false </b> the ValueField is not

     *            read only, so also writable.

     */

    public void setReadOnly(boolean isReadOnly);

}