Convert CheckBox from legacy to AbstractField

Add LegacyCheckBox for old field factories, Grid editor etc.

Change-Id: Ic40790049421268c6de3d26730d1955d56aa86c4

5 files changed, 312 insertions, 104 deletions

diff --git a/server/src/main/java/com/vaadin/data/fieldgroup/DefaultFieldGroupFieldFactory.java b/server/src/main/java/com/vaadin/data/fieldgroup/DefaultFieldGroupFieldFactory.java
index 27f4628bae..a82da7ef51 100644
--- a/server/src/main/java/com/vaadin/data/fieldgroup/DefaultFieldGroupFieldFactory.java
+++ b/server/src/main/java/com/vaadin/data/fieldgroup/DefaultFieldGroupFieldFactory.java
@@ -20,11 +20,11 @@ import java.util.EnumSet;
 
 import com.vaadin.data.Item;
 import com.vaadin.data.fieldgroup.FieldGroup.BindException;
-import com.vaadin.legacy.ui.LegacyField;
 import com.vaadin.legacy.ui.LegacyAbstractField;
+import com.vaadin.legacy.ui.LegacyCheckBox;
+import com.vaadin.legacy.ui.LegacyField;
 import com.vaadin.ui.AbstractSelect;
 import com.vaadin.ui.AbstractTextField;
-import com.vaadin.ui.CheckBox;
 import com.vaadin.ui.ComboBox;
 import com.vaadin.ui.DateField;
 import com.vaadin.ui.InlineDateField;
