From 393ad06f402464ba6340b3605c3cd9e1d08dd0e8 Mon Sep 17 00:00:00 2001
From: Musachy Barroso <musachy@apache.org>
Date: Thu, 7 Jun 2007 00:04:23 +0000
Subject: [PATCH] WW-1975 Autocompleter w/loadMinimumCount ask for data on
 loading page * Add "preload" attribute, which default to true (like in the
 div tag), which will prevent the autocompleter from loading its options when
 page is loaded

git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@545001 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/struts2/dojo/components/Autocompleter.java | 8 ++++++++
 .../struts2/dojo/views/jsp/ui/AutocompleterTag.java       | 6 ++++++
 .../apache/struts2/static/dojo/struts/widget/ComboBox.js  | 5 ++++-
 .../org/apache/struts2/static/dojo/struts_dojo.js         | 4 ++--
 .../struts2/static/dojo/struts_dojo.js.uncompressed.js    | 5 ++++-
 .../src/main/resources/template/ajax/autocompleter.ftl    | 3 +++
 .../struts2/dojo/views/jsp/ui/AutocompleterTest.java      | 1 +
 .../apache/struts2/dojo/views/jsp/ui/Autocompleter-1.txt  | 1 +
 8 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Autocompleter.java b/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Autocompleter.java
