org.apache.wicket.extensions.ajax.markup.html.autocomplete
Class AutoCompleteTextField<T>
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>
org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteTextField<T>
- Type Parameters:
T
- The model object type
- All Implemented Interfaces:
- Serializable, IClusterable, IConverterLocator, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>
- Direct Known Subclasses:
- DefaultCssAutocompleteTextField
public abstract class AutoCompleteTextField<T>
- extends TextField<T>
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
Fields inherited from class org.apache.wicket.Component |
ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER |
Constructor Summary |
AutoCompleteTextField(String id)
|
AutoCompleteTextField(String id,
AutoCompleteSettings settings)
Construct. |
AutoCompleteTextField(String id,
boolean preselect)
Deprecated. use the constructor AutoCompleteTextField
AutoCompleteTextField(String, AutoCompleteSettings) |
AutoCompleteTextField(String id,
Class<T> type)
|
AutoCompleteTextField(String id,
Class<T> type,
IAutoCompleteRenderer<T> renderer)
|
AutoCompleteTextField(String id,
IAutoCompleteRenderer<T> renderer)
|
AutoCompleteTextField(String id,
IModel<T> object)
|
AutoCompleteTextField(String id,
IModel<T> object,
AutoCompleteSettings settings)
Construct. |
AutoCompleteTextField(String id,
IModel<T> object,
boolean preselect)
Deprecated. use the constructor AutoCompleteTextField
AutoCompleteTextField(String, IModel, AutoCompleteSettings) |
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
AutoCompleteSettings settings)
Construct. |
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
boolean preselect)
Deprecated. use the constructor AutoCompleteTextField
AutoCompleteTextField(String, IModel, Class, AutoCompleteSettings) |
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
IAutoCompleteRenderer<T> renderer,
AutoCompleteSettings settings)
Construct. |
AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
IAutoCompleteRenderer<T> renderer,
boolean preselect)
Deprecated. use the constructor AutoCompleteTextField
AutoCompleteTextField(String, IModel, Class, IAutoCompleteRenderer, AutoCompleteSettings) |
AutoCompleteTextField(String id,
IModel<T> model,
IAutoCompleteRenderer<T> renderer)
|
Methods inherited from class org.apache.wicket.markup.html.form.FormComponent |
add, add, checkRequired, clearInput, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder |
Methods inherited from class org.apache.wicket.MarkupContainer |
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren |
Methods inherited from class org.apache.wicket.Component |
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap |
AutoCompleteTextField
public AutoCompleteTextField(String id,
Class<T> type)
- Parameters:
id
- type
-
AutoCompleteTextField
@Deprecated
public AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
boolean preselect)
- Deprecated. use the constructor
AutoCompleteTextField
AutoCompleteTextField(String, IModel, Class, AutoCompleteSettings)
- Parameters:
id
- model
- type
- preselect
- the first item
AutoCompleteTextField
public AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
AutoCompleteSettings settings)
- Construct.
- Parameters:
id
- model
- type
- settings
-
AutoCompleteTextField
@Deprecated
public AutoCompleteTextField(String id,
IModel<T> object,
boolean preselect)
- Deprecated. use the constructor
AutoCompleteTextField
AutoCompleteTextField(String, IModel, AutoCompleteSettings)
- Parameters:
id
- object
- preselect
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
IModel<T> object,
AutoCompleteSettings settings)
- Construct.
- Parameters:
id
- object
- settings
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
IModel<T> object)
- Parameters:
id
- object
-
AutoCompleteTextField
@Deprecated
public AutoCompleteTextField(String id,
boolean preselect)
- Deprecated. use the constructor
AutoCompleteTextField
AutoCompleteTextField(String, AutoCompleteSettings)
- Parameters:
id
- preselect
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
AutoCompleteSettings settings)
- Construct.
- Parameters:
id
- settings
-
AutoCompleteTextField
public AutoCompleteTextField(String id)
- Parameters:
id
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
IAutoCompleteRenderer<T> renderer)
- Parameters:
id
- renderer
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
Class<T> type,
IAutoCompleteRenderer<T> renderer)
- Parameters:
id
- type
- renderer
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
IModel<T> model,
IAutoCompleteRenderer<T> renderer)
- Parameters:
id
- model
- renderer
-
AutoCompleteTextField
@Deprecated
public AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
IAutoCompleteRenderer<T> renderer,
boolean preselect)
- Deprecated. use the constructor
AutoCompleteTextField
AutoCompleteTextField(String, IModel, Class, IAutoCompleteRenderer, AutoCompleteSettings)
- Parameters:
id
- model
- type
- renderer
- preselect
-
AutoCompleteTextField
public AutoCompleteTextField(String id,
IModel<T> model,
Class<T> type,
IAutoCompleteRenderer<T> renderer,
AutoCompleteSettings settings)
- Construct.
- Parameters:
id
- model
- type
- renderer
- settings
-
newAutoCompleteBehavior
protected AutoCompleteBehavior<T> newAutoCompleteBehavior(IAutoCompleteRenderer<T> renderer,
AutoCompleteSettings settings)
- Factory method for autocomplete behavior that will be added to this textfield
- Parameters:
renderer
- auto complete renderersettings
- auto complete settings
- Returns:
- auto complete behavior
onBeforeRender
protected void onBeforeRender()
- If the type is not set try to guess it if the model supports it.
- Overrides:
onBeforeRender
in class AbstractTextComponent<T>
- See Also:
Component.onBeforeRender()
onComponentTag
protected void onComponentTag(ComponentTag tag)
- Processes the component tag.
- Overrides:
onComponentTag
in class TextField<T>
- Parameters:
tag
- Tag to modify- See Also:
Component.onComponentTag(ComponentTag)
getChoices
protected abstract Iterator<T> getChoices(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)
Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.