org.bejug.javacareers.common.ajax
Interface Completable

public interface Completable

Interface implemented by classes which can provide completion results for a given prefix.

Author:

Tor Norbye (Last modified by $Author: shally $) $Revision: 1.3 $ - $Date: 2005/12/08 14:53:45 $

Method Summary

void	complete(javax.faces.context.FacesContext context, java.lang.String prefix, CompletionResult result) This method is called asynchronously from client javascript calls; it should return a short list of possible matches for the given prefix as an array of Strings.

Method Detail

complete

public void complete(javax.faces.context.FacesContext context,
                     java.lang.String prefix,
                     CompletionResult result)

This method is called asynchronously from client javascript calls; it should return a short list of possible matches for the given prefix as an array of Strings. These are returned by adding them to the result object. These items will then be presented to the user in an auto complete popup.

Parameters:

context - The faces context for the JSF application

prefix - A string prefix to select matches from (note that the prefix may be empty in which case it may be natural to return the first N matches.

result - A result object; call CompletionResult.addItem(String) to populate the completion result returned to the browser.