index dbd7661b6..f6101333c 100644
--- a/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Autocompleter.java
+++ b/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Autocompleter.java
@@ -252,6 +252,7 @@ public class Autocompleter extends ComboBox {
     protected String valueNotifyTopics;
     protected String resultsLimit;
     protected String transport;
+    protected String preload;
     
     public Autocompleter(ValueStack stack, HttpServletRequest request,
             HttpServletResponse response) {
@@ -324,6 +325,8 @@ public class Autocompleter extends ComboBox {
         }
         if (transport != null)
             addParameter("transport", findString(transport));
+        if (preload != null)
+            addParameter("preload", findValue(preload, Boolean.class));
         
         String keyNameExpr = "%{" + keyName + "}";
         addParameter("key", findString(keyNameExpr));
@@ -516,4 +519,9 @@ public class Autocompleter extends ComboBox {
     public void setTransport(String transport) {
         this.transport = transport;
     }
+    
+    @StrutsTagAttribute(description="Load options when page is loaded", type="Boolean", defaultValue="true")
+    public void setPreload(String preload) {
+        this.preload = preload;
+    }
 }
diff --git a/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTag.java b/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTag.java
index 54ac5ce0a..5e26e9f56 100644
--- a/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTag.java
+++ b/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTag.java
@@ -61,6 +61,7 @@ public class AutocompleterTag extends ComboBoxTag {
     protected String valueNotifyTopics;
     protected String resultsLimit;
     protected String transport;
+    protected String preload;
     
     public Component getBean(ValueStack stack, HttpServletRequest req, HttpServletResponse res) {
         return new Autocompleter(stack, req, res);
@@ -96,6 +97,7 @@ public class AutocompleterTag extends ComboBoxTag {
         autocompleter.setValueNotifyTopics(valueNotifyTopics);
         autocompleter.setResultsLimit(resultsLimit);
         autocompleter.setTransport(transport);
+        autocompleter.setPreload(preload);
     }
 
     public void setAutoComplete(String autoComplete) {
@@ -205,4 +207,8 @@ public class AutocompleterTag extends ComboBoxTag {
     public void setTransport(String transport) {
         this.transport = transport;
     }
+
+    public void setPreload(String preload) {
+        this.preload = preload;
+    }
 }
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/ComboBox.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/ComboBox.js
index e959939c8..6989dac65 100644
--- a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/ComboBox.js
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/ComboBox.js
@@ -184,7 +184,7 @@ struts.widget.ComboBoxDataProvider = function(combobox, node){
   };
 
 
-  if(!dojo.string.isBlank(this.cbox.dataUrl)){
+  if(!dojo.string.isBlank(this.cbox.dataUrl) && this.cbox.preload){
     this.getData(this.cbox.dataUrl);
   } else {
     // check to see if we can populate the list from <option> elements
@@ -255,6 +255,9 @@ dojo.widget.defineWidget(
   
   transport : "",
   
+  //load options when page loads
+  preload : true,
+  
   //from Dojo's  ComboBox
   showResultList: function() {
   // Our dear friend IE doesnt take max-height so we need to calculate that on our own every time
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
index a2756119e..25fdfe454 100644
--- a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
@@ -14982,7 +14982,7 @@ this.data[i]=[_c79,_c79];
 }
 }
 };
-if(!dojo.string.isBlank(this.cbox.dataUrl)){
+if(!dojo.string.isBlank(this.cbox.dataUrl)&&this.cbox.preload){
 this.getData(this.cbox.dataUrl);
 }else{
 if((node)&&(node.nodeName.toLowerCase()=="select")){
@@ -15001,7 +15001,7 @@ this.setData(data);
 }
 }
 };
-dojo.widget.defineWidget("struts.widget.ComboBox",dojo.widget.ComboBox,{widgetType:"ComboBox",dropdownHeight:120,dropdownWidth:0,itemHeight:0,listenTopics:"",notifyTopics:"",notifyTopicsArray:null,beforeNotifyTopics:"",beforeNotifyTopicsArray:null,afterNotifyTopics:"",afterNotifyTopicsArray:null,errorNotifyTopics:"",errorNotifyTopicsArray:null,valueNotifyTopics:"",valueNotifyTopicsArray:null,indicator:"",formId:"",formFilter:"",dataProviderClass:"struts.widget.ComboBoxDataProvider",loadOnType:false,loadMinimum:3,initialValue:"",initialKey:"",visibleDownArrow:true,fadeTime:100,searchType:"STARTSTRING",dataFieldName:"",keyName:"",templateCssString:null,templateCssString:".dojoComboBoxOuter {\n\tborder: 0px !important;\n\tmargin: 0px !important;\n\tpadding: 0px !important;\n\tbackground: transparent !important;\n\twhite-space: nowrap !important;\n}\n\n.dojoComboBox {\n\tborder: 1px inset #afafaf;\n\tmargin: 0px;\n\tpadding: 0px;\n\tvertical-align: middle !important;\n\tfloat: none !important;\n\tposition: static !important;\n\tdisplay: inline;\n}\n\n/* the input box */\ninput.dojoComboBox {\n\tborder-right-width: 1px !important;\n\tmargin-right: 0px !important;\n\tpadding-right: 0px !important;\n}\n\n/* the down arrow */\nimg.dojoComboBox {\n\tborder-left-width: 0px !important;\n\tpadding-left: 0px !important;\n\tmargin-left: 0px !important;\n}\n\n/* IE vertical-alignment calculations can be off by +-1 but these margins are collapsed away */\n.dj_ie img.dojoComboBox {\n\tmargin-top: 1px;\n\tmargin-bottom: 1px;\n}\n\n/* the drop down */\n.dojoComboBoxOptions {\n\tfont-family: Verdana, Helvetica, Garamond, sans-serif;\n\t/* font-size: 0.7em; */\n\tbackground-color: white;\n\tborder: 1px solid #afafaf;\n\tposition: absolute;\n\tz-index: 1000;\n\toverflow: auto;\n\tcursor: default;\n}\n\n.dojoComboBoxItem {\n\tpadding-left: 2px;\n\tpadding-top: 2px;\n\tmargin: 0px;\n}\n\n.dojoComboBoxItemEven {\n\tbackground-color: #f4f4f4;\n}\n\n.dojoComboBoxItemOdd {\n\tbackground-color: white;\n}\n\n.dojoComboBoxItemHighlight {\n\tbackground-color: #63709A;\n\tcolor: white;\n}\n",templateCssPath:dojo.uri.dojoUri("struts/ComboBox.css"),searchLimit:30,transport:"",showResultList:function(){
+dojo.widget.defineWidget("struts.widget.ComboBox",dojo.widget.ComboBox,{widgetType:"ComboBox",dropdownHeight:120,dropdownWidth:0,itemHeight:0,listenTopics:"",notifyTopics:"",notifyTopicsArray:null,beforeNotifyTopics:"",beforeNotifyTopicsArray:null,afterNotifyTopics:"",afterNotifyTopicsArray:null,errorNotifyTopics:"",errorNotifyTopicsArray:null,valueNotifyTopics:"",valueNotifyTopicsArray:null,indicator:"",formId:"",formFilter:"",dataProviderClass:"struts.widget.ComboBoxDataProvider",loadOnType:false,loadMinimum:3,initialValue:"",initialKey:"",visibleDownArrow:true,fadeTime:100,searchType:"STARTSTRING",dataFieldName:"",keyName:"",templateCssString:null,templateCssString:".dojoComboBoxOuter {\n\tborder: 0px !important;\n\tmargin: 0px !important;\n\tpadding: 0px !important;\n\tbackground: transparent !important;\n\twhite-space: nowrap !important;\n}\n\n.dojoComboBox {\n\tborder: 1px inset #afafaf;\n\tmargin: 0px;\n\tpadding: 0px;\n\tvertical-align: middle !important;\n\tfloat: none !important;\n\tposition: static !important;\n\tdisplay: inline;\n}\n\n/* the input box */\ninput.dojoComboBox {\n\tborder-right-width: 1px !important;\n\tmargin-right: 0px !important;\n\tpadding-right: 0px !important;\n}\n\n/* the down arrow */\nimg.dojoComboBox {\n\tborder-left-width: 0px !important;\n\tpadding-left: 0px !important;\n\tmargin-left: 0px !important;\n}\n\n/* IE vertical-alignment calculations can be off by +-1 but these margins are collapsed away */\n.dj_ie img.dojoComboBox {\n\tmargin-top: 1px;\n\tmargin-bottom: 1px;\n}\n\n/* the drop down */\n.dojoComboBoxOptions {\n\tfont-family: Verdana, Helvetica, Garamond, sans-serif;\n\t/* font-size: 0.7em; */\n\tbackground-color: white;\n\tborder: 1px solid #afafaf;\n\tposition: absolute;\n\tz-index: 1000;\n\toverflow: auto;\n\tcursor: default;\n}\n\n.dojoComboBoxItem {\n\tpadding-left: 2px;\n\tpadding-top: 2px;\n\tmargin: 0px;\n}\n\n.dojoComboBoxItemEven {\n\tbackground-color: #f4f4f4;\n}\n\n.dojoComboBoxItemOdd {\n\tbackground-color: white;\n}\n\n.dojoComboBoxItemHighlight {\n\tbackground-color: #63709A;\n\tcolor: white;\n}\n",templateCssPath:dojo.uri.dojoUri("struts/ComboBox.css"),searchLimit:30,transport:"",preload:true,showResultList:function(){
 var _c80=this.optionsListNode.childNodes;
 if(_c80.length){
 this.optionsListNode.style.width=this.dropdownWidth===0?(dojo.html.getMarginBox(this.domNode).width-2)+"px":this.dropdownWidth+"px";
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js.uncompressed.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js.uncompressed.js
index 042b038e9..df8b0337b 100644
--- a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js.uncompressed.js
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js.uncompressed.js
@@ -24312,7 +24312,7 @@ struts.widget.ComboBoxDataProvider = function(combobox, node){
   };
 
 
-  if(!dojo.string.isBlank(this.cbox.dataUrl)){
+  if(!dojo.string.isBlank(this.cbox.dataUrl) && this.cbox.preload){
     this.getData(this.cbox.dataUrl);
   } else {
     // check to see if we can populate the list from <option> elements
@@ -24383,6 +24383,9 @@ dojo.widget.defineWidget(
   
   transport : "",
   
+  //load options when page loads
+  preload : true,
+  
   //from Dojo's  ComboBox
   showResultList: function() {
   // Our dear friend IE doesnt take max-height so we need to calculate that on our own every time
diff --git a/plugins/dojo/src/main/resources/template/ajax/autocompleter.ftl b/plugins/dojo/src/main/resources/template/ajax/autocompleter.ftl
index 74bc281ff..9e00b34a8 100644
--- a/plugins/dojo/src/main/resources/template/ajax/autocompleter.ftl
+++ b/plugins/dojo/src/main/resources/template/ajax/autocompleter.ftl
@@ -110,6 +110,9 @@
 <#if parameters.transport?if_exists != "">
   transport="${parameters.transport?html}"<#rt/>
 </#if>
+<#if parameters.preload?exists>
+  preload="${parameters.preload?string?html}"<#rt/>
+</#if>
 <#include "/${parameters.templateDir}/simple/scripting-events.ftl" />
 <#include "/${parameters.templateDir}/simple/common-attributes.ftl" />
 <#if parameters.href?exists>
diff --git a/plugins/dojo/src/test/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTest.java b/plugins/dojo/src/test/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTest.java
index 58bbfc20b..cfed157a6 100644
--- a/plugins/dojo/src/test/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTest.java
+++ b/plugins/dojo/src/test/java/org/apache/struts2/dojo/views/jsp/ui/AutocompleterTest.java
@@ -50,6 +50,7 @@ public class AutocompleterTest extends AbstractUITagTest {
         tag.setValueNotifyTopics("l");
         tag.setResultsLimit("2");
         tag.setTransport("m");
+        tag.setPreload("true");
         tag.doStartTag();
         tag.doEndTag();
 
diff --git a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/Autocompleter-1.txt b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/Autocompleter-1.txt
index e5634f5b7..45803e396 100644
--- a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/Autocompleter-1.txt
+++ b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/Autocompleter-1.txt
@@ -21,4 +21,5 @@
  dataFieldName="k"
  searchLimit="2"
  transport="m"
+ preload="true"
 />