AbstractSelect2Choice (Wicketstuff-Select2 Components 7.18.0 API)

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<M>
        
        org.wicketstuff.select2.AbstractSelect2Choice<T,M>

Type Parameters:
T - type of choice object
M - type of model 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<M>, 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

Direct Known Subclasses:

Select2Choice, Select2MultiChoice
```
public abstract class AbstractSelect2Choice<T,M>
extends org.apache.wicket.markup.html.form.AbstractTextComponent<M>
implements org.apache.wicket.IResourceListener
```
Base class for Select2 components

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
`AbstractSelect2Choice(String id)`
`AbstractSelect2Choice(String id, ChoiceProvider<T> provider)` Constructor.
`AbstractSelect2Choice(String id, org.apache.wicket.model.IModel<M> model)` Constructor
`AbstractSelect2Choice(String id, org.apache.wicket.model.IModel<M> model, ChoiceProvider<T> provider)` Construct.

Method Summary

Methods
Modifier and Type	Method and Description
`protected Collection<T>`	`convertIdsToChoices(List<String> ids)` Convert IDS into choices.
`void`	`convertInput()`
`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(org.apache.wicket.markup.ComponentTag tag)` Processes the component tag.
`void`	`onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)` this method will add default options
`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)`
`void`	`setProvider(ChoiceProvider<T> provider)` Sets the choice provider

Methods inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent
getConvertEmptyInputStringToNull, 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, getModel, getModelObject, 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, 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
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, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, 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, 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, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, 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
  - AbstractSelect2Choice
```
public AbstractSelect2Choice(String id)
```
    Parameters:
    id - markup id
  - AbstractSelect2Choice
```
public AbstractSelect2Choice(String id,
                     org.apache.wicket.model.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,
                     org.apache.wicket.model.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 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()
```
  - 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
  - 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>
  - onComponentTag
```
protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)
```
    Processes the component tag.
    
    Overrides:
    
    onComponentTag in class org.apache.wicket.markup.html.form.FormComponent<M>
    
    Parameters:
    tag - Tag to modify
    See Also:
    Component.onComponentTag(ComponentTag)
  - onComponentTagBody
```
public void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream,
                      org.apache.wicket.markup.ComponentTag openTag)
```
    this method will add default options
    
    Overrides:
    
    onComponentTagBody in class org.apache.wicket.MarkupContainer
    
    Parameters:
    markupStream - The markup stream
    openTag - The open tag for the body
  - isInputNullable
```
public boolean isInputNullable()
```
    Empty input is acceptable
    
    Overrides:
    
    isInputNullable in class org.apache.wicket.markup.html.form.AbstractTextComponent<M>

Class AbstractSelect2Choice<T,M>

Nested Class Summary

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

Field Summary

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

Fields inherited from class org.apache.wicket.Component

Fields inherited from interface org.apache.wicket.IResourceListener

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class org.apache.wicket.MarkupContainer

Methods inherited from class org.apache.wicket.Component

Methods inherited from class java.lang.Object

Constructor Detail

AbstractSelect2Choice

AbstractSelect2Choice

AbstractSelect2Choice

AbstractSelect2Choice

Method Detail

getSettings

setProvider

getProvider

convertInput

convertIdsToChoices

getJquerySafeMarkupId

getEscapedJsString

renderHead

getCurrentValue

onInitialize

onConfigure

onEvent

getStatelessHint

isAjax

generateJSON

generateJSON

onResourceRequested

onDetach

onComponentTag

onComponentTagBody

isInputNullable