#3752 - Refactor TextFields

svn changeset:16348/svn branch:6.5

1 files changed, 227 insertions, 3 deletions

diff --git a/src/com/vaadin/ui/RichTextArea.java b/src/com/vaadin/ui/RichTextArea.java
index 10e5259bc2..d371e3c181 100644
--- a/src/com/vaadin/ui/RichTextArea.java
+++ b/src/com/vaadin/ui/RichTextArea.java
@@ -4,6 +4,9 @@
 
 package com.vaadin.ui;
 
+import java.text.Format;
+import java.util.Map;
+
 import com.vaadin.data.Property;
 import com.vaadin.terminal.PaintException;
 import com.vaadin.terminal.PaintTarget;
@@ -17,11 +20,31 @@ import com.vaadin.ui.ClientWidget.LoadStyle;
  * {@link RichTextArea} may produce unexpected results as formatting is counted
  * into length of field.
  */
-@SuppressWarnings({ "serial", "unchecked" })
 @ClientWidget(value = VRichTextArea.class, loadStyle = LoadStyle.LAZY)
-public class RichTextArea extends AbstractTextField {
+public class RichTextArea extends AbstractField {
+
+    /**
+     * Value formatter used to format the string contents.
+     */
+    @Deprecated
+    private Format format;
 
-    private boolean selectAll;
+    /**
+     * Null representation.
+     */
+    private String nullRepresentation = "null";
+
+    /**
+     * Is setting to null from non-null value allowed by setting with null
+     * representation .
+     */
+    private boolean nullSettingAllowed = false;
+
+    /**
+     * Temporary flag that indicates all content will be selected after the next
+     * paint. Reset to false after painted.
+     */
+    private boolean selectAll = false;
 
     /**
      * Constructs an empty <code>RichTextArea</code> with no caption.
@@ -87,6 +110,18 @@ public class RichTextArea extends AbstractTextField {
             target.addAttribute("selectAll", true);
             selectAll = false;
         }
+
+        // Adds the content as variable
+        String value = getFormattedValue();
+        if (value == null) {
+            value = getNullRepresentation();
+        }
+        if (value == null) {
+            throw new IllegalStateException(
+                    "Null values are not allowed if the null-representation is null");
+        }
+        target.addVariable(this, "text", value);
+
         super.paintContent(target);
     }
 
@@ -121,4 +156,193 @@ public class RichTextArea extends AbstractTextField {
         requestRepaint();
     }
 
+    /**
+     * Gets the formatted string value. Sets the field value by using the
+     * assigned Format.
+     * 
+     * @return the Formatted value.
+     * @see #setFormat(Format)
+     * @see Format
+     * @deprecated
+     */
+    @Deprecated
+    protected String getFormattedValue() {
+        Object v = getValue();
+        if (v == null) {
+            return null;
+        }
+        return v.toString();
+    }
+
+    @Override
+    public Object getValue() {
+        Object v = super.getValue();
+        if (format == null || v == null) {
+            return v;
+        }
+        try {
+            return format.format(v);
+        } catch (final IllegalArgumentException e) {
+            return v;
+        }
+    }
+
+    @Override
+    public void changeVariables(Object source, Map<String, Object> variables) {
+
+        super.changeVariables(source, variables);
+
+        // Sets the text
+        if (variables.containsKey("text") && !isReadOnly()) {
+
+            // Only do the setting if the string representation of the value
+            // has been updated
+            String newValue = (String) variables.get("text");
+
+            final String oldValue = getFormattedValue();
+            if (newValue != null
+                    && (oldValue == null || isNullSettingAllowed())
+                    && newValue.equals(getNullRepresentation())) {
+                newValue = null;
+            }
+            if (newValue != oldValue
+                    && (newValue == null || !newValue.equals(oldValue))) {
+                boolean wasModified = isModified();
+                setValue(newValue, true);
+
+                // If the modified status changes, or if we have a formatter,
+                // repaint is needed after all.
+                if (format != null || wasModified != isModified()) {
+                    requestRepaint();
+                }
+            }
+        }
+
+    }
+
+    @Override
+    public Class getType() {
+        return String.class;
+    }
+
+    /**
+     * Gets the null-string representation.
+     * 
+     * <p>
+     * The null-valued strings are represented on the user interface by
+     * replacing the null value with this string. If the null representation is
+     * set null (not 'null' string), painting null value throws exception.
+     * </p>
+     * 
+     * <p>
+     * The default value is string 'null'.
+     * </p>
+     * 
+     * @return the String Textual representation for null strings.
+     * @see TextField#isNullSettingAllowed()
+     */
+    public String getNullRepresentation() {
+        return nullRepresentation;
+    }
+
+    /**
+     * Is setting nulls with null-string representation allowed.
+     * 
+     * <p>
+     * If this property is true, writing null-representation string to text
+     * field always sets the field value to real null. If this property is
+     * false, null setting is not made, but the null values are maintained.
+     * Maintenance of null-values is made by only converting the textfield
+     * contents to real null, if the text field matches the null-string
+     * representation and the current value of the field is null.
+     * </p>
+     * 
+     * <p>
+     * By default this setting is false
+     * </p>
+     * 
+     * @return boolean Should the null-string represenation be always converted
+     *         to null-values.
+     * @see TextField#getNullRepresentation()
+     */
+    public boolean isNullSettingAllowed() {
+        return nullSettingAllowed;
+    }
+
+    /**
+     * Sets the null-string representation.
+     * 
+     * <p>
+     * The null-valued strings are represented on the user interface by
+     * replacing the null value with this string. If the null representation is
+     * set null (not 'null' string), painting null value throws exception.
+     * </p>
+     * 
+     * <p>
+     * The default value is string 'null'
+     * </p>
+     * 
+     * @param nullRepresentation
+     *            Textual representation for null strings.
+     * @see TextField#setNullSettingAllowed(boolean)
+     */
+    public void setNullRepresentation(String nullRepresentation) {
+        this.nullRepresentation = nullRepresentation;
+    }
+
+    /**
+     * Sets the null conversion mode.
+     * 
+     * <p>
+     * If this property is true, writing null-representation string to text
+     * field always sets the field value to real null. If this property is
+     * false, null setting is not made, but the null values are maintained.
+     * Maintenance of null-values is made by only converting the textfield
+     * contents to real null, if the text field matches the null-string
+     * representation and the current value of the field is null.
+     * </p>
+     * 
+     * <p>
+     * By default this setting is false.
+     * </p>
+     * 
+     * @param nullSettingAllowed
+     *            Should the null-string represenation be always converted to
+     *            null-values.
+     * @see TextField#getNullRepresentation()
+     */
+    public void setNullSettingAllowed(boolean nullSettingAllowed) {
+        this.nullSettingAllowed = nullSettingAllowed;
+    }
+
+    /**
+     * Gets the value formatter of TextField.
+     * 
+     * @return the Format used to format the value.
+     * @deprecated replaced by {@link com.vaadin.data.util.PropertyFormatter}
+     */
+    @Deprecated
+    public Format getFormat() {
+        return format;
+    }
+
+    /**
+     * Gets the value formatter of TextField.
+     * 
+     * @param format
+     *            the Format used to format the value. Null disables the
+     *            formatting.
+     * @deprecated replaced by {@link com.vaadin.data.util.PropertyFormatter}
+     */
+    @Deprecated
+    public void setFormat(Format format) {
+        this.format = format;
+        requestRepaint();
+    }
+
+    @Override
+    protected boolean isEmpty() {
+        return super.isEmpty() || toString().length() == 0;
+    }
+
 }