@@ -174,8 +174,8 @@ public class DefaultFieldGroupFieldFactory implements FieldGroupFieldFactory {
     }
 
     protected <T extends LegacyField> T createBooleanField(Class<T> fieldType) {
-        if (fieldType.isAssignableFrom(CheckBox.class)) {
-            CheckBox cb = new CheckBox(null);
+        if (fieldType.isAssignableFrom(LegacyCheckBox.class)) {
+            LegacyCheckBox cb = new LegacyCheckBox(null);
             cb.setImmediate(true);
             return (T) cb;
         } else if (AbstractTextField.class.isAssignableFrom(fieldType)) {
diff --git a/server/src/main/java/com/vaadin/legacy/ui/LegacyCheckBox.java b/server/src/main/java/com/vaadin/legacy/ui/LegacyCheckBox.java
new file mode 100644
index 0000000000..baa98a4c19
--- /dev/null
+++ b/server/src/main/java/com/vaadin/legacy/ui/LegacyCheckBox.java
@@ -0,0 +1,268 @@
+/*
+ * Copyright 2000-2014 Vaadin Ltd.
+ *
+ * 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 com.vaadin.legacy.ui;
+
+import java.util.Collection;
+
+import org.jsoup.nodes.Attributes;
+import org.jsoup.nodes.Element;
+
+import com.vaadin.data.Property;
+import com.vaadin.event.FieldEvents.BlurEvent;
+import com.vaadin.event.FieldEvents.BlurListener;
+import com.vaadin.event.FieldEvents.FocusAndBlurServerRpcImpl;
+import com.vaadin.event.FieldEvents.FocusEvent;
+import com.vaadin.event.FieldEvents.FocusListener;
+import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.checkbox.CheckBoxServerRpc;
+import com.vaadin.shared.ui.checkbox.CheckBoxState;
+import com.vaadin.ui.declarative.DesignAttributeHandler;
+import com.vaadin.ui.declarative.DesignContext;
+
+public class LegacyCheckBox extends LegacyAbstractField<Boolean> {
+
+    private CheckBoxServerRpc rpc = new CheckBoxServerRpc() {
+
+        @Override
+        public void setChecked(boolean checked,
+                MouseEventDetails mouseEventDetails) {
+            if (isReadOnly()) {
+                return;
+            }
+
+            /*
+             * Client side updates the state before sending the event so we need
+             * to make sure the cached state is updated to match the client. If
+             * we do not do this, a reverting setValue() call in a listener will
+             * not cause the new state to be sent to the client.
+             *
+             * See #11028, #10030.
+             */
+            getUI().getConnectorTracker().getDiffState(LegacyCheckBox.this)
+                    .put("checked", checked);
+
+            final Boolean oldValue = getValue();
+            final Boolean newValue = checked;
+
+            if (!newValue.equals(oldValue)) {
+                // The event is only sent if the switch state is changed
+                setValue(newValue);
+            }
+
+        }
+    };
+
+    FocusAndBlurServerRpcImpl focusBlurRpc = new FocusAndBlurServerRpcImpl(this) {
+        @Override
+        protected void fireEvent(Event event) {
+            LegacyCheckBox.this.fireEvent(event);
+        }
+    };
+
+    /**
+     * Creates a new checkbox.
+     */
+    public LegacyCheckBox() {
+        registerRpc(rpc);
+        registerRpc(focusBlurRpc);
+        setValue(Boolean.FALSE);
+    }
+
+    /**
+     * Creates a new checkbox with a set caption.
+     *
+     * @param caption
+     *            the Checkbox caption.
+     */
+    public LegacyCheckBox(String caption) {
+        this();
+        setCaption(caption);
+    }
+
+    /**
+     * Creates a new checkbox with a caption and a set initial state.
+     *
+     * @param caption
+     *            the caption of the checkbox
+     * @param initialState
+     *            the initial state of the checkbox
+     */
+    public LegacyCheckBox(String caption, boolean initialState) {
+        this(caption);
+        setValue(initialState);
+    }
+
+    /**
+     * Creates a new checkbox that is connected to a boolean property.
+     *
+     * @param state
+     *            the Initial state of the switch-button.
+     * @param dataSource
+     */
+    public LegacyCheckBox(String caption, Property<?> dataSource) {
+        this(caption);
+        setPropertyDataSource(dataSource);
+    }
+
+    @Override
+    public Class<Boolean> getType() {
+        return Boolean.class;
+    }
+
+    @Override
+    protected CheckBoxState getState() {
+        return (CheckBoxState) super.getState();
+    }
+
+    /*
+     * Overridden to keep the shared state in sync with the LegacyAbstractField
+     * internal value. Should be removed once LegacyAbstractField is refactored to use
+     * shared state.
+     *
+     * See tickets #10921 and #11064.
+     */
+    @Override
+    protected void setInternalValue(Boolean newValue) {
+        super.setInternalValue(newValue);
+        if (newValue == null) {
+            newValue = false;
+        }
+        getState().checked = newValue;
+    }
+
+    public void addBlurListener(BlurListener listener) {
+        addListener(BlurEvent.EVENT_ID, BlurEvent.class, listener,
+                BlurListener.blurMethod);
+    }
+
+    /**
+     * @deprecated As of 7.0, replaced by {@link #addBlurListener(BlurListener)}
+     **/
+    @Deprecated
+    public void addListener(BlurListener listener) {
+        addBlurListener(listener);
+    }
+
+    public void removeBlurListener(BlurListener listener) {
+        removeListener(BlurEvent.EVENT_ID, BlurEvent.class, listener);
+    }
+
+    /**
+     * @deprecated As of 7.0, replaced by
+     *             {@link #removeBlurListener(BlurListener)}
+     **/
+    @Deprecated
+    public void removeListener(BlurListener listener) {
+        removeBlurListener(listener);
+    }
+
+    public void addFocusListener(FocusListener listener) {
+        addListener(FocusEvent.EVENT_ID, FocusEvent.class, listener,
+                FocusListener.focusMethod);
+    }
+
+    /**
+     * @deprecated As of 7.0, replaced by
+     *             {@link #addFocusListener(FocusListener)}
+     **/
+    @Deprecated
+    public void addListener(FocusListener listener) {
+        addFocusListener(listener);
+    }
+
+    public void removeFocusListener(FocusListener listener) {
+        removeListener(FocusEvent.EVENT_ID, FocusEvent.class, listener);
+    }
+
+    /**
+     * @deprecated As of 7.0, replaced by
+     *             {@link #removeFocusListener(FocusListener)}
+     **/
+    @Deprecated
+    public void removeListener(FocusListener listener) {
+        removeFocusListener(listener);
+    }
+
+    /**
+     * Get the boolean value of the button state.
+     *
+     * @return True iff the button is pressed down or checked.
+     *
+     * @deprecated As of 7.0, use {@link #getValue()} instead and, if needed,
+     *             handle null values.
+     */
+    @Deprecated
+    public boolean booleanValue() {
+        Boolean value = getValue();
+        return (null == value) ? false : value.booleanValue();
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see com.vaadin.ui.AbstractField#readDesign(org.jsoup.nodes.Element,
+     * com.vaadin.ui.declarative.DesignContext)
+     */
+    @Override
+    public void readDesign(Element design, DesignContext designContext) {
+        super.readDesign(design, designContext);
+        if (design.hasAttr("checked")) {
+            this.setValue(
+                    DesignAttributeHandler.readAttribute("checked",
+                            design.attributes(), Boolean.class), false, true);
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see com.vaadin.ui.AbstractField#getCustomAttributes()
+     */
+    @Override
+    protected Collection<String> getCustomAttributes() {
+        Collection<String> attributes = super.getCustomAttributes();
+        attributes.add("checked");
+        return attributes;
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see com.vaadin.ui.AbstractField#writeDesign(org.jsoup.nodes.Element,
+     * com.vaadin.ui.declarative.DesignContext)
+     */
+    @Override
+    public void writeDesign(Element design, DesignContext designContext) {
+        super.writeDesign(design, designContext);
+        LegacyCheckBox def = (LegacyCheckBox) designContext.getDefaultInstance(this);
+        Attributes attr = design.attributes();
+        DesignAttributeHandler.writeAttribute("checked", attr, getValue(),
+                def.getValue(), Boolean.class);
+    }
+
+    @Override
+    public void clear() {
+        setValue(Boolean.FALSE);
+    }
+
+    @Override
+    public boolean isEmpty() {
+        return getValue() == null || getValue().equals(Boolean.FALSE);
+
+    }
+
+}
diff --git a/server/src/main/java/com/vaadin/ui/CheckBox.java b/server/src/main/java/com/vaadin/ui/CheckBox.java
index e9e9b0d4b9..1519c64955 100644
--- a/server/src/main/java/com/vaadin/ui/CheckBox.java
+++ b/server/src/main/java/com/vaadin/ui/CheckBox.java
@@ -1,12 +1,12 @@
 /*
  * Copyright 2000-2014 Vaadin Ltd.
- * 
+ *
  * 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
@@ -21,20 +21,18 @@ import java.util.Collection;
 import org.jsoup.nodes.Attributes;
 import org.jsoup.nodes.Element;
 
-import com.vaadin.data.Property;
 import com.vaadin.event.FieldEvents.BlurEvent;
 import com.vaadin.event.FieldEvents.BlurListener;
 import com.vaadin.event.FieldEvents.FocusAndBlurServerRpcImpl;
 import com.vaadin.event.FieldEvents.FocusEvent;
 import com.vaadin.event.FieldEvents.FocusListener;
-import com.vaadin.legacy.ui.LegacyAbstractField;
 import com.vaadin.shared.MouseEventDetails;
 import com.vaadin.shared.ui.checkbox.CheckBoxServerRpc;
 import com.vaadin.shared.ui.checkbox.CheckBoxState;
 import com.vaadin.ui.declarative.DesignAttributeHandler;
 import com.vaadin.ui.declarative.DesignContext;
 
-public class CheckBox extends LegacyAbstractField<Boolean> {
+public class CheckBox extends AbstractField<Boolean> {
 
     private CheckBoxServerRpc rpc = new CheckBoxServerRpc() {
 
@@ -50,7 +48,7 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
              * to make sure the cached state is updated to match the client. If
              * we do not do this, a reverting setValue() call in a listener will
              * not cause the new state to be sent to the client.
-             * 
+             *
              * See #11028, #10030.
              */
             getUI().getConnectorTracker().getDiffState(CheckBox.this)
@@ -85,7 +83,7 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
 
     /**
      * Creates a new checkbox with a set caption.
-     * 
+     *
      * @param caption
      *            the Checkbox caption.
      */
@@ -96,7 +94,7 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
 
     /**
      * Creates a new checkbox with a caption and a set initial state.
-     * 
+     *
      * @param caption
      *            the caption of the checkbox
      * @param initialState
@@ -107,21 +105,27 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
         setValue(initialState);
     }
 
-    /**
-     * Creates a new checkbox that is connected to a boolean property.
-     * 
-     * @param state
-     *            the Initial state of the switch-button.
-     * @param dataSource
-     */
-    public CheckBox(String caption, Property<?> dataSource) {
-        this(caption);
-        setPropertyDataSource(dataSource);
+    @Override
+    public Boolean getValue() {
+        return getState(false).checked;
     }
 
+    /**
+     * Sets the value of this ComboBox. If the new value is not equal to
+     * {@code getValue()}, fires a value change event. Throws
+     * {@code IllegalArgumentException} if the value is null.
+     *
+     * @param value
+     *            the new value
+     * @throws IllegalArgumentException
+     *             if the value is null
+     */
     @Override
-    public Class<Boolean> getType() {
-        return Boolean.class;
+    public void setValue(Boolean value) {
+        if (value == null) {
+            throw new IllegalArgumentException("CheckBox value must not be null");
+        }
+        super.setValue(value);
     }
 
     @Override
@@ -129,20 +133,14 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
         return (CheckBoxState) super.getState();
     }
 
-    /*
-     * Overridden to keep the shared state in sync with the LegacyAbstractField
-     * internal value. Should be removed once LegacyAbstractField is refactored to use
-     * shared state.
-     * 
-     * See tickets #10921 and #11064.
-     */
     @Override
-    protected void setInternalValue(Boolean newValue) {
-        super.setInternalValue(newValue);
-        if (newValue == null) {
-            newValue = false;
-        }
-        getState().checked = newValue;
+    protected CheckBoxState getState(boolean markAsDirty) {
+        return (CheckBoxState) super.getState(markAsDirty);
+    }
+
+    @Override
+    protected void doSetValue(Boolean value) {
+        getState().checked = value;
     }
 
     public void addBlurListener(BlurListener listener) {
@@ -150,71 +148,22 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
                 BlurListener.blurMethod);
     }
 
-    /**
-     * @deprecated As of 7.0, replaced by {@link #addBlurListener(BlurListener)}
-     **/
-    @Deprecated
-    public void addListener(BlurListener listener) {
-        addBlurListener(listener);
-    }
-
     public void removeBlurListener(BlurListener listener) {
         removeListener(BlurEvent.EVENT_ID, BlurEvent.class, listener);
     }
 
-    /**
-     * @deprecated As of 7.0, replaced by
-     *             {@link #removeBlurListener(BlurListener)}
-     **/
-    @Deprecated
-    public void removeListener(BlurListener listener) {
-        removeBlurListener(listener);
-    }
-
     public void addFocusListener(FocusListener listener) {
         addListener(FocusEvent.EVENT_ID, FocusEvent.class, listener,
                 FocusListener.focusMethod);
     }
 
-    /**
-     * @deprecated As of 7.0, replaced by
-     *             {@link #addFocusListener(FocusListener)}
-     **/
-    @Deprecated
-    public void addListener(FocusListener listener) {
-        addFocusListener(listener);
-    }
-
     public void removeFocusListener(FocusListener listener) {
         removeListener(FocusEvent.EVENT_ID, FocusEvent.class, listener);
     }
 
-    /**
-     * @deprecated As of 7.0, replaced by
-     *             {@link #removeFocusListener(FocusListener)}
-     **/
-    @Deprecated
-    public void removeListener(FocusListener listener) {
-        removeFocusListener(listener);
-    }
-
-    /**
-     * Get the boolean value of the button state.
-     * 
-     * @return True iff the button is pressed down or checked.
-     * 
-     * @deprecated As of 7.0, use {@link #getValue()} instead and, if needed,
-     *             handle null values.
-     */
-    @Deprecated
-    public boolean booleanValue() {
-        Boolean value = getValue();
-        return (null == value) ? false : value.booleanValue();
-    }
-
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see com.vaadin.ui.AbstractField#readDesign(org.jsoup.nodes.Element,
      * com.vaadin.ui.declarative.DesignContext)
      */
@@ -224,13 +173,13 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
         if (design.hasAttr("checked")) {
             this.setValue(
                     DesignAttributeHandler.readAttribute("checked",
-                            design.attributes(), Boolean.class), false, true);
+                            design.attributes(), Boolean.class), false);
         }
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see com.vaadin.ui.AbstractField#getCustomAttributes()
      */
     @Override
