/ - Diff - Library: org.gvsig.tools - gvSIG

     package org.gvsig.tools.swing.api;
     import org.gvsig.tools.locator.BaseLocator;
     import org.gvsig.tools.locator.Locator;
     import org.gvsig.tools.swing.api.dynobject.DynObjectSwingManager;
     import org.gvsig.tools.swing.api.usability.UsabilitySwingManager;
     /**
      * Locator for the tools swing Library. Returns references to the library's main
      * {@link Locator} for the tools swing Library. It returns a reference to the
      * library's main
      * utilities.
+     *
      * @author 2010- C?sar Ordi?ana - gvSIG team
-...
+        }
         /**
          * Return the singleton instance.
          * Return the {@link Singleton} instance.
+         *
          * @return the singleton instance
          * @return the {@link Singleton} instance
          */
         public static ToolsSwingLocator getInstance() {
             return instance;
-...
+        }
         /**
          * Registers the Class implementing the DynObjectSwingManager interface.
          * Registers the Class implementing the {@link DynObjectSwingManager}
          * interface.
+         *
          * @param clazz
          *            implementing the DynObjectSwingManager interface
          *            implementing the {@link DynObjectSwingManager} interface
          */
         public static void registerDynObjectSwingManager(
             Class<? extends DynObjectSwingManager> clazz) {
-...
+        }
         /**
          * Registers the Class implementing the UsabilitySwingManager interface.
          * Registers the Class implementing the {@link UsabilitySwingManager}
          * interface.
+         *
          * @param clazz
          *            implementing the UsabilitySwingManager interface
          *            implementing the {@link UsabilitySwingManager} interface
          */
         public static void registerUsabilitySwingManager(
             Class<? extends UsabilitySwingManager> clazz) {
-...
+        }
         /**
          * Return the Locator's name
          * Return the {@link Locator}'s name
+         *
          * @return a String with the Locator's name
          * @return a String with the {@link Locator}'s name
          */
         public String getLocatorName() {
             return LOCATOR_NAME;

         @Override
         protected void doPostInitialize() throws LibraryException {
             // Validate there is any DynObjectSwingManager implementation
             // Validates if there is any DynObjectSwingManager implementation
             // registered.
             DynObjectSwingManager dynObjectSwingManager =
                 ToolsSwingLocator.getDynObjectSwingManager();
-...
                     ToolsSwingLocator.getInstance());
+            }
             // Validate there is any UsabilitySwingManager implementation
             // Validates if there is any UsabilitySwingManager implementation
             // registered.
             UsabilitySwingManager usabilitySwingManager =
                 ToolsSwingLocator.getUsabilitySwingManager();

     /* 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;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
+     *
      */
     public interface DynFieldComponentModel {
         /**
          * Returns the {@link DynClass} being rendered.
+         *
          * @return the DynClass
          */
         public DynClass getDynClass();
         /**
          * Returns the {@link DynField} being rendered.
+         *
          * @return the DynField
          */
         public DynField getDynField();
         public String getGroup();
         public boolean isReadOnly();
         public void setGroup(String group);
         public void setReadOnly(boolean isReadOnly);
+    }

     /* 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;
     /**
+     *
      * 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 DynClass} being rendered.
+         *
          * @return the DynClass
          */
         public DynClass getDynClass();
         /**
          * 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);
+    }

     import java.util.List;
     import org.gvsig.tools.dynobject.DynField;
     import org.gvsig.tools.dynobject.DynObject;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
+     *
      * The view model of a given {@link DynObject}. It allows to add
      * {@link DynField}s into different
      * view groups, by defining different {@link DynFieldModel}s.
+     *
      * @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 DynObjectModel {
         public DynFieldComponentModel add(String fieldName);
         /**
          * Creates a new {@link DynFieldModel} with the given <b>group</b> and
          * <b>fieldName</b>.
          * This {@link DynFieldModel} is then added to the list of
          * {@link DynFieldModel}s of this DynObjectModel
          * and then returned.
+         *
          * @param group
          *            the group name of the associated {@link DynField}. If null,
          *            the group name will be set to <b>"General"</b>.
          * @param fieldName
          *            the id name of the associated {@link DynField}.
          * @return
          *         the newly created {@link DynFieldModel} added to the list.
          */
         public DynFieldModel add(String group, String fieldName);
         public DynFieldComponentModel add(String group, String fieldName);
         /**
          * Creates a new {@link DynFieldModel} within the default "General"
          * <b>group</b>, but with the given <b>fieldName</b>.
          * This {@link DynFieldModel} is then added to the list of
          * {@link DynFieldModel}s of this DynObjectModel
          * and then returned.
+         *
          * @param fieldName
          *            the id name of the associated {@link DynField}.
          * @return
          *         the newly created {@link DynFieldModel} added to the list.
          */
         public DynFieldModel add(String fieldName);
         /**
          * Adds a group name to the {@link DynFieldModel}.
+         *
          * @param group
          *            the group name.
          */
         public void addGroup(String group);
         /**
          * Retrieves the list of {@link DynFieldModel}s based on the group name.
+         *
          * @param group
          *            the group name.
          * @return
          *         the list of {@link DynFieldModel}s.
          */
         public List getGroupElements(String group);
         /**
          * Return an array of group names available for this {@link DynFieldModel}.
+         *
          * @return
          *         the array of group names.
          */
         public String[] getGroups();
