ChoiceProvider (Wicketstuff-Select2 Components 7.0.0-M3 API)

java.lang.Object
- org.wicketstuff.select2.ChoiceProvider<T>

Type Parameters:
T - type of choice object

All Implemented Interfaces:

Serializable, IDetachable, IClusterable

Direct Known Subclasses:

TextChoiceProvider
```
public abstract class ChoiceProvider<T>
extends Object
implements IDetachable
```
Acts as a bridge between Select2 components and the application's domain model.

The two important services provided by implementations are:
- Feeding choices, represented by the application's domain objects, to Select2 components
- Transcoding said choices to and from Json so they can consumed by Select2
For the most common usecase where each choice is rendered as a text string see TextChoiceProvider.
Author:

igor

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ChoiceProvider()

Constructors
Constructor and Description
`ChoiceProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`detach()`
`abstract void`	`query(String term, int page, Response<T> response)` Queries application for choices that match the search `term` and adds them to the `response`
`abstract Collection<T>`	`toChoices(Collection<String> ids)` Converts a list of choice ids back into application's choice objects.
`abstract void`	`toJson(T choice, org.json.JSONWriter writer)` Converts the specified choice to Json.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChoiceProvider
```
public ChoiceProvider()
```
- Method Detail
  - query
```
public abstract void query(String term,
         int page,
         Response<T> response)
```
    Queries application for choices that match the search term and adds them to the response
    
    Parameters:
    term - search term
    page - requested search term results page
    response - aggregate for matching choices as well as other response options
  - toJson
```
public abstract void toJson(T choice,
          org.json.JSONWriter writer)
                     throws org.json.JSONException
```
    Converts the specified choice to Json.
    At the very least each choice should contain an id attribute. If no custom rendering function is specified, the text attribute should also be provided
    
    Example: If mapping a User {Long id, String name} using default rendering the code should look like this:
```
 toJson(User choice, JSONWriter writer) {
     writer.key("id").value(choice.getId()).key("text").value(choice.getName());
 }
 
```
    Parameters:
    choice - choice to convert
    writer - Json writer that should be used to covnert the choice
    
    Throws:
    
    org.json.JSONException
  - toChoices
```
public abstract Collection<T> toChoices(Collection<String> ids)
```
    Converts a list of choice ids back into application's choice objects. When the choice provider is attached to a single-select component the ids collection will contain exactly one id, and a collection containing exactly one choice should be returned.
    
    Parameters:
    ids - collection containing choice ids
    
    Returns:
    collection containing application choice objects
  - detach
```
public void detach()
```
    Specified by:
    
    detach in interface IDetachable

Class ChoiceProvider<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChoiceProvider

Method Detail

query

toJson

toChoices

detach