Spiffy UI Framework

org.spiffyui.client.widgets.multivaluesuggest
Class MultivalueSuggestBox

java.lang.Object
  extended by Composite
      extended by org.spiffyui.client.widgets.multivaluesuggest.MultivalueSuggestBoxBase
          extended by org.spiffyui.client.widgets.multivaluesuggest.MultivalueSuggestBox

public class MultivalueSuggestBox
extends MultivalueSuggestBoxBase

A SuggestBox that uses the rest package and allows for multiple values and autocomplete. It will also allow for browsing, assuming that the REST endpoint supports idxFrom and idxTo url parameters. The payload of the REST endpoint should have the following format, but the JSON keys are configurable, by specifying them in the MultivalueSuggestRESTHelper:

 { 
  "TotalSize" : 133, 
  "Options" : [
   {"Value" : "#EFDECD", "DisplayName" : "Almond"},
   {"Value" : "#CD9575", "DisplayName" : "Antique Brass"},
   {"Value" : "#FDD9B5", "DisplayName" : "Apricot"}
  ]
 }
 


Nested Class Summary
 
Nested classes/interfaces inherited from class org.spiffyui.client.widgets.multivaluesuggest.MultivalueSuggestBoxBase
MultivalueSuggestBoxBase.Option, MultivalueSuggestBoxBase.OptionResultSet, MultivalueSuggestBoxBase.OptionSuggestion, MultivalueSuggestBoxBase.SelectedItem
 
Constructor Summary
MultivalueSuggestBox(MultivalueSuggestHelper restHelper, boolean isMultivalued, boolean placeFormFeedback)
          Create a new MultivalueSuggestBox
MultivalueSuggestBox(MultivalueSuggestRESTHelper restHelper, boolean isMultivalued)
          Create a new MultivalueSuggestBox
 
Method Summary
protected  void queryOptions(java.lang.String query, int from, int to, RESTObjectCallBack<MultivalueSuggestBoxBase.OptionResultSet> callback)
          Retrieve Options (name-value pairs) that are suggested from the REST endpoint
 
Methods inherited from class org.spiffyui.client.widgets.multivaluesuggest.MultivalueSuggestBoxBase
addKeyUpHandler, addSelectedOption, addValueChangeHandler, createOption, createOptionSuggestion, createSelectedItem, getFeedback, getHelper, getInvalidReason, getInvalidText, getSelectedItemEq, getSelectedOptions, getSuggestBox, getSuggestBoxContainerId, getTabIndex, getText, getValue, getValueMap, getValuesAsString, handleQueryResponse, onKeyUp, onLoad, onSelection, setAccessKey, setDelay, setDisplaySeparator, setFeedback, setFocus, setLoadingText, setPageSize, setSelectedItemEq, setSelectedOptions, setTabIndex, setText, setValidText, setValueDelim, setValueMap, setValuesAsString, updateFormFeedback
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultivalueSuggestBox

public MultivalueSuggestBox(MultivalueSuggestRESTHelper restHelper,
                            boolean isMultivalued)
Create a new MultivalueSuggestBox

Parameters:
restHelper - the REST helper for getting remote values
isMultivalued - true if this suggest box supports multiple values and false otherwise

MultivalueSuggestBox

public MultivalueSuggestBox(MultivalueSuggestHelper restHelper,
                            boolean isMultivalued,
                            boolean placeFormFeedback)
Create a new MultivalueSuggestBox

Parameters:
restHelper - the REST helper for getting remote values
isMultivalued - true if this suggest box supports multiple values and false otherwise
placeFormFeedback - true if this control should place a form feedback and false otherwise
Method Detail

queryOptions

protected void queryOptions(java.lang.String query,
                            int from,
                            int to,
                            RESTObjectCallBack<MultivalueSuggestBoxBase.OptionResultSet> callback)
Retrieve Options (name-value pairs) that are suggested from the REST endpoint

Specified by:
queryOptions in class MultivalueSuggestBoxBase
Parameters:
query - - the String search term
from - - the 0-based begin index int
to - - the end index inclusive int
callback - - the RESTObjectCallBack to handle the response

Spiffy UI Framework