+    }

     import org.gvsig.tools.swing.api.dynobject.set.JDynObjectSetComponent;
     /**
      * Manager for DynObject related Swing components.
      * Manager for {@link DynObject} related Swing components.
+     *
      * @author gvSIG team
      * @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 DynObjectSwingManager extends Manager {

     import org.gvsig.tools.service.spi.ServiceFactory;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
+     *
      * Factory that creates and returns a {@link JDynObjectComponent}.
+     *
      * @see ServiceFactory
+     *
      * @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 JDynObjectComponentFactory extends ServiceFactory {
         /**
+         *
          * Creates a new JDynObjectComponent base on its {@link DynObject} and its
          * {@link DynObjectModel}.
+         *
          * @param dynObject
          *            the current {@link DynObject}.
          * @param model
          *            the {@link DynObjectModel} that specifies which values are to
          *            be displayed.
          * @return
          *         the {@link JDynObjectComponent} object.
          * @throws ServiceException
          */
         public JDynObjectComponent createJDynObjectComponent(DynObject dynObject,
             DynObjectModel model) throws ServiceException;

     import java.util.EventListener;
     import org.gvsig.tools.swing.api.dynobject.dynfield.JDynComponent;
     import org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
+     *
      * {@link EventListener} to be fired to notify that a value of a
      * JDynFieldComponent has been changed.
+     *
      * @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 ValueChangedListener extends EventListener {
         public void handleValueChanged(JDynFieldComponent field);
         /**
+         *
          * This function is called to each {@link ValueChangedListener} contained in
          * a {@link JDynComponent} whenever a value has changed.
+         *
          * @param jDynFieldComponent
          *            the JDynFieldComponent that changed its value and caused this
          *            event.
          */
         public void handleValueChanged(JDynFieldComponent jDynFieldComponent);
+    }

     import org.gvsig.tools.dynobject.DynObject;
     import org.gvsig.tools.swing.api.ComponentService;
     import org.gvsig.tools.swing.api.dynobject.dynfield.JDynComponent;
     import org.gvsig.tools.swing.api.dynobject.dynfield.ValueField;
     /**
      * Component which is able to render a {@link DynObject}
      * Component able to render a {@link DynObject}.
+     *
      * @author 2010- C?sar Ordi?ana - gvSIG team
      * @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 JDynObjectComponent extends ValueChangedListener,
         ComponentService {
     public interface JDynObjectComponent extends JDynComponent, ValueField,
         ComponentService, ValueChangedListener {
         public static class PARAMETERS {
-...
+        }
         /**
          * Returns the {@link DynObject} being rendered.
          * Returns the {@link DynObject} to be rendered.
+         *
          * @return the DynObject
          * @return the {@link DynObject}
          */
         public abstract DynObject getDynObject();
         public DynObject getDynObject();
         /**
          * Returns the {@link DynObject} being rendered.
          * Returns the {@link DynObject} to be rendered.
+         *
          * @return the DynObject
          * @return the {@link DynObject}
          */
         public abstract DynObjectModel getModel();
         public DynObjectModel getModel();
         /**
          * @return
          */
         public abstract boolean isValid();
         /**
          * Sets the current value into the {@link DynObject} value. This should be
          * used only
          * when we really want to alter the value of the {@link DynObject}.
+         *
          * @param value
          * <br>
          *            &nbsp;&nbsp;&nbsp;&nbsp;the Value to be set.
          */
         public abstract void requestFocus();
         public void setValue(Object value);
         /**
          * Stores the edited data into the DynObject.
          */
         public abstract void saveStatus();
         /**
          * @param object
          */
         public abstract void setValue(Object dynObject);
         /**
          * @param listener
          */
         public abstract void addValueChangedListener(ValueChangedListener listener);
+    }

      */
     package org.gvsig.tools.swing.api.dynobject.dynfield;
     import org.gvsig.tools.dynobject.DynField;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
+     *
      * Minimal interface to interact with the Value of a {@link DynField}.
