Module wicket.bootstrap.extensions

Package de.agilecoders.wicket.extensions.markup.html.bootstrap.form.typeahead

Class Typeahead<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>

de.agilecoders.wicket.extensions.markup.html.bootstrap.form.typeahead.Typeahead<T>

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<T,FormComponent<T>>, IMetadataContext<Serializable,Component>, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class Typeahead<T>
extends TextField<T>

An integration with Twitter Typeahead plugin.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

AbstractTextComponent.ITextFormatProvider

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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
Typeahead(String markupId, Dataset config)	Constructor.
Typeahead(String markupId, IModel<T> model, Dataset config)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected TypeaheadBehavior<T>	createTypeaheadBehavior()
protected Iterable<T>	getChoices(String input)	Returns an iterable with all choices that match the provided input.
protected HeaderItem	newTypeaheadJsHeaderItem()
protected void	onComponentTag(ComponentTag tag)
Typeahead<T>	remote(boolean remote)	Disables/Enables the remote functionality for this component
void	renderHead(IHeaderResponse response)
Typeahead<T>	size(de.agilecoders.wicket.core.markup.html.bootstrap.form.InputBehavior.Size size)	sets the size of textfield
Typeahead<T>	size(de.agilecoders.wicket.core.markup.html.bootstrap.layout.col.SpanType size)	sets the size of textfield

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

getInputTypes

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

convertInput, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull

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

add, add, checkRequired, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isFormParticipant, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, 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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Typeahead

public Typeahead(String markupId,
 Dataset config)

Constructor.

Parameters:

markupId - The component's id

config - The typeahead configuration

Typeahead

public Typeahead(String markupId,
 IModel<T> model,
 Dataset config)

Constructor.

Parameters:

markupId - The component's id

model - The textfield value

config - The typeahead configuration

Method Details

size

public Typeahead<T> size(de.agilecoders.wicket.core.markup.html.bootstrap.layout.col.SpanType size)

sets the size of textfield

Parameters:

size - mandatory parameter

Returns:

this instance for chaining

size

public Typeahead<T> size(de.agilecoders.wicket.core.markup.html.bootstrap.form.InputBehavior.Size size)

sets the size of textfield

Parameters:

size - mandatory parameter

Returns:

this instance for chaining

remote

public Typeahead<T> remote(boolean remote)

Disables/Enables the remote functionality for this component

Parameters:

remote - a flag indicating whether the Typeahead uses remote data source

Returns:

this instance for chaining

createTypeaheadBehavior

protected TypeaheadBehavior<T> createTypeaheadBehavior()

getChoices

protected Iterable<T> getChoices(String input)

Returns an iterable with all choices that match the provided input.

Parameters:

input - The input to match against to.

Returns:

All matching choices.

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class TextField<T>

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component

newTypeaheadJsHeaderItem

protected HeaderItem newTypeaheadJsHeaderItem()