cvs commit: cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding JXPathBindingBase.java

[jo...@apache.org]

joerg       2004/04/23 16:34:57

  Modified:    src/blocks/forms/java/org/apache/cocoon/forms/formmodel
                        ContainerWidget.java AbstractWidget.java
                        Widget.java
               src/blocks/forms/java/org/apache/cocoon/forms/binding
                        JXPathBindingBase.java
  Log:
  fixed javadoc: notation errors; Widget no longer has children, but ContainerWidget has
  
  Revision  Changes    Path
  1.4       +5 -2      cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/ContainerWidget.java
  
  Index: ContainerWidget.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/ContainerWidget.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- ContainerWidget.java	23 Apr 2004 13:02:31 -0000	1.3
  +++ ContainerWidget.java	23 Apr 2004 23:34:56 -0000	1.4
  @@ -17,7 +17,10 @@
   import java.util.Iterator;
   
   /**
  - * Interface to be implemented by Widgets which contain other widgets.
  + * Interface to be implemented by Widgets which contain other widgets. So all
  + * widgets together form a widget tree, with its root being the {@link Form}
  + * widget, the {@link ContainerWidget}s being the branches/forks, and the
  + * {@link Widget}s with values being the leaves.
    *
    * @version $Id$
    */
  
  
  
  1.13      +3 -3      cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java
  
  Index: AbstractWidget.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- AbstractWidget.java	23 Apr 2004 13:02:31 -0000	1.12
  +++ AbstractWidget.java	23 Apr 2004 23:34:56 -0000	1.13
  @@ -74,8 +74,8 @@
        *
        * If subclasses decide to return <code>null</code> they should also organize 
        * own implementations of {@link #getId()}, {@link #getLocation()},
  -     * {@link #validate(FormContext)}, {@link #generateLabel} and
  -     * {@link #generateDisplayData} to avoid NPE's.
  +     * {@link #validate(FormContext)}, {@link #generateLabel(ContentHandler)} and
  +     * {@link #generateDisplayData(ContentHandler)} to avoid NPE's.
        * 
        * @return the widgetDefinition from which this widget was instantiated. 
        *        (@link WidgetDefinition#createInstance()}
  
  
  
  1.8       +2 -8      cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/Widget.java
  
  Index: Widget.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/Widget.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- Widget.java	23 Apr 2004 13:02:31 -0000	1.7
  +++ Widget.java	23 Apr 2004 23:34:56 -0000	1.8
  @@ -28,19 +28,13 @@
    *
    * <ul>
    *  <li>has an id, unique within its parent context widget. See {@link #getId()}.</li>
  - *  <li>can have children (see {@link #getWidget(String)}, and can have a parent (see {@link #getParent()}.</li>
  + *  <li>can have a parent (see {@link #getParent()}.</li>
    *  <li>can hold a value (which can be any kind of object). See {@link #getValue()}.</li>
    *  <li>can read its value from a request object (and convert it from a string to its native type).
    *  See {@link #readFromRequest(FormContext)}.</li>
    *  <li>can validate itself. See {@link #validate(FormContext)}.</li>
    *  <li>can generate an XML representation of itself.</li>
    * </ul>
  - *
  - * <p>Because widgets can have children, the widgets form a widget tree, with its root
  - * being the {@link Form} widget.</p>
  - *
  - * <p>A widget can have only a value, or only child widgets, or can have both a value and child
  - * widgets, or can have neither. This all depends on the widget implementation.</p>
    *
    * <p>When a request is submitted, first the {@link #readFromRequest(FormContext)} method of all widgets
    * will be called so that they can read their value(s). Next, the {@link #validate(FormContext)} method will
  
  
  
  1.3       +2 -2      cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/JXPathBindingBase.java
  
  Index: JXPathBindingBase.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/JXPathBindingBase.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- JXPathBindingBase.java	23 Apr 2004 11:42:58 -0000	1.2
  +++ JXPathBindingBase.java	23 Apr 2004 23:34:57 -0000	1.3
  @@ -108,7 +108,7 @@
        * @param id of the childWidget to find, if this is <code>null</code> then the parent is returned.
        * @return the selected widget
        * 
  -     * @throws a {@link RuntimeException} if the id is not null and points to a 
  +     * @throws RuntimeException  if the id is not null and points to a 
        *   child-widget that cannot be found. 
        */
       protected Widget selectWidget(Widget parent, String id) {