org.wicketstuff.select2

Class Select2Choice<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.markup.html.form.HiddenField<M>

org.wicketstuff.select2.Select2Choice<T>

Type Parameters:

T - type of choice object

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<T>, org.apache.wicket.IRequestListener, org.apache.wicket.IResourceListener, 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 Select2Choice<T>
extends org.apache.wicket.markup.html.form.HiddenField<M>

Single-select Select2 component. Should be attached to a <input type='hidden'/> element.

Author:

igor

See Also:

Serialized Form

Nested Class Summary

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

org.apache.wicket.markup.html.form.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_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Fields inherited from interface org.apache.wicket.IResourceListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
Select2Choice(String id) Constructor.
Select2Choice(String id, ChoiceProvider<T> provider) Constructor.
Select2Choice(String id, org.apache.wicket.model.IModel<T> model) Constructor.
Select2Choice(String id, org.apache.wicket.model.IModel<T> model, ChoiceProvider<T> provider) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<T>	convertIdsToChoices(List<String> ids) Convert IDS into choices.
void	convertInput()
protected T	convertValue(String[] value)
protected M	getCurrentValue()
protected String	getEscapedJsString(String key) Escapes single quotes in localized strings to be used as JavaScript strings enclosed in single quotes
protected String	getJquerySafeMarkupId() Gets the markup id that is safe to use in jQuery by escaping dots in the default Component.getMarkup()
ChoiceProvider<T>	getProvider()
Settings	getSettings()
protected boolean	getStatelessHint()
boolean	isAjax()
protected void	onConfigure()
protected void	onDetach()
void	onEvent(org.apache.wicket.event.IEvent<?> event)
protected void	onInitialize()
void	onResourceRequested()
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
protected void	renderInitializationScript(org.apache.wicket.markup.head.IHeaderResponse response, T choice) Renders script used to initialize the value of Select2 after it is created so it matches the current model object.
void	setProvider(ChoiceProvider<T> provider) Sets the choice provider

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

getInputTypes

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

onComponentTag

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

getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull

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

add, add, checkRequired, clearInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isRequired, isValid, newValidatable, newValidationError, 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, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

Constructor Detail

Select2Choice

public Select2Choice(String id)

Constructor.

Parameters:

id -

Select2Choice

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

Constructor.

Parameters:

id -

model -

Select2Choice

public Select2Choice(String id,
             org.apache.wicket.model.IModel<T> model,
             ChoiceProvider<T> provider)

Constructor.

Parameters:

id -

model -

provider -

Select2Choice

public Select2Choice(String id,
             ChoiceProvider<T> provider)

Constructor.

Parameters:

id -

provider -

Method Detail

convertValue

protected final T convertValue(String[] value)
                        throws org.apache.wicket.util.convert.ConversionException

Overrides:

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

Throws:

org.apache.wicket.util.convert.ConversionException

renderInitializationScript

protected void renderInitializationScript(org.apache.wicket.markup.head.IHeaderResponse response,
                              T choice)

Renders script used to initialize the value of Select2 after it is created so it matches the current model object.

Parameters:

response - header response

choice - value to display

getSettings

public final Settings getSettings()

Returns:

Select2 settings for this component

setProvider

public final void setProvider(ChoiceProvider<T> provider)

Sets the choice provider

Parameters:

provider - provider to set

getProvider

public final ChoiceProvider<T> getProvider()

Returns:

choice provider

convertInput

public final void convertInput()

Overrides:

convertInput in class org.apache.wicket.markup.html.form.AbstractTextComponent<M>

convertIdsToChoices

protected final Collection<T> convertIdsToChoices(List<String> ids)

Convert IDS into choices.

Parameters:

ids - list of identities

Returns:

collection of choices or empty collection

getJquerySafeMarkupId

protected String getJquerySafeMarkupId()

Gets the markup id that is safe to use in jQuery by escaping dots in the default Component.getMarkup()

Returns:

markup id

getEscapedJsString

protected String getEscapedJsString(String key)

Escapes single quotes in localized strings to be used as JavaScript strings enclosed in single quotes

Parameters:

key - resource key for localized message

Returns:

localized string with escaped single quotes

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

getCurrentValue

protected final M getCurrentValue()

Returns:

current value, suitable for rendering as selected value in select2 component

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.MarkupContainer

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class org.apache.wicket.Component

onEvent

public void onEvent(org.apache.wicket.event.IEvent<?> event)

Specified by:

onEvent in interface org.apache.wicket.event.IEventSink

Overrides:

onEvent in class org.apache.wicket.Component

getStatelessHint

protected boolean getStatelessHint()

Overrides:

getStatelessHint in class org.apache.wicket.Component

isAjax

public boolean isAjax()

onResourceRequested

public void onResourceRequested()

Specified by:

onResourceRequested in interface org.apache.wicket.IResourceListener

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.markup.html.form.FormComponent<M>