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, IClusterable, IConverterLocator, IFormVisitorParticipant, ILabelProvider

Direct Known Subclasses:

DefaultCssAutocompleteTextField

public abstract class AutoCompleteTextField
extends TextField

An implementation of a textfield with the autoassist ajax behavior AutoCompleteBehavior. FIXME javadoc - constructors need proper descriptions Note that you must add your own CSS to make the suggestion display properly, see DefaultCssAutocompleteTextField for an example.

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

DefaultCssAutocompleteTextField, AutoCompleteBehavior, IAutoCompleteRenderer, Serialized Form

Nested Class Summary

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

AbstractTextComponent.ITextFormatProvider

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

FormComponent.AbstractVisitor, FormComponent.IVisitor

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

Component.ComponentModelChange, Component.EnabledChange, 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, AutoCompleteSettings settings)
Construct.

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, IModel object)

AutoCompleteTextField(java.lang.String id, IModel object, AutoCompleteSettings settings)
Construct.

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

AutoCompleteTextField(java.lang.String id, IModel model, java.lang.Class type, AutoCompleteSettings settings)
Construct.

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

AutoCompleteTextField(java.lang.String id, IModel model, java.lang.Class type, IAutoCompleteRenderer renderer, AutoCompleteSettings settings)
Constructor

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

AutoCompleteTextField(java.lang.String id, 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.
protected int	getMaxHeightInPx()
protected AutoCompleteBehavior	newAutoCompleteBehavior(IAutoCompleteRenderer renderer, AutoCompleteSettings settings) Factory method for autocomplete behavior that will be added to this textfield
protected void	onBeforeRender() If the type is not set try to guess it if the model supports it.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.

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

getInputType

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

convertInput, convertValue, getConvertEmptyInputStringToNull, isInputNullable, setConvertEmptyInputStringToNull, supportsPersistence

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

add, checkRequired, clearInput, 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, shouldTrimInput, trim, 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, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, 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, isVisibilityAllowed, 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, setVisibilityAllowed, 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,
                             IModel model,
                             java.lang.Class type,
                             boolean preselect)

Parameters:

id -

model -

type -

preselect - the first item

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             IModel model,
                             java.lang.Class type,
                             AutoCompleteSettings settings)

Construct.

Parameters:

id -

model -

type -

settings -

AutoCompleteTextField

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

Parameters:

id -

object -

preselect -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             IModel object,
                             AutoCompleteSettings settings)

Construct.

Parameters:

id -

object -

settings -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             IModel object)

Parameters:

id -

object -

AutoCompleteTextField

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

Parameters:

id -

preselect -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             AutoCompleteSettings settings)

Construct.

Parameters:

id -

settings -

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,
                             IModel model,
                             IAutoCompleteRenderer renderer)

Parameters:

id -

model -

renderer -

AutoCompleteTextField

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

Parameters:

id -

model -

type -

renderer -

preselect -

AutoCompleteTextField

public AutoCompleteTextField(java.lang.String id,
                             IModel model,
                             java.lang.Class type,
                             IAutoCompleteRenderer renderer,
                             AutoCompleteSettings settings)

Constructor

Parameters:

id -

model -

type -

renderer -

settings -

Method Detail

newAutoCompleteBehavior

protected AutoCompleteBehavior newAutoCompleteBehavior(IAutoCompleteRenderer renderer,
                                                       AutoCompleteSettings settings)

Factory method for autocomplete behavior that will be added to this textfield

Parameters:

renderer - auto complete renderer

settings - auto complete settings

Returns:

auto complete behavior

onBeforeRender

protected void onBeforeRender()

Description copied from class: AbstractTextComponent

If the type is not set try to guess it if the model supports it.

Overrides:

onBeforeRender in class AbstractTextComponent

See Also:

AbstractTextComponent.onBeforeRender()

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: TextField

Processes the component tag.

Overrides:

onComponentTag in class TextField

Parameters:

tag - Tag to modify

See Also:

TextField.onComponentTag(org.apache.wicket.markup.ComponentTag)

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 over all possible choice objects

See Also:

AutoCompleteBehavior.getChoices(String)

getMaxHeightInPx

protected int getMaxHeightInPx()