diff options
author | Artur Signell <artur@vaadin.com> | 2011-12-22 10:20:57 +0200 |
---|---|---|
committer | Artur Signell <artur@vaadin.com> | 2011-12-22 10:22:17 +0200 |
commit | 6295641ae1b0ed1c14541a85de5a82cdc7f2f827 (patch) | |
tree | b4577a1060fd4a31cdb443aba0d5b8ba03f7f904 /src/com/vaadin/data | |
parent | 088d47b54552bb4a3b4a22a3edf06262a415e9e3 (diff) | |
download | vaadin-framework-6295641ae1b0ed1c14541a85de5a82cdc7f2f827.tar.gz vaadin-framework-6295641ae1b0ed1c14541a85de5a82cdc7f2f827.zip |
Renamed FieldBinder -> FieldGroup, BeanFieldBinder -> BeanFieldGroup
based on API review meeting
Diffstat (limited to 'src/com/vaadin/data')
-rw-r--r-- | src/com/vaadin/data/fieldbinder/BeanFieldGroup.java (renamed from src/com/vaadin/data/fieldbinder/BeanFieldBinder.java) | 4 | ||||
-rw-r--r-- | src/com/vaadin/data/fieldbinder/FieldGroup.java (renamed from src/com/vaadin/data/fieldbinder/FieldBinder.java) | 35 | ||||
-rw-r--r-- | src/com/vaadin/data/fieldbinder/FormBuilder.java | 8 |
3 files changed, 29 insertions, 18 deletions
diff --git a/src/com/vaadin/data/fieldbinder/BeanFieldBinder.java b/src/com/vaadin/data/fieldbinder/BeanFieldGroup.java index 2b15058500..a01c6e0879 100644 --- a/src/com/vaadin/data/fieldbinder/BeanFieldBinder.java +++ b/src/com/vaadin/data/fieldbinder/BeanFieldGroup.java @@ -8,11 +8,11 @@ import com.vaadin.data.util.BeanItem; import com.vaadin.data.validator.BeanValidationValidator;
import com.vaadin.ui.Field;
-public class BeanFieldBinder<T> extends FieldBinder {
+public class BeanFieldGroup<T> extends FieldGroup {
private Class<T> beanType;
- public BeanFieldBinder(Class<T> beanType) {
+ public BeanFieldGroup(Class<T> beanType) {
this.beanType = beanType;
}
diff --git a/src/com/vaadin/data/fieldbinder/FieldBinder.java b/src/com/vaadin/data/fieldbinder/FieldGroup.java index 3df8794079..a5cf6b993e 100644 --- a/src/com/vaadin/data/fieldbinder/FieldBinder.java +++ b/src/com/vaadin/data/fieldbinder/FieldGroup.java @@ -20,20 +20,31 @@ import com.vaadin.data.fieldbinder.FormBuilder.FormBuilderException; import com.vaadin.data.util.TransactionalPropertyWrapper;
import com.vaadin.tools.ReflectTools;
import com.vaadin.ui.Field;
+import com.vaadin.ui.Form;
/**
- * FIXME Javadoc
- *
- * See also {@link BeanFieldBinder} which makes binding fields easier when your
- * data is in a bean.
+ * FieldGroup provides an easy way of binding fields to data and handling
+ * commits of these fields.
+ * <p>
+ * The functionality of FieldGroup is similar to {@link Form} but
+ * {@link FieldGroup} does not handle layouts in any way. The typical use case
+ * is to create a layout outside the FieldGroup and then use FieldGroup to bind
+ * the fields to a data source.
+ * </p>
+ * <p>
+ * {@link FieldGroup} is not a UI component so it cannot be added to a layout.
+ * Using the buildAndBind methods {@link FieldGroup} can create fields for you
+ * using a FieldGroupFieldFactory but you still have to add them to the correct
+ * position in your layout.
+ * </p>
*
* @author Vaadin Ltd
* @version @version@
* @since 7.0
*/
-public class FieldBinder implements Serializable {
+public class FieldGroup implements Serializable {
- private static final Logger logger = Logger.getLogger(FieldBinder.class
+ private static final Logger logger = Logger.getLogger(FieldGroup.class
.getName());
private Item itemDataSource;
@@ -51,7 +62,7 @@ public class FieldBinder implements Serializable { * data source for the field binder.
*
*/
- public FieldBinder() {
+ public FieldGroup() {
}
@@ -61,7 +72,7 @@ public class FieldBinder implements Serializable { * @param itemDataSource
* The data source to bind the fields to
*/
- public FieldBinder(Item itemDataSource) {
+ public FieldGroup(Item itemDataSource) {
setItemDataSource(itemDataSource);
}
@@ -523,7 +534,7 @@ public class FieldBinder implements Serializable { }
/**
- * Returns a list of all commit handlers for this {@link FieldBinder}.
+ * Returns a list of all commit handlers for this {@link FieldGroup}.
* <p>
* Use {@link #addCommitHandler(CommitHandler)} and
* {@link #removeCommitHandler(CommitHandler)} to register or unregister a
@@ -572,9 +583,9 @@ public class FieldBinder implements Serializable { *
*/
public static class CommitEvent implements Serializable {
- private FieldBinder fieldBinder;
+ private FieldGroup fieldBinder;
- private CommitEvent(FieldBinder fieldBinder) {
+ private CommitEvent(FieldGroup fieldBinder) {
this.fieldBinder = fieldBinder;
}
@@ -583,7 +594,7 @@ public class FieldBinder implements Serializable { *
* @return The FieldBinder that is being committed.
*/
- public FieldBinder getFieldBinder() {
+ public FieldGroup getFieldBinder() {
return fieldBinder;
}
diff --git a/src/com/vaadin/data/fieldbinder/FormBuilder.java b/src/com/vaadin/data/fieldbinder/FormBuilder.java index 4597d520b3..ccf060ec97 100644 --- a/src/com/vaadin/data/fieldbinder/FormBuilder.java +++ b/src/com/vaadin/data/fieldbinder/FormBuilder.java @@ -7,7 +7,7 @@ import java.io.Serializable; import java.lang.reflect.InvocationTargetException;
import java.util.logging.Logger;
-import com.vaadin.data.fieldbinder.FieldBinder.BindException;
+import com.vaadin.data.fieldbinder.FieldGroup.BindException;
import com.vaadin.tools.ReflectTools;
import com.vaadin.ui.DefaultFieldFactory;
import com.vaadin.ui.Field;
@@ -21,7 +21,7 @@ import com.vaadin.ui.Field; public class FormBuilder implements Serializable {
private FormBuilderFieldFactory fieldFactory = new DefaultFormBuilderFieldFactory();
- private FieldBinder fieldBinder;
+ private FieldGroup fieldBinder;
private static final Logger logger = Logger.getLogger(FormBuilder.class
.getName());
@@ -32,14 +32,14 @@ public class FormBuilder implements Serializable { * The FieldBinder to use for binding the fields to the data
* source
*/
- public FormBuilder(FieldBinder fieldBinder) {
+ public FormBuilder(FieldGroup fieldBinder) {
this.fieldBinder = fieldBinder;
}
/**
* TODO: javadoc
*/
- protected FieldBinder getFieldBinder() {
+ protected FieldGroup getFieldBinder() {
return fieldBinder;
}
|