/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.extensions.ajax.markup.html.autocomplete;
import org.apache.wicket.model.IDetachable;
import org.apache.wicket.request.Response;
/**
* A renderer used to generate html output for the {@link AutoCompleteBehavior}.
* <p>
* 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.
* <p>
* The autocompletion value is supplied via an attribute on the first html element named
* <code>textvalue</code>, if no attribute is found the innerHtml property of the first element will
* be used instead.
*
* For example:
*
* <pre>
* new IAutoCompleteRenderer() {
* void renderHead(Response r) { r.write("
* <ul>
* "); }
*
* void render(Object o, Response r) {
* // notice the textvalue attribute we define for li element
* r.write("
* <li textvalue=\""+o.toString()+"\">
* <i>"+o.toString()+"</i>
* </li>
* ";
* }
*
* void renderFooter(Response r) { r.write("
* </ul>
* "); }
* }
* </pre>
*
* @param <T>
*
* @since 1.2
*
* @author Igor Vaynberg (ivaynberg)
* @author Janne Hietamäki (jannehietamaki)
*
*/
public interface IAutoCompleteRenderer<T> extends IDetachable
{
/**
* Render the html fragment for the given completion object. Usually the html is written out by
* calling {@link Response#write(CharSequence)}.
*
* @param object
* completion choice object
* @param response
* response object
* @param criteria
* text entered by user so far
*/
void render(T object, Response response, String criteria);
/**
* Render the html header fragment for the completion. Usually the html is written out by
* calling {@link Response#write(CharSequence)}.
*
* @param response
*/
void renderHeader(Response response);
/**
* Render the html footer fragment for the completion. Usually the html is written out by
* calling {@link Response#write(CharSequence)}.
*
* @param response
* @param count
* The number of choices rendered
*/
void renderFooter(Response response, int count);
/**
* Override when needed.
*/
@Override
default void detach()
{
}
}