org.wicketstuff.select2

Class AbstractSelect2Choice<T,M>

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

org.wicketstuff.select2.AbstractSelect2Choice<T,M>

Type Parameters:

T - type of choice object

M - type of model object

All Implemented Interfaces:

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

Direct Known Subclasses:

Select2Choice, Select2MultiChoice

public abstract class AbstractSelect2Choice<T,M>
extends FormComponent<M>
implements IRequestListener

Base class for Select2 components

Author:

igor

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

Constructor Summary

Constructors

Constructor and Description
AbstractSelect2Choice(String id)
AbstractSelect2Choice(String id, ChoiceProvider<T> provider) Constructor.
AbstractSelect2Choice(String id, IModel<M> model) Constructor
AbstractSelect2Choice(String id, IModel<M> model, ChoiceProvider<T> provider) Construct.

Method Summary

Modifier and Type	Method and Description
protected void	appendOptionHtml(AppendingStringBuffer buffer, T choice) Append a single option markup.
protected Collection<T>	convertIdsToChoices(List<String> ids) Convert IDS into choices.
void	convertInput()
protected abstract CharSequence	createOptionsHtml(M currentValue) Creates the HTML option(s) markup representing the current value.
static <T> void	generateJSON(ChoiceProvider<T> provider, OutputStream outputStream) Utility method to generate JSON response.
static <T> void	generateJSON(String queryParam, ChoiceProvider<T> provider, OutputStream outputStream) Utility method to generate JSON response.
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()
boolean	isInputNullable() Empty input is acceptable
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) this method will add default options
protected void	onConfigure()
protected void	onDetach()
void	onEvent(IEvent<?> event)
protected void	onInitialize()
void	onRequest()
void	setProvider(ChoiceProvider<T> provider) Sets the choice provider

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, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, 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

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, 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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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.IRequestListener

rendersPage

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 Detail

AbstractSelect2Choice

public AbstractSelect2Choice(String id)

Parameters:

id - markup id

AbstractSelect2Choice

public AbstractSelect2Choice(String id,
                             IModel<M> model)

Constructor

Parameters:

id - component id

model - component model

AbstractSelect2Choice

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

Constructor.

Parameters:

id - component id

provider - choice provider

AbstractSelect2Choice

public AbstractSelect2Choice(String id,
                             IModel<M> model,
                             ChoiceProvider<T> provider)

Construct.

Parameters:

id - markup id

model - model for select

provider - choice provider

Method Detail

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

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 MarkupContainer

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

onEvent

public void onEvent(IEvent<?> event)

Specified by:

onEvent in interface IEventSink

Overrides:

onEvent in class Component

getStatelessHint

protected boolean getStatelessHint()

Overrides:

getStatelessHint in class Component

isAjax

public boolean isAjax()

generateJSON

public static <T> void generateJSON(ChoiceProvider<T> provider,
                                    OutputStream outputStream)

Utility method to generate JSON response.

Parameters:

provider -

outputStream -

generateJSON

public static <T> void generateJSON(String queryParam,
                                    ChoiceProvider<T> provider,
                                    OutputStream outputStream)

Utility method to generate JSON response.

Parameters:

provider -

outputStream -

queryParam - - parameter to be used as Ajax query param

onRequest

public void onRequest()

Specified by:

onRequest in interface IRequestListener

onDetach

protected void onDetach()

Overrides:

onDetach in class FormComponent<M>

appendOptionHtml

protected void appendOptionHtml(AppendingStringBuffer buffer,
                                T choice)

Append a single option markup.

Parameters:

buffer - buffer to append to

choice - choice to create option markup for

onComponentTag

protected void onComponentTag(ComponentTag tag)

Processes the component tag.

Overrides:

onComponentTag in class FormComponent<M>

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(ComponentTag)

onComponentTagBody

public void onComponentTagBody(MarkupStream markupStream,
                               ComponentTag openTag)

this method will add default options

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

createOptionsHtml

protected abstract CharSequence createOptionsHtml(M currentValue)

Creates the HTML option(s) markup representing the current value.

Parameters:

currentValue - the current value

Returns:

the HTML markup for any option(s)

isInputNullable

public boolean isInputNullable()

Empty input is acceptable

Overrides:

isInputNullable in class FormComponent<M>