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.dynobject.DynObjectSet;

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

public interface JDynFormSet  extends Component {

        public static final String ACTION_FIRST = "first";

        public static final String ACTION_PREVIOUS = "previous";

        public static final String ACTION_NEXT = "next";

        public static final String ACTION_LAST = "last";

        public static final String ACTION_SAVE = "save";

        public static final String ACTION_NEW = "new";

        public static final String ACTION_CANCEL_NEW = "cancel-new";

        public static final String ACTION_DELETE = "delete";

        public static final String ACTION_SEARCH = "search";

        public static final String ACTION_CLOSE = "close";

        public static final String ACTION_SET_CURRENT_RECORD = "set-current-record";

        public static final String ACTION_NAVIGATION = "#navigation";

        public interface JDynFormSetListener {

                public void formMessage(String message);

                public void formClose();

                public void formMovedTo(int currentPosition) throws AbortActionException;

                public void formBeforeSave(JDynFormSet dynformSet) throws AbortActionException;

                public void formBeforeNew(JDynFormSet dynformSet) throws AbortActionException;

                public void formBeforeCancelNew(JDynFormSet dynformSet) throws AbortActionException;

                public void formBeforeDelete(JDynFormSet dynformSet) throws AbortActionException;

                public void formBeforeSearch(JDynFormSet dynformSet) throws AbortActionException;

                public void formAfterSave(JDynFormSet dynformSet) throws AbortActionException;

                public void formAfterNew(JDynFormSet dynformSet) throws AbortActionException;

                public void formAfterCancelNew(JDynFormSet dynformSet) throws AbortActionException;

                public void formAfterDelete(JDynFormSet dynformSet) throws AbortActionException;

                public void formAfterSearch(JDynFormSet dynformSet) throws AbortActionException;

        }

        public void setLayoutMode(int layoutMode);

        public int getLayoutMode();

        public boolean hasValidValues();

        public boolean hasValidValues(List<String> fieldsName);

        public void setValues(DynObjectSet values);

        public void setValues(List values);

        public List getValues();

        public void message();

        public void message(String msg);

        public void setReadOnly(boolean readOnly);

        public boolean isReadOnly();

        public void addListener(JDynFormSetListener listener);

        public void removeListener(JDynFormSetListener listener);

        public boolean isAutosave();

        public void setAutosave(boolean autosave);

        public boolean allowUpdate();

        public boolean allowDelete();

        public boolean allowNew();

        public boolean allowSearch();

        public boolean allowClose();

        public void setAllowUpdate(boolean allowUpdate);

        public void setAllowDelete(boolean allowDelete);

        public void setAllowNew(boolean allowNew);

        public void setAllowSearch(boolean allowSearch);

        public void setAllowClose(boolean allowClose);

        public void setFormSize(int width, int height);

        public DynObject get(int position);

        public int getCurrentIndex();

        public int countValues();

        /**

         * Set the current element of form.

         * If the form is modified, the changes will be lost.

         * @param index 

         */

        public void setCurrentIndex(int index);

        public boolean isInNewState();

        public void addAction(Action action);

        public Action getAction(String actionId);

        public List<Action> getActions();

        public void setActionVisible(String action, boolean visible);

        public void setActionEnabled(String action, boolean enabled);

        public boolean isActionVisible(String action);

        public boolean isActionEnabled(String action);

        public JComponent getActionButton(String action);

        public void fireEvent(String action, Object value);

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

        public void addSeparatorToPopupMenu(DataType tipo);

        public void setUseScrollBars(boolean usesScrolls);

        public boolean getUseScrollBars();

        public void getFormValues(DynObject values);

        public JDynForm getForm();

}