wicket.extensions.ajax.markup.html.autocomplete
Interface IAutoCompleteRenderer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractAutoCompleteRenderer

public interface IAutoCompleteRenderer

extends java.io.Serializable

A renderer used to generate html output for the AutoCompleteBehavior.

Helper implementations of this interface may abstract the implementation specific details. Direct implementations of this interface should only be used when total control is required.

The autocompletion value is supplied via an attribute on the first html element named textvalue, if no attribute is found the innerHtml property of the first element will be used instead. For example:

 new IAutoCompleteRenderer() {
     void renderHead(Response r) { r.write("
"); }
     
     void render(Object o, Response r) {
        // notice the textvalue attribute we define for li element
        r.write("
"+o.toString()+"
";
     }
     
     void renderFooter(Response r) { r.write("
"); }
 }
 

Since:

1.2

Author:

Igor Vaynberg (ivaynberg), Janne Hietamäki (jannehietamaki)

Method Summary

void	render(java.lang.Object object, wicket.Response response, java.lang.String criteria) Render the html fragment for the given completion object.
void	renderFooter(wicket.Response response) Render the html footer fragment for the completion.
void	renderHeader(wicket.Response response) Render the html header fragment for the completion.

Method Detail

render

public void render(java.lang.Object object,
                   wicket.Response response,
                   java.lang.String criteria)

Render the html fragment for the given completion object. Usually the html is written out by calling Response.write(CharSequence).

Parameters:

object - completion choice object

response -

criteria -

renderHeader

public void renderHeader(wicket.Response response)

Render the html header fragment for the completion. Usually the html is written out by calling Response.write(CharSequence).

Parameters:

response -

renderFooter

public void renderFooter(wicket.Response response)

Render the html footer fragment for the completion. Usually the html is written out by calling Response.write(CharSequence).

Parameters:

response -