@@ -242,7 +191,7 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see com.vaadin.ui.AbstractField#writeDesign(org.jsoup.nodes.Element,
      * com.vaadin.ui.declarative.DesignContext)
      */
@@ -255,15 +204,4 @@ public class CheckBox extends LegacyAbstractField<Boolean> {
                 def.getValue(), Boolean.class);
     }
 
-    @Override
-    public void clear() {
-        setValue(Boolean.FALSE);
-    }
-
-    @Override
-    public boolean isEmpty() {
-        return getValue() == null || getValue().equals(Boolean.FALSE);
-
-    }
-
 }
diff --git a/server/src/main/java/com/vaadin/ui/DefaultFieldFactory.java b/server/src/main/java/com/vaadin/ui/DefaultFieldFactory.java
index 85ad1743ea..3e44a901fc 100644
--- a/server/src/main/java/com/vaadin/ui/DefaultFieldFactory.java
+++ b/server/src/main/java/com/vaadin/ui/DefaultFieldFactory.java
@@ -20,6 +20,7 @@ import java.util.Date;
 import com.vaadin.data.Container;
 import com.vaadin.data.Item;
 import com.vaadin.data.Property;
+import com.vaadin.legacy.ui.LegacyCheckBox;
 import com.vaadin.legacy.ui.LegacyField;
 import com.vaadin.shared.util.SharedUtil;
 