+     *
      * @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 ValueField {
         /**
          * Returns the value by default that this ValueField has.
+         *
          * @return the default value.
          */
         public Object getDefaultValue();
         /**
          * Returns the current value of this ValueField.
+         *
          * @return the default value.
          */
         public Object getValue();
         /**
          * Modifies the current value of the ValueField.
+         *
          * @return the default value.
          */
         public void setValue(Object value);
+    }

     /* 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.dynobject.DynObject;
     import org.gvsig.tools.swing.api.dynobject.JDynObjectComponent;
     import org.gvsig.tools.swing.api.dynobject.ValueChangedListener;
     /**
      * Set of functions shared by both the {@link JDynFieldComponent} and
      * {@link JDynObjectComponent}.
+     *
      * @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 JDynComponent {
         /**
          * Returns whether the {@link DynField} value passes the validation phase or
          * not.
+         *
          * @return
          *         <b>true </b> the field value is valid. <br>
          *         <b>false </b> the field value is not valid.
          */
         public boolean isValid();
         /**
          * Specifies which is the component of this class to gain the focus
          * when this function is called.
          */
         public void requestFocus();
         /**
          * Stores the edited data into the {@link DynObject} field.
          */
         public void saveStatus();
         /**
          * Allows adding a listener to the list of listeners of this JDynComponent.
+         *
          * @param listener
          *            the {@link ValueChangedListener}
+         *
          * @see ValueChangedListener#handleValueChanged(JDynFieldComponent)
          */
         public void addValueChangedListener(ValueChangedListener listener);
+    }

      *   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.dynobject.DynObject;
     import org.gvsig.tools.swing.api.ComponentService;
     import org.gvsig.tools.swing.api.dynobject.ValueChangedListener;
     /**
      * @author <a href="mailto:reinhold@uji.es">cmartin</a>
      * 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, ComponentService {
     public interface JDynFieldComponent extends ValueField, JDynComponent,
         ComponentService {
         /**
          * DynObject parameters used for DynObjectServices for the exchange
          * of information.
          */
         public static class PARAMETERS {
             public static String MANAGER = "manager";
-...
             public static String PARENT = "dynfield";
+        }
         public void addValueChangedListener(ValueChangedListener listener);
         /**
          * Returns the {@link DynField} to be rendered.
+         *
          */
         public void fireValueChangedEvent();
         /**
          * Returns the {@link DynField} being rendered.
+         *
          * @return the DynField
          */
         public DynField getDynField();
         public Object getFieldValue();
         public boolean isMandatory();
         /**
          * Returns the {@link DynObject} being rendered.
          * Returns the {@link DynObject} to be rendered.
+         *
          * @return the DynObject
          */
         // public DynObject getDynObject();
         public boolean isValid();
         /**
          * Gets the {@link DynField}'s value at this particular moment, if any.
+         *
+         *
          * @return
          *         the current {@link DynField}'s value, <b>null</b> otherwise.
          */
         public void requestFocus();
         public Object getFieldValue();
         /**
          * Stores the edited data into the DynObject field.
          * 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 void saveStatus();
         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);
         /**
          * Sets the current value into the {@link DynField} value. This should be
          * used only
          * when we really want to alter the value of the {@link DynField}.
+         *
          * @param value
          * <br>
          *            &nbsp;&nbsp;&nbsp;&nbsp;the Value to be set.
          */
         public void setFieldValue(Object value);
         /**
          * 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();
+    }

         /**
          * Creates a button with no set text or icon.
+         *
          * @return a button
          * @return a button.
          */
         JButton createJButton();
-...
          * supplied.
+         *
          * @param action
          *            the {@link Action} used to specify the new button
          *            the {@link Action} used to specify the new button.
+         *
          */
         JButton createJButton(Action action);
         //
         // /**
         // * @param component1
         // * @param component2
         // * @param marginLeft
         // * @param marginRight
         // * @param button
         // * @return
         // */
         // public JPanel createGridBagRowPanel(JPanel gridBagPanel, Component
         // labelComponent,
         // Component fieldLabel,
         // Integer marginLeft, Integer marginRight);
         //
         // /**
         // * @param panel
         // * @param component1
         // * @param component2
         // * @param marginLeft
         // * @param marginRight
         // * @return
         // */
         // JPanel createBoxRowPanel(JPanel panel, Component component1,
         // Component component2, Integer marginLeft, Integer marginRight);
         /**
          * Creates a button with an icon.
+         *
          * @param icon
          *            the Icon image to display on the button
          *            the Icon image to display on the button.
+         *
          * @return a button
          * @return a button.
          */
         JButton createJButton(Icon icon);
-...
          * Creates a button with text.
+         *
          * @param text
          *            the text of the button
          *            the text of the button.
+         *
          * @return a button
          * @return a button.
          */
         JButton createJButton(String text);
-...
          * Creates a button with initial text and icon.
+         *
          * @param text
          *            the text of the button
          *            the text of the button.
          * @param icon
          *            the Icon image to display on the button
          *            the Icon image to display on the button.
+         *
          * @return a button
          * @return a button.
          */
         JButton createJButton(String text, Icon icon);
         /**
          * Creates a tool button with text.
+         *
          * @param text
          *            the text of the tool button.
+         *
          * @return a tool button.
          */
         JButton createJToolButton(String text);
+    }

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

Revision 272