Spring Rich Client

Revision: 1769
          http://svn.sourceforge.net/spring-rich-c/?rev=1769&view=rev
Author:   anodos
Date:     2007-06-26 09:10:58 -0700 (Tue, 26 Jun 2007)

Log Message:
-----------
RCP-478 - Pass Form reference to FormUIProvider.bind to support binding child forms

Modified Paths:
--------------
    trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/AbstractFormUIProvider.java
    trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/FormUIProvider.java
    trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/GeneratedForm.java
    trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/form/DefaultFormUIProviderTests.java

Modified: trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/AbstractFormUIProvider.java
===================================================================
--- trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/AbstractFormUIProvider.java	2007-06-18 06:37:41 UTC (rev 1768)
+++ trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/AbstractFormUIProvider.java	2007-06-26 16:10:58 UTC (rev 1769)
@@ -36,7 +36,7 @@
     private String[] properties;
     private Map contextMap = new HashMap();
 
-    public void bind(BindingFactory factory) {
+    public void bind(BindingFactory factory, Form form) {
         Assert.state(properties != null && properties.length > 0, "Properties must be set");
 
         bound = true;

Modified: trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/FormUIProvider.java
===================================================================
--- trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/FormUIProvider.java	2007-06-18 06:37:41 UTC (rev 1768)
+++ trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/FormUIProvider.java	2007-06-26 16:10:58 UTC (rev 1769)
@@ -44,8 +44,9 @@
    * 
    * @param factory the <code>BindingFactory</code> this form provider should
    *        use to bind the provided form.
+   * @param form the <code>Form</code> being bound.
    */
-  void bind(BindingFactory factory);
+  void bind(BindingFactory factory, Form form);
 
   /**
    * Provides access to individual components of this pre-generated form.
@@ -54,7 +55,7 @@
    * typically these IDs will be the same as the property names of the
    * object backing the form.
    *
-   * @param componentId
+   * @param componentId component id to lookup
    *
    * @return component with the specified id, or <code>null</code> if no
    *         component exists in this pre-generated form with the given id.

Modified: trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/GeneratedForm.java
===================================================================
--- trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/GeneratedForm.java	2007-06-18 06:37:41 UTC (rev 1768)
+++ trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/form/GeneratedForm.java	2007-06-26 16:10:58 UTC (rev 1769)
@@ -21,6 +21,10 @@
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.util.Assert;
+import org.springframework.binding.form.FormModel;
+import org.springframework.binding.form.HierarchicalFormModel;
+import org.springframework.binding.form.ValidatingFormModel;
+import org.springframework.binding.value.ValueModel;
 
 /**
  * Convenience class for producing a Spring Rich {@link Form} based on a
@@ -29,44 +33,141 @@
  * the most common case where a developer designs a form and wants to display
  * it without any custom functionality beyond what Spring Rich already
  * provides.
+ * <p/>
+ * In order to better facilitate the common usage scenarios and to avoid
+ * developers having to subclass <code>GeneratedForm</code>, many convenience
+ * constructors are provided, along with making the
+ * {@link #setFormModel(ValidatingFormModel)} and {@link #setId(String)}
+ * methods public. 
  *
  * @author Andy DePue
  * @author Peter De Bruycker
  */
 public class GeneratedForm extends AbstractForm implements InitializingBean {
-  private FormUIProvider formUIProvider;
+    private FormUIProvider formUIProvider;
 
-  //
-  // METHODS FROM CLASS AbstractForm
-  //
+    public GeneratedForm() {
+        super();
+    }
 
-  protected JComponent createFormControl() {
-    this.formUIProvider.bind(getBindingFactory());
-    return this.formUIProvider.getControl();
-  }
+    public GeneratedForm(String formId) {
+        super(formId);
+    }
 
+    public GeneratedForm(Object formObject) {
+        super(formObject);
+    }
 
+    public GeneratedForm(FormModel pageFormModel) {
+        super(pageFormModel);
+    }
 
-  //
-  // METHODS FROM INTERFACE InitializingBean
-  //
+    public GeneratedForm(FormModel formModel, String formId) {
+        super(formModel, formId);
+    }
 
-  public void afterPropertiesSet() throws Exception {
-    Assert.notNull(this.formUIProvider, "formUIProvider must be set");
-  }
+    public GeneratedForm(HierarchicalFormModel parentFormModel, String formId, String childFormObjectPropertyPath) {
+        super(parentFormModel, formId, childFormObjectPropertyPath);
+    }
 
+    public GeneratedForm(HierarchicalFormModel parentFormModel, String formId, ValueModel childFormObjectHolder) {
+        super(parentFormModel, formId, childFormObjectHolder);
+    }
 
+    public GeneratedForm(final FormUIProvider formUIProvider) {
+        this.formUIProvider = formUIProvider;
+    }
 
+    public GeneratedForm(String formId, final FormUIProvider formUIProvider) {
+        super(formId);
+        this.formUIProvider = formUIProvider;
+    }
 
-  //
-  // SIMPLE PROPERTY ACCESSORS
-  //
+    public GeneratedForm(Object formObject, final FormUIProvider formUIProvider) {
+        super(formObject);
+        this.formUIProvider = formUIProvider;
+    }
 
-  public FormUIProvider getFormUIProvider() {
-    return formUIProvider;
-  }
+    public GeneratedForm(Object formObject, String formId, final FormUIProvider formUIProvider) {
+        super(formObject);
+        setId(formId);
+        this.formUIProvider = formUIProvider;
+    }
 
-  public void setFormUIProvider(final FormUIProvider formUIProvider) {
-    this.formUIProvider = formUIProvider;
-  }
+    public GeneratedForm(FormModel pageFormModel, final FormUIProvider formUIProvider) {
+        super(pageFormModel);
+        this.formUIProvider = formUIProvider;
+    }
+
+    public GeneratedForm(FormModel formModel, String formId, final FormUIProvider formUIProvider) {
+        super(formModel, formId);
+        this.formUIProvider = formUIProvider;
+    }
+
+    public GeneratedForm(HierarchicalFormModel parentFormModel, String formId, String childFormObjectPropertyPath, final FormUIProvider formUIProvider) {
+        super(parentFormModel, formId, childFormObjectPropertyPath);
+        this.formUIProvider = formUIProvider;
+    }
+
+    public GeneratedForm(HierarchicalFormModel parentFormModel, String formId, ValueModel childFormObjectHolder, final FormUIProvider formUIProvider) {
+        super(parentFormModel, formId, childFormObjectHolder);
+        this.formUIProvider = formUIProvider;
+    }
+    
+
+    //
+    // METHODS FROM CLASS AbstractForm
+    //
+
+    protected JComponent createFormControl() {
+        this.formUIProvider.bind(getBindingFactory(), this);
+        return this.formUIProvider.getControl();
+    }
+
+    /**
+     * Provides public access to this method as a convenience.
+     *
+     * @param formModel
+     */
+    public void setFormModel(ValidatingFormModel formModel) {
+        super.setFormModel(formModel);
+    }
+
+
+    /**
+     * Provides public access to this method as a convenience.
+     *
+     * @param formId
+     */
+    public void setId(String formId) {
+        super.setId(formId);
+    }
+    
+    
+    
+    
+    
+
+    //
+    // METHODS FROM INTERFACE InitializingBean
+    //
+
+    public void afterPropertiesSet() throws Exception {
+        Assert.notNull(this.formUIProvider, "formUIProvider must be set");
+    }
+
+
+
+
+    //
+    // SIMPLE PROPERTY ACCESSORS
+    //
+
+    public FormUIProvider getFormUIProvider() {
+        return formUIProvider;
+    }
+
+    public void setFormUIProvider(final FormUIProvider formUIProvider) {
+        this.formUIProvider = formUIProvider;
+    }
 }

Modified: trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/form/DefaultFormUIProviderTests.java
===================================================================
--- trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/form/DefaultFormUIProviderTests.java	2007-06-18 06:37:41 UTC (rev 1768)
+++ trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/form/DefaultFormUIProviderTests.java	2007-06-26 16:10:58 UTC (rev 1769)
@@ -35,7 +35,7 @@
 
         formUIProvider.setContext("comboProperty", context);
 
-        formUIProvider.bind(bindingFactory);
+        formUIProvider.bind(bindingFactory, null);
         assertEquals(3, bindingFactory.getBindControlCount());
 
         // string property


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

Revision: 1907
          http://spring-rich-c.svn.sourceforge.net/spring-rich-c/?rev=1907&view=rev
Author:   peterdb
Date:     2008-01-21 03:19:11 -0800 (Mon, 21 Jan 2008)

Log Message:
-----------
patch for rcp-525 applied
testcase for ValueModel2EventListBridge

Modified Paths:
--------------
    trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/ListSelectionDialogBinder.java
    trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/support/LabelProviderListCellRenderer.java

Added Paths:
-----------
    trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/
    trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/
    trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/support/
    trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/support/ValueModel2EventListBridgeTests.java

Modified: trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/ListSelectionDialogBinder.java
===================================================================
--- trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/ListSelectionDialogBinder.java	2008-01-21 10:52:41 UTC (rev 1906)
+++ trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/ListSelectionDialogBinder.java	2008-01-21 11:19:11 UTC (rev 1907)
@@ -34,7 +34,7 @@
  * <p>
  * The context can contain the following items:
  * <ul>
- * <li><code>SELECTABLE_ITEMS_KEY</code>: the collection of selectable items</li>
+ * <li><code>SELECTABLE_ITEMS_HOLDER_KEY</code>: The ValueModel holding the collection of selectable items</li>
  * <li><code>LABEL_PROVIDER_KEY</code>: the label provider to provide the text of a given item</li>
  * <li><code>FILTERED_KEY</code>: boolean value indicating whether the selection dialog will contain a filter field.
  * If this value is <code>true</code> and the filter properties are not given, the string representation of the item
@@ -122,7 +122,7 @@
         if (context.containsKey(LABEL_PROVIDER_KEY)) {
             binding.setLabelProvider((LabelProvider) context.get(LABEL_PROVIDER_KEY));
         }
-        else if (renderer != null) {
+        else if (labelProvider != null) {
             binding.setLabelProvider(labelProvider);
         }
 

Modified: trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/support/LabelProviderListCellRenderer.java
===================================================================
--- trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/support/LabelProviderListCellRenderer.java	2008-01-21 10:52:41 UTC (rev 1906)
+++ trunk/spring-richclient/sandbox/src/main/java/org/springframework/richclient/selection/binding/support/LabelProviderListCellRenderer.java	2008-01-21 11:19:11 UTC (rev 1907)
@@ -26,6 +26,8 @@
  * @author Peter De Bruycker
  */
 public class LabelProviderListCellRenderer extends DefaultListCellRenderer {
+    private static final long serialVersionUID = 1L;
+
     private LabelProvider labelProvider;
 
     public LabelProviderListCellRenderer(LabelProvider labelProvider) {

Added: trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/support/ValueModel2EventListBridgeTests.java
===================================================================
--- trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/support/ValueModel2EventListBridgeTests.java	                        (rev 0)
+++ trunk/spring-richclient/sandbox/src/test/java/org/springframework/richclient/selection/binding/support/ValueModel2EventListBridgeTests.java	2008-01-21 11:19:11 UTC (rev 1907)
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2002-2008 the original author or authors.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package org.springframework.richclient.selection.binding.support;
+
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import org.springframework.binding.value.ValueChangeDetector;
+import org.springframework.binding.value.ValueModel;
+import org.springframework.binding.value.support.DefaultValueChangeDetector;
+import org.springframework.binding.value.support.ValueHolder;
+import org.springframework.richclient.application.ApplicationServices;
+import org.springframework.richclient.application.ApplicationServicesLocator;
+
+import ca.odell.glazedlists.BasicEventList;
+import ca.odell.glazedlists.EventList;
+
+/**
+ * Testcase for ValueModel2EventListBridge
+ * 
+ * @author Peter De Bruycker
+ */
+public class ValueModel2EventListBridgeTests extends TestCase {
+    public void testValueHolderMustContainCollection() {
+        EventList eventList = new BasicEventList();
+
+        ValueModel valueModel = new ValueHolder("test");
+
+        try {
+            new ValueModel2EventListBridge(valueModel, eventList);
+            fail("Must throw exception");
+        }
+        catch (IllegalArgumentException e) {
+            // test passes
+        }
+    }
+
+    public void testAutomaticSynchronization() {
+        List list1 = Arrays.asList(new String[] { "item 1", "item2", "item3" });
+        List list2 = Arrays.asList(new String[] { "item 4", "item5", "item6" });
+
+        EventList eventList = new BasicEventList();
+        ValueModel valueModel = new ValueHolder(list1);
+
+        ValueModel2EventListBridge bridge = new ValueModel2EventListBridge(valueModel, eventList);
+        assertEquals("auto sync: data copied in constructor", list1, eventList);
+
+        valueModel.setValue(list2);
+        assertEquals("when value in ValueModel changes, it's copied to the EventList", list2, eventList);
+    }
+
+    public void testManualSynchronization() {
+        List list1 = Arrays.asList(new String[] { "item 1", "item2", "item3" });
+        List list2 = Arrays.asList(new String[] { "item 4", "item5", "item6" });
+
+        EventList eventList = new BasicEventList();
+        ValueModel valueModel = new ValueHolder(list1);
+
+        ValueModel2EventListBridge bridge = new ValueModel2EventListBridge(valueModel, eventList, true);
+        assertTrue("manual sync: data not copied in constructor", eventList.isEmpty());
+
+        bridge.synchronize();
+        assertEquals("sync copies data", list1, eventList);
+
+        valueModel.setValue(list2);
+        assertEquals("when value in ValueModel changes, it's NOT copied to the EventList", list1, eventList);
+
+        bridge.synchronize();
+        assertEquals(list2, eventList);
+    }
+
+    protected void setUp() throws Exception {
+        ApplicationServices services = new ApplicationServices() {
+
+            public Object getService(Class serviceType) {
+                return new DefaultValueChangeDetector();
+            }
+
+            public boolean containsService(Class serviceType) {
+                return ValueChangeDetector.class.equals(serviceType);
+            }
+
+        };
+        ApplicationServicesLocator.load(new ApplicationServicesLocator(services));
+    }
+}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.