com.googlecode.wicket.jquery.ui.form.autocomplete
Class AutoCompleteTextField<T extends Serializable>

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  org.apache.wicket.markup.html.form.FormComponent<T>
                      org.apache.wicket.markup.html.form.AbstractTextComponent<T>
                          org.apache.wicket.markup.html.form.TextField<T>
                              com.googlecode.wicket.jquery.ui.form.autocomplete.AutoCompleteTextField<T>

Type Parameters:

T - the type of the model object

All Implemented Interfaces:

IJQueryWidget, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public abstract class AutoCompleteTextField<T extends Serializable>
extends org.apache.wicket.markup.html.form.TextField<T>
implements IJQueryWidget

Provides a jQuery auto-complete widget

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

AutoCompleteTextField(String id)
Constructor

AutoCompleteTextField(String id, Class<T> type)
Constructor

AutoCompleteTextField(String id, org.apache.wicket.model.IModel<T> model)
Constructor

AutoCompleteTextField(String id, org.apache.wicket.model.IModel<T> model, Class<T> type)
Constructor

AutoCompleteTextField(String id, org.apache.wicket.model.IModel<T> model, ITextRenderer<? super T> renderer)
Constructor

AutoCompleteTextField(String id, org.apache.wicket.model.IModel<T> model, ITextRenderer<? super T> renderer, Class<T> type)
Constructor

AutoCompleteTextField(String id, ITextRenderer<? super T> renderer)
Constructor

AutoCompleteTextField(String id, ITextRenderer<? super T> renderer, Class<T> type)
Constructor

Method Summary

protected abstract List<T>	getChoices(String input) Gets choices matching the provided input
<C> org.apache.wicket.util.convert.IConverter<C>	getConverter(Class<C> type)
protected String	getModelValue()
protected IJQueryTemplate	newTemplate() Gets a new IJQueryTemplate to customize the rendering The IJQueryTemplate.getText() should return a template text of the form "<a>...</a>". The properties used in the template text (ie: ${name}) should be identified in the list returned by IJQueryTemplate.getTextProperties()
JQueryBehavior	newWidgetBehavior(String selector)
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
protected void	onConfigure(JQueryBehavior behavior) Called immediately after the onConfigure method in a behavior.
protected void	onInitialize()
void	onSelect(org.apache.wicket.ajax.AjaxRequestTarget target, int index)
protected void	onSelected(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when the user selects an item from results that matched its input

Methods inherited from class org.apache.wicket.markup.html.form.TextField

getInputType

Methods inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

convertInput, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, checkRequired, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AutoCompleteTextField

public AutoCompleteTextField(String id)

Constructor

Parameters:

id - the markup id

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             Class<T> type)

Constructor

Parameters:

id - the markup id

type - the type of the bean. This parameter should be supplied for the internal converter (getConverter(Class)) to be used.

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             ITextRenderer<? super T> renderer)

Constructor

Parameters:

id - the markup id

renderer - the ITextRenderer

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             ITextRenderer<? super T> renderer,
                             Class<T> type)

Constructor

Parameters:

id - the markup id

renderer - the ITextRenderer

type - the type of the bean. This parameter should be supplied for the internal converter (getConverter(Class)) to be used.

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             org.apache.wicket.model.IModel<T> model)

Constructor

Parameters:

id - the markup id

model - the IModel

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             org.apache.wicket.model.IModel<T> model,
                             Class<T> type)

Constructor

Parameters:

id - the markup id

model - the IModel

type - the type of the bean. This parameter should be supplied for the internal converter (getConverter(Class)) to be used.

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             org.apache.wicket.model.IModel<T> model,
                             ITextRenderer<? super T> renderer)

Constructor

Parameters:

id - the markup id

model - the IModel

renderer - the ITextRenderer

AutoCompleteTextField

public AutoCompleteTextField(String id,
                             org.apache.wicket.model.IModel<T> model,
                             ITextRenderer<? super T> renderer,
                             Class<T> type)

Constructor

Parameters:

id - the markup id

model - the IModel

renderer - the ITextRenderer

type - the type of the bean. This parameter should be supplied for the internal converter (getConverter(Class)) to be used.

Method Detail

getModelValue

protected String getModelValue()

Overrides:

getModelValue in class org.apache.wicket.markup.html.form.FormComponent<T extends Serializable>

getChoices

protected abstract List<T> getChoices(String input)

Gets choices matching the provided input

Parameters:

input - String that represent the query

Returns:

the list of choices

getConverter

public <C> org.apache.wicket.util.convert.IConverter<C> getConverter(Class<C> type)

Specified by:

getConverter in interface org.apache.wicket.IConverterLocator

Overrides:

getConverter in class org.apache.wicket.Component

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

onConfigure

protected void onConfigure(JQueryBehavior behavior)

Called immediately after the onConfigure method in a behavior. Since this is before the rendering cycle has begun, the behavior can modify the configuration of the component (i.e. Options)

Parameters:

behavior - the JQueryBehavior

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Overrides:

onComponentTag in class org.apache.wicket.markup.html.form.TextField<T extends Serializable>

onSelect

public final void onSelect(org.apache.wicket.ajax.AjaxRequestTarget target,
                           int index)

onSelected

protected void onSelected(org.apache.wicket.ajax.AjaxRequestTarget target)

Triggered when the user selects an item from results that matched its input

Parameters:

target - the AjaxRequestTarget

newWidgetBehavior

public JQueryBehavior newWidgetBehavior(String selector)

Specified by:

newWidgetBehavior in interface IJQueryWidget

newTemplate

protected IJQueryTemplate newTemplate()

Gets a new IJQueryTemplate to customize the rendering
The IJQueryTemplate.getText() should return a template text of the form "<a>...</a>".
The properties used in the template text (ie: ${name}) should be identified in the list returned by IJQueryTemplate.getTextProperties()

Returns:

null by default