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.

 * 

 */

package org.gvsig.tools.swing.api.dynobject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectSet;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.ServiceException;

import org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent;

import org.gvsig.tools.swing.api.dynobject.dynfield.ValueField;

import org.gvsig.tools.swing.api.dynobject.set.JDynObjectSetComponent;

/**

 * Manager for DynObject related Swing components.

 * 

 * @author gvSIG team

 */

public interface DynObjectSwingManager extends Manager {

        /** Full DynObject visualization or editing form mode. */

        public static final String MODE_FORM = "form";

        /** DynObject visualization in a list mode. */

        public static final String MODE_LIST = "list";

        /**

         * Creates a {@link JDynFieldComponent} to render a {@link DynObject} field.

         * 

         * @param dynClass

         *            with the value to render

         * @return the component

         * @throws ServiceException

         */

        public DynObjectModel createDynObjectModel(DynClass dynClass)

                        throws ServiceException;

        /**

         * Creates a {@link JDynFieldComponent} to render a {@link DynObject} field.

         * 

         * @param dynClass

         *            with the value to render

         * @return the component

         * @throws ServiceException

         */

        public DynObjectModel createEmptyDynObjectModel(DynClass dynClass)

                        throws ServiceException;

        /**

         * Creates a {@link JDynFieldComponent} to render a {@link DynObject} field.

         * 

         * @param field

         *            to render

         * @param dynObject

         *            with the value to render

         * @return the component

         * @throws ServiceException

         */

        public JDynFieldComponent createJDynFieldComponent(ValueField valueItem,

                        DynField field) throws ServiceException;

        /**

         * Creates a {@link JDynObjectComponent} for a {@link DynObject} in the

         * default mode.

         * 

         * @param dynObject

         *            to create the component for

         * @return a {@link JDynObjectComponent}

         * @throws ServiceException

         */

        public JDynObjectComponent createJDynObjectComponent(DynObject dynObject)

                        throws ServiceException;

        /**

         * Creates a {@link JDynObjectComponent} for a {@link DynObject}.

         * 

         * @param dynObject

         *            to create the component for

         * @param mode

         * @return a {@link JDynObjectComponent}

         * @throws ServiceException

         */

        public JDynObjectComponent createJDynObjectComponent(DynObject dynObject,

                        DynObjectModel model) throws ServiceException;

        /**

         * Creates a {@link JDynObjectComponent} for a {@link DynObject}.

         * 

         * @param dynObject

         *            to create the component for

         * @param mode

         * @return a {@link JDynObjectComponent}

         * @throws ServiceException

         */

        public JDynObjectComponent createJDynObjectComponent(DynObject dynObject,

                        DynObjectModel model, String mode) throws ServiceException;

        /**

         * Creates a {@link JDynObjectComponent} for a {@link DynObject}.

         * 

         * @param dynObject

         *            to create the component for

         * @param mode

         * @return a {@link JDynObjectComponent}

         * @throws ServiceException

         */

        public JDynObjectComponent createJDynObjectComponent(DynObject dynObject,

                        String mode) throws ServiceException;

    /**

     * Creates a {@link JDynObjectSetComponent} to render a {@link DynObjectSet}

     * .

     * 

     * @param dynObjectSet

     *            to create the component for

     * @return a {@link JDynObjectSetComponent}

     * @throws BaseException

     *             if there is an error creating the component

     */

        public JDynObjectSetComponent createJDynObjectSetComponent(

        DynObjectSet dynObjectSet) throws BaseException;

}