Use shared state in ComboBox (#19229)

This change uses shared state for the read-only flag, text
input allowed flag and input prompt.

Change-Id: I3bdc6843288c5309311461a3d036293d79004e22

client/src/main/java/com/vaadin/client/ui/combobox/ComboBoxConnector.java

@@ -23,7 +23,9 @@ import com.google.gwt.core.client.Scheduler;
 import com.google.gwt.core.client.Scheduler.ScheduledCommand;
 import com.vaadin.client.ApplicationConnection;
 import com.vaadin.client.Paintable;
+import com.vaadin.client.Profiler;
 import com.vaadin.client.UIDL;
+import com.vaadin.client.communication.StateChangeEvent;
 import com.vaadin.client.ui.AbstractFieldConnector;
 import com.vaadin.client.ui.SimpleManagedLayout;
 import com.vaadin.client.ui.VFilterSelect;
@@ -35,13 +37,35 @@ import com.vaadin.shared.ui.combobox.FilteringMode;
 import com.vaadin.ui.ComboBox;
 
 @Connect(ComboBox.class)
-public class ComboBoxConnector extends AbstractFieldConnector
-        implements Paintable, SimpleManagedLayout {
+public class ComboBoxConnector extends AbstractFieldConnector implements
+        Paintable, SimpleManagedLayout {
 
     // oldSuggestionTextMatchTheOldSelection is used to detect when it's safe to
     // update textbox text by a changed item caption.
     private boolean oldSuggestionTextMatchTheOldSelection;
 
+    @Override
+    public void onStateChanged(StateChangeEvent stateChangeEvent) {
+        super.onStateChanged(stateChangeEvent);
+
+        Profiler.enter("ComboBoxConnector.onStateChanged update content");
+
+        getWidget().readonly = isReadOnly();
+        getWidget().updateReadOnly();
+
+        getWidget().immediate = getState().immediate;
+
+        getWidget().setTextInputEnabled(getState().textInputAllowed);
+
+        if (getState().inputPrompt != null) {
+            getWidget().inputPrompt = getState().inputPrompt;
+        } else {
+            getWidget().inputPrompt = "";
+        }
+
+        Profiler.leave("ComboBoxConnector.onStateChanged update content");
+    }
+
     /*
      * (non-Javadoc)
      * 
@@ -54,31 +78,18 @@ public class ComboBoxConnector extends AbstractFieldConnector
         getWidget().client = client;
         getWidget().paintableId = uidl.getId();
 
-        getWidget().readonly = isReadOnly();
-        getWidget().updateReadOnly();
-
         if (!isRealUpdate(uidl)) {
             return;
         }
 
-        // Inverse logic here to make the default case (text input enabled)
-        // work without additional UIDL messages
-        boolean noTextInput = uidl
-                .hasAttribute(ComboBoxConstants.ATTR_NO_TEXT_INPUT)
-                && uidl.getBooleanAttribute(
-                        ComboBoxConstants.ATTR_NO_TEXT_INPUT);
-        getWidget().setTextInputEnabled(!noTextInput);
-
         // not a FocusWidget -> needs own tabindex handling
         getWidget().tb.setTabIndex(getState().tabIndex);
 
         if (uidl.hasAttribute("filteringmode")) {
-            getWidget().filteringmode = FilteringMode
-                    .valueOf(uidl.getStringAttribute("filteringmode"));
+            getWidget().filteringmode = FilteringMode.valueOf(uidl
+                    .getStringAttribute("filteringmode"));
         }
 
-        getWidget().immediate = getState().immediate;
-
         getWidget().nullSelectionAllowed = uidl.hasAttribute("nullselect");
 
         getWidget().nullSelectItem = uidl.hasAttribute("nullselectitem")
@@ -90,14 +101,6 @@ public class ComboBoxConnector extends AbstractFieldConnector
             getWidget().pageLength = uidl.getIntAttribute("pagelength");
         }
 
-        if (uidl.hasAttribute(ComboBoxConstants.ATTR_INPUTPROMPT)) {
-            // input prompt changed from server
-            getWidget().inputPrompt = uidl
-                    .getStringAttribute(ComboBoxConstants.ATTR_INPUTPROMPT);
-        } else {
-            getWidget().inputPrompt = "";
-        }
-
         if (uidl.hasAttribute("suggestionPopupWidth")) {
             getWidget().suggestionPopupWidth = uidl
                     .getStringAttribute("suggestionPopupWidth");
@@ -185,8 +188,8 @@ public class ComboBoxConnector extends AbstractFieldConnector
                     && uidl.hasAttribute("selectedCaption")) {
                 // scrolling to correct page is disabled, caption is passed as a
                 // special parameter
-                getWidget().tb
-                        .setText(uidl.getStringAttribute("selectedCaption"));
+                getWidget().tb.setText(uidl
+                        .getStringAttribute("selectedCaption"));
             } else {
                 resetSelection();
             }
@@ -274,16 +277,16 @@ public class ComboBoxConnector extends AbstractFieldConnector
             if (!getWidget().waitingForFilteringResponse
                     || getWidget().popupOpenerClicked) {
                 if (!suggestionKey.equals(getWidget().selectedOptionKey)
-                        || suggestion.getReplacementString()
-                                .equals(getWidget().tb.getText())
+                        || suggestion.getReplacementString().equals(
+                                getWidget().tb.getText())
                         || oldSuggestionTextMatchTheOldSelection) {
                     // Update text field if we've got a new
                     // selection
                     // Also update if we've got the same text to
                     // retain old text selection behavior
                     // OR if selected item caption is changed.
-                    getWidget()
-                            .setPromptingOff(suggestion.getReplacementString());
+                    getWidget().setPromptingOff(
+                            suggestion.getReplacementString());
                     getWidget().selectedOptionKey = suggestionKey;
                 }
             }
@@ -296,8 +299,8 @@ public class ComboBoxConnector extends AbstractFieldConnector
 
     private boolean isWidgetsCurrentSelectionTextInTextBox() {
         return getWidget().currentSuggestion != null
-                && getWidget().currentSuggestion.getReplacementString()
-                        .equals(getWidget().tb.getText());
+                && getWidget().currentSuggestion.getReplacementString().equals(
+                        getWidget().tb.getText());
     }
 
     private void resetSelection() {
@@ -319,8 +322,8 @@ public class ComboBoxConnector extends AbstractFieldConnector
                 // just clear the input if the value has changed from something
                 // else to null
                 if (getWidget().selectedOptionKey != null
-                        || (getWidget().allowNewItem
-                                && !getWidget().tb.getValue().isEmpty())) {
+                        || (getWidget().allowNewItem && !getWidget().tb
+                                .getValue().isEmpty())) {
                     getWidget().tb.setValue("");
                 }
             }

server/src/main/java/com/vaadin/ui/ComboBox.java

@@ -34,7 +34,6 @@ import com.vaadin.event.FieldEvents.FocusListener;
 import com.vaadin.server.PaintException;
 import com.vaadin.server.PaintTarget;
 import com.vaadin.server.Resource;
-import com.vaadin.shared.ui.combobox.ComboBoxConstants;
 import com.vaadin.shared.ui.combobox.ComboBoxState;
 import com.vaadin.shared.ui.combobox.FilteringMode;
 
@@ -75,8 +74,6 @@ public class ComboBox extends AbstractSelect implements
         public String getStyle(ComboBox source, Object itemId);
     }
 
-    private String inputPrompt = null;
-
     /**
      * Holds value of property pageLength. 0 disables paging.
      */
@@ -166,7 +163,7 @@ public class ComboBox extends AbstractSelect implements
      * @return the current input prompt, or null if not enabled
      */
     public String getInputPrompt() {
-        return inputPrompt;
+        return getState(false).inputPrompt;
     }
 
     /**
@@ -177,8 +174,7 @@ public class ComboBox extends AbstractSelect implements
      *            the desired input prompt, or null to disable
      */
     public void setInputPrompt(String inputPrompt) {
-        this.inputPrompt = inputPrompt;
-        markAsDirty();
+        getState().inputPrompt = inputPrompt;
     }
 
     private boolean isFilteringNeeded() {
@@ -190,15 +186,6 @@ public class ComboBox extends AbstractSelect implements
     public void paintContent(PaintTarget target) throws PaintException {
         isPainting = true;
         try {
-            if (inputPrompt != null) {
-                target.addAttribute(ComboBoxConstants.ATTR_INPUTPROMPT,
-                        inputPrompt);
-            }
-
-            if (!textInputAllowed) {
-                target.addAttribute(ComboBoxConstants.ATTR_NO_TEXT_INPUT, true);
-            }
-
             // clear caption change listeners
             getCaptionChangeListener().clear();
 
@@ -375,8 +362,7 @@ public class ComboBox extends AbstractSelect implements
      *            selection
      */
     public void setTextInputAllowed(boolean textInputAllowed) {
-        this.textInputAllowed = textInputAllowed;
-        markAsDirty();
+        getState().textInputAllowed = textInputAllowed;
     }
 
     /**
@@ -388,7 +374,7 @@ public class ComboBox extends AbstractSelect implements
      * @return
      */
     public boolean isTextInputAllowed() {
-        return textInputAllowed;
+        return getState(false).textInputAllowed;
     }
 
     @Override
@@ -396,6 +382,11 @@ public class ComboBox extends AbstractSelect implements
         return (ComboBoxState) super.getState();
     }
 
+    @Override
+    protected ComboBoxState getState(boolean markAsDirty) {
+        return (ComboBoxState) super.getState(markAsDirty);
+    }
+
     /**
      * Returns the filtered options for the current page using a container
      * filter.

shared/src/main/java/com/vaadin/shared/ui/combobox/ComboBoxState.java

@@ -26,4 +26,22 @@ public class ComboBoxState extends AbstractSelectState {
     {
         primaryStyleName = "v-filterselect";
     }
+
+    /**
+     * If text input is not allowed, the ComboBox behaves like a pretty
+     * NativeSelect - the user can not enter any text and clicking the text
+     * field opens the drop down with options.
+     * 
+     * @since
+     */
+    public boolean textInputAllowed = true;
+
+    /**
+     * A textual prompt that is displayed when the select would otherwise be
+     * empty, to prompt the user for input.
+     * 
+     * @since
+     */
+    public String inputPrompt = null;
+
 }