org.apache.wicket.extensions.ajax.markup.html.autocomplete
Class AutoCompleteTextField

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
                      org.apache.wicket.markup.html.form.AbstractTextComponent
                          org.apache.wicket.markup.html.form.TextField
                              org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteTextField

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider

public abstract class AutoCompleteTextField
extends org.apache.wicket.markup.html.form.TextField

An implementation of a textfield with the autoassist ajax behavior

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

AutoCompleteBehavior, IAutoCompleteRenderer, 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 class org.apache.wicket.markup.html.form.FormComponent

org.apache.wicket.markup.html.form.FormComponent.AbstractVisitor, org.apache.wicket.markup.html.form.FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.VisibilityChange

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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

AutoCompleteTextField(java.lang.String id)

AutoCompleteTextField(java.lang.String id, boolean preselect)

AutoCompleteTextField(java.lang.String id, java.lang.Class type)

AutoCompleteTextField(java.lang.String id, java.lang.Class type, IAutoCompleteRenderer renderer)

AutoCompleteTextField(java.lang.String id, IAutoCompleteRenderer renderer)

AutoCompleteTextField(java.lang.String id, org.apache.wicket.model.IModel object)

AutoCompleteTextField(java.lang.String id, org.apache.wicket.model.IModel object, boolean preselect)

AutoCompleteTextField(java.lang.String id, org.apache.wicket.model.IModel model, java.lang.Class type, boolean preselect)

AutoCompleteTextField(java.lang.String id, org.apache.wicket.model.IModel model, java.lang.Class type, IAutoCompleteRenderer renderer, boolean preselect)

AutoCompleteTextField(java.lang.String id, org.apache.wicket.model.IModel model, IAutoCompleteRenderer renderer)

Method Summary

protected abstract java.util.Iterator

getChoices(java.lang.String input) Callback method that should return an iterator over all possible assist choice objects.

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

getInputType, onComponentTag

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

convertValue, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull, supportsPersistence

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

add, checkRequired, clearInput, convertInput, error, getBehaviors, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isPersistent, isRequired, isValid, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, updateModel, valid, validate, validateRequired, validateValidators, visitFormComponentsPostOrder

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

getLabel, setLabelInternal

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, 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(java.lang.String id,
                             java.lang.Class type)

Parameters:

id -

type -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             org.apache.wicket.model.IModel model,
                             java.lang.Class type,
                             boolean preselect)

Parameters:

id -

model -

type -

preselect - the first item

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             org.apache.wicket.model.IModel object,
                             boolean preselect)

Parameters:

id -

object -

preselect -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             org.apache.wicket.model.IModel object)

Parameters:

id -

object -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             boolean preselect)

Parameters:

id -

preselect -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id)

Parameters:

id -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             IAutoCompleteRenderer renderer)

Parameters:

id -

renderer -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             java.lang.Class type,
                             IAutoCompleteRenderer renderer)

Parameters:

id -

type -

renderer -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             org.apache.wicket.model.IModel model,
                             IAutoCompleteRenderer renderer)

Parameters:

id -

model -

renderer -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             org.apache.wicket.model.IModel model,
                             java.lang.Class type,
                             IAutoCompleteRenderer renderer,
                             boolean preselect)

Parameters:

id -

model -

type -

renderer -

preselect -

Method Detail

getChoices

protected abstract java.util.Iterator getChoices(java.lang.String input)

Callback method that should return an iterator over all possible assist choice objects. These objects will be passed to the renderer to generate output. Usually it is enough to return an iterator over strings.

Parameters:

input - current input

Returns:

iterator ver all possible choice objects

See Also:

AutoCompleteBehavior.getChoices(String)