T
- The model object typepublic abstract class AutoCompleteTextField<T> extends TextField<T>
AutoCompleteBehavior
.
An IAutoCompleteRenderer
is used for rendering of choices. To convert input back into a
non-String type you will have to provide a custom IConverter
, either by overriding
Component.getConverter(Class)
or by setting a suitable IConverter
on the application's
ConverterLocator
.
Note that you must add your own CSS to make the suggestion display properly, see
DefaultCssAutoCompleteTextField
for an example.
DefaultCssAutoCompleteTextField
,
AutoCompleteBehavior
,
IAutoCompleteRenderer
,
Serialized FormAbstractTextComponent.ITextFormatProvider
FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR
ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING
Constructor and Description |
---|
AutoCompleteTextField(String id)
Constructor.
|
AutoCompleteTextField(String id,
AutoCompleteSettings settings)
Constructor.
|
AutoCompleteTextField(String id,
Class<T> type)
Constructor for the given type with default settings.
|
AutoCompleteTextField(String id,
Class<T> type,
IAutoCompleteRenderer<T> renderer)
Constructor for the given type using the given renderer
|
AutoCompleteTextField(String id,
IAutoCompleteRenderer<T> renderer)
Constructor using the given renderer.
|
AutoCompleteTextField(String id,
IModel<T> model)
Constructor for the given model.
|
AutoCompleteTextField(String id,
IModel<T> model,
AutoCompleteSettings settings)
Constructor for given model.
|
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
AutoCompleteSettings settings)
Constructor for the given model and type.
|
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
IAutoCompleteRenderer<T> renderer,
AutoCompleteSettings settings)
Constructor for the given model using the given renderer.
|
AutoCompleteTextField(String id,
IModel<T> model,
IAutoCompleteRenderer<T> renderer)
Constructor for the given model using the given renderer.
|
Modifier and Type | Method and Description |
---|---|
IAutoCompleteRenderer<T> |
getChoiceRenderer() |
protected abstract Iterator<T> |
getChoices(String input)
Callback method that should return an iterator over all possible assist choice objects.
|
protected AutoCompleteBehavior<T> |
newAutoCompleteBehavior(IAutoCompleteRenderer<T> renderer,
AutoCompleteSettings settings)
Factory method for autocomplete behavior that will be added to this textfield
|
protected void |
onComponentTag(ComponentTag tag)
Processes the component tag.
|
protected void |
onInitialize()
Initializes the
AutoCompleteBehavior if it is not already there. |
protected void |
updateAjaxAttributes(AjaxRequestAttributes attributes) |
getInputTypes
convertInput, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull
add, add, checkRequired, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder
getLabel
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession
add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, 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, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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
public AutoCompleteTextField(String id, Class<T> type)
id
- component idtype
- model objec typepublic AutoCompleteTextField(String id, IModel<T> model, Class<T> type, AutoCompleteSettings settings)
id
- component idmodel
- modeltype
- model object typesettings
- settings for autocompletepublic AutoCompleteTextField(String id, IModel<T> model, AutoCompleteSettings settings)
id
- component idmodel
- modelsettings
- settings for autocompletepublic AutoCompleteTextField(String id, IModel<T> model)
id
- component idmodel
- modelpublic AutoCompleteTextField(String id, AutoCompleteSettings settings)
id
- component idsettings
- settings for autocompletepublic AutoCompleteTextField(String id)
id
- component idpublic AutoCompleteTextField(String id, IAutoCompleteRenderer<T> renderer)
id
- component idrenderer
- renderer for autocompletepublic AutoCompleteTextField(String id, Class<T> type, IAutoCompleteRenderer<T> renderer)
id
- component idtype
- model object typerenderer
- renderer for autocompletepublic AutoCompleteTextField(String id, IModel<T> model, IAutoCompleteRenderer<T> renderer)
id
- component idmodel
- modelrenderer
- renderer for autocompletepublic AutoCompleteTextField(String id, IModel<T> model, Class<T> type, IAutoCompleteRenderer<T> renderer, AutoCompleteSettings settings)
id
- component idmodel
- modeltype
- model object typerenderer
- renderer for autocompletesettings
- settings for autocompleteprotected AutoCompleteBehavior<T> newAutoCompleteBehavior(IAutoCompleteRenderer<T> renderer, AutoCompleteSettings settings)
renderer
- auto complete renderersettings
- auto complete settingsprotected void updateAjaxAttributes(AjaxRequestAttributes attributes)
protected void onInitialize()
AutoCompleteBehavior
if it is not already there.onInitialize
in class MarkupContainer
protected void onComponentTag(ComponentTag tag)
TextField
onComponentTag
in class TextField<T>
tag
- Tag to modifyComponent.onComponentTag(ComponentTag)
protected abstract Iterator<T> getChoices(String input)
input
- current inputAutoCompleteBehavior.getChoices(String)
public final IAutoCompleteRenderer<T> getChoiceRenderer()
IAutoCompleteRenderer
used to generate html output for the
AutoCompleteBehavior
.Copyright © 2006–2021 Apache Software Foundation. All rights reserved.