org.wicketstuff.select2

Class TextChoiceProvider<T>

java.lang.Object

org.wicketstuff.select2.TextChoiceProvider<T>

Type Parameters:

T - type of choice object

All Implemented Interfaces:

Serializable, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable, ChoiceProvider<T>

Direct Known Subclasses:

HomePage.CountriesProvider, StringTextChoiceProvider

public abstract class TextChoiceProvider<T>
extends Object
implements ChoiceProvider<T>

Takes care of Json serialization for the most common usecase where each choice is rendered as a text string.

Author:

igor

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextChoiceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	detach()
protected abstract String	getDisplayText(T choice)
protected abstract Object	getId(T choice)
void	toJson(T choice, org.apache.wicket.ajax.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

Methods inherited from interface org.wicketstuff.select2.ChoiceProvider

query, toChoices

Constructor Detail

TextChoiceProvider

public TextChoiceProvider()

Method Detail

getDisplayText

protected abstract String getDisplayText(T choice)

getId

protected abstract Object getId(T choice)

toJson

public final void toJson(T choice,
          org.apache.wicket.ajax.json.JSONWriter writer)
                  throws org.apache.wicket.ajax.json.JSONException

Description copied from interface: ChoiceProvider

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());
 }
 

Specified by:

toJson in interface ChoiceProvider<T>

Parameters:

choice - choice to convert

writer - Json writer that should be used to covnert the choice

Throws:

org.apache.wicket.ajax.json.JSONException

detach

public void detach()

Specified by:

detach in interface org.apache.wicket.model.IDetachable