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

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  extended by org.apache.wicket.markup.html.form.FormComponent<T>
                      extended by org.apache.wicket.markup.html.form.FormComponentPanel<T>
                          extended by org.odlabs.wiquery.ui.autocomplete.AbstractAutocompleteComponent<T>
Type Parameters:
T - The model object type
All Implemented Interfaces:
Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, 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.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>
Direct Known Subclasses:
AutocompleteAjaxComponent, AutocompleteComponent

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

$Id: AbstractAutocompleteComponent.java 1143 2011-07-29 11:51:49Z hielke.hoeve@gmail.com $

Base for the autocomplete component

Since:
1.1
Author:
Julien Roche
See Also:
Serialized Form

Field Summary
static WiQueryJavaScriptResourceReference 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_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER
 
Constructor Summary
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
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, newMarkupSourcingStrategy, onComponentTag
 
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, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateCollectionModel, 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
getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, 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, getFeedbackMessage, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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, 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 WiQueryJavaScriptResourceReference 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>

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:


Copyright © 2012. All Rights Reserved.