org.odlabs.wiquery.ui.autocomplete

Class AbstractAutocompleteComponent<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.FormComponentPanel<T>

org.odlabs.wiquery.ui.autocomplete.AbstractAutocompleteComponent<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, 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.IHeaderPartContainerProvider

Direct Known Subclasses:

AutocompleteAjaxComponent, AutocompleteComponent

public abstract class AbstractAutocompleteComponent<T>
extends org.apache.wicket.markup.html.form.FormComponentPanel<T>

$Id: AbstractAutocompleteComponent.java 930 2011-05-10 14:32:56Z hielke.hoeve@gmail.com $

Base for the autocomplete component

Since:

1.1

Author:

Julien Roche

See Also:

Serialized Form

Nested Class Summary

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

Modifier and Type	Field and Description
static org.apache.wicket.markup.html.resources.JavascriptResourceReference	WIQUERY_AUTOCOMPLETE_JS Constant of wiQuery Autocomplete resource

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_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
AbstractAutocompleteComponent(String id, org.apache.wicket.model.IModel<T> model) Constructor
AbstractAutocompleteComponent(String id, org.apache.wicket.model.IModel<T> model, org.apache.wicket.markup.html.form.IChoiceRenderer<? super T> renderer)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	convertInput()
Autocomplete<String>	getAutocompleteField()
org.apache.wicket.markup.html.form.HiddenField<String>	getAutocompleteHidden()
org.apache.wicket.markup.html.form.IChoiceRenderer<? super T>	getChoiceRenderer()
protected abstract List<? extends T>	getChoices()
abstract T	getValueOnSearchFail(String input) Method called when the input is not empty and the search failed
boolean	isAutoUpdate() Should this value get sent to the server when it is selected automatically
protected AutocompleteJson	newAutocompleteJson(int id, T obj) Create an AutocompleteJson
protected void	onBeforeRenderAutocomplete(Autocomplete<?> autocomplete) Call in the onBeforeRender of the autocomplete behavior
protected void	onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target) Called when the value has been updated via ajax
void	setAutoUpdate(boolean autoUpdate)
void	setChoiceRenderer(org.apache.wicket.markup.html.form.IChoiceRenderer<? super T> choiceRenderer)

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

checkRequired, newHeaderPartContainer, onComponentTag, onComponentTagBody, renderHead

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

add, add, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, supportsPersistence, trim, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, 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, getWebRequest

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, 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, getAjaxRegionMarkupId, 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, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, 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

Methods inherited from class java.lang.Object

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

Field Detail

WIQUERY_AUTOCOMPLETE_JS

public static final org.apache.wicket.markup.html.resources.JavascriptResourceReference WIQUERY_AUTOCOMPLETE_JS

Constant of wiQuery Autocomplete resource

Constructor Detail

AbstractAutocompleteComponent

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

Constructor

Parameters:

id - Wicket identifiant

model - Model of the default value

AbstractAutocompleteComponent

public AbstractAutocompleteComponent(String id,
                             org.apache.wicket.model.IModel<T> model,
                             org.apache.wicket.markup.html.form.IChoiceRenderer<? super T> renderer)

Method Detail

onUpdate

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

Called when the value has been updated via ajax

Parameters:

target -

convertInput

protected final void convertInput()

Overrides:

convertInput in class org.apache.wicket.markup.html.form.FormComponent<T>

See Also:

FormComponent.convertInput()

getChoices

protected abstract List<? extends T> getChoices()

getAutocompleteField

public Autocomplete<String> getAutocompleteField()

Returns:

the autocomplete field

getAutocompleteHidden

public org.apache.wicket.markup.html.form.HiddenField<String> getAutocompleteHidden()

Returns:

Hidden field storing the identifiant of the Wicket model

getValueOnSearchFail

public abstract T getValueOnSearchFail(String input)

Method called when the input is not empty and the search failed

Parameters:

input - Current input

Returns:

a new value

newAutocompleteJson

protected AutocompleteJson newAutocompleteJson(int id,
                                   T obj)

Create an AutocompleteJson

Parameters:

id -

obj -

Returns:

a new instance of AutocompleteJson

onBeforeRenderAutocomplete

protected void onBeforeRenderAutocomplete(Autocomplete<?> autocomplete)

Call in the onBeforeRender of the autocomplete behavior

Parameters:

autocomplete -

setChoiceRenderer

public void setChoiceRenderer(org.apache.wicket.markup.html.form.IChoiceRenderer<? super T> choiceRenderer)

getChoiceRenderer

public org.apache.wicket.markup.html.form.IChoiceRenderer<? super T> getChoiceRenderer()

setAutoUpdate

public void setAutoUpdate(boolean autoUpdate)

isAutoUpdate

public boolean isAutoUpdate()

Should this value get sent to the server when it is selected automatically

Returns: