org.wicketstuff.objectautocomplete

Class ObjectAutoCompleteField<O,I extends Serializable>

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<I>

org.wicketstuff.objectautocomplete.ObjectAutoCompleteField<O,I>

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<I>, 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>, org.apache.wicket.util.io.IClusterable

public class ObjectAutoCompleteField<O,I extends Serializable>
extends org.apache.wicket.markup.html.form.FormComponentPanel<I>

Wicket component for selecting a single object of type T with an identifier of type I via autocompletion. The textfield used for autocompletion is nothing more than a search field where the autocomplete menu presents the search results. Selecting an entry of the search results (either via keyboard or mouse click) "picks" an entity, whose id is stored in the model of this component (So, the model object type of this model is I). A subclass must provide the list of T-objects, which are presented in the autocompletion menu.

Since:

May 21, 2008

Author:

roland

See Also:

Serialized Form

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_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Method Summary

Methods

Modifier and Type	Method and Description
protected void	convertInput() Called when form is submitted.
org.apache.wicket.markup.html.form.TextField<String>	getSearchTextField() Access to internal text field which can be used for adding some decorations or behaviours (like JS-Handler or specific CSS).
protected org.apache.wicket.model.IModel<I>	initModel()
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag pTag)
void	registerForUpdateOnSelectionChange(ObjectAutoCompleteSelectionChangeListener<I> pListener) Register a listener that needs to be updated when the selection changes, i.e.
void	searchCanceled(org.apache.wicket.ajax.AjaxRequestTarget pTarget, boolean pForceRestore) Callback called in case the user cancels a search via 'escape'

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

checkRequired, newMarkupSourcingStrategy

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, 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

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

getLabel

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, 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, 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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, 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, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Method Detail

registerForUpdateOnSelectionChange

public void registerForUpdateOnSelectionChange(ObjectAutoCompleteSelectionChangeListener<I> pListener)

Register a listener that needs to be updated when the selection changes, i.e. the user selected an object from the suggestion list. The listener is called with the id-model and the ajax request target which can be used for updating one self

Parameters:

pListener - the listener to notify

initModel

protected org.apache.wicket.model.IModel<I> initModel()

Overrides:

initModel in class org.apache.wicket.Component

searchCanceled

public void searchCanceled(org.apache.wicket.ajax.AjaxRequestTarget pTarget,
                  boolean pForceRestore)

Callback called in case the user cancels a search via 'escape'

Parameters:

pTarget - target to which the components to update are added

pForceRestore - if the old content should be always restored or whether an empty input clears the field

convertInput

protected void convertInput()

Called when form is submitted. We are simply store the object remembered internally.

Overrides:

convertInput in class org.apache.wicket.markup.html.form.FormComponent<I extends Serializable>

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag pTag)

Overrides:

onComponentTag in class org.apache.wicket.markup.html.form.FormComponentPanel<I extends Serializable>

getSearchTextField

public org.apache.wicket.markup.html.form.TextField<String> getSearchTextField()

Access to internal text field which can be used for adding some decorations or behaviours (like JS-Handler or specific CSS). Please be conservative in what you are doing, i.e. do not modify its model. Note: This method might vanish until the first release, it's probably better to provide delegation methods.

Returns:

textfield textfield holding the search input