@@ -116,7 +117,7 @@ public class DefaultFieldFactory implements FormFieldFactory, TableFieldFactory
 
         // Boolean field
         if (Boolean.class.isAssignableFrom(type)) {
-            return new CheckBox();
+            return new LegacyCheckBox();
         }
 
         return new TextField();
diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java
index 1319f868c7..c9887c1db3 100644
--- a/server/src/main/java/com/vaadin/ui/Grid.java
+++ b/server/src/main/java/com/vaadin/ui/Grid.java
@@ -73,6 +73,7 @@ import com.vaadin.event.SortEvent.SortNotifier;
 import com.vaadin.legacy.data.Validator.InvalidValueException;
 import com.vaadin.legacy.data.util.converter.LegacyConverter;
 import com.vaadin.legacy.data.util.converter.LegacyConverterUtil;
+import com.vaadin.legacy.ui.LegacyCheckBox;
 import com.vaadin.legacy.ui.LegacyField;
 import com.vaadin.server.AbstractClientConnector;
 import com.vaadin.server.AbstractExtension;
@@ -545,7 +546,7 @@ public class Grid extends AbstractFocusable implements SelectionNotifier,
                 Class<?> dataType,
                 Class<T> fieldType) throws BindException {
             T field = super.build(caption, dataType, fieldType);
-            if (field instanceof CheckBox) {
+            if (field instanceof LegacyCheckBox) {
                 field.setCaption(null);
             }
             return field;