Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.dynform;

import java.util.List;

import javax.swing.Action;

import javax.swing.JComponent;

import org.gvsig.tools.dataTypes.DataType;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.tools.util.PropertiesSupport;

import org.gvsig.tools.resourcesstorage.ResourcesStorage;

import org.gvsig.tools.script.Script;

import org.gvsig.tools.script.ScriptManager;

public interface JDynForm extends Component, PropertiesSupport {

        public interface JDynFormListener {

                public void message(String message);

                /**

                 * This event is fired when a field of the form is changed by the user.

                 * 

                 * Now this is not yet implemented.

                 * 

                 * @param field 

                 */

                public void fieldChanged(JDynFormField field);

        }

        public interface DynFormContext {

            public ResourcesStorage getResourcesStorage();

            public ScriptManager getScriptManager();

        }

        public static final int USE_PLAIN = 0;

        public static final int USE_TABS = 1;

        public static final int USE_SEPARATORS = 2;

        public static final int USE_TREE = 3;

        public void setLayoutMode(int layoutMode);

        public int getLayoutMode();

        public int getFormWidth();

        public int getFormHeight();

        public void setFormSize(int width, int height);

        public JDynFormField getField(String fieldName);

//        public Collection<JDynFormField> getShowFields();

        public DynFormDefinition getDefinition();

        public void setValues(DynObject values);

        public void getValues(DynObject values);

        public Object getValue(String fieldName);

        public void setValue(String fieldName, Object value);

        public boolean hasValidValues();

        public boolean hasValidValues(List<String> fieldsName);

        public void message();

        public void message(String msg);

        public void setReadOnly(boolean readOnly);

        public boolean isReadOnly();

        public void setShowMessageStatus(boolean showMessageStatus);

        public boolean isShowMessageStatus();

        public void setUseScrollBars(boolean usesScrolls);

        public boolean getUseScrollBars();

        public boolean isModified();

        public void addListener(JDynFormListener listener);

        public void removeListener(JDynFormListener listener);

        public void addActionToPopupMenu(DataType tipo, String name, Action action);

        public void addSeparatorToPopupMenu(DataType tipo);

        public JComponent getFieldsContainer();

        public void clear();

        public DynFormContext getContext();

        public void setContext(DynFormContext context);

        public Script getScript();

        public Object callUserFunction(String function, Object...args) throws Exception;

}