Package org.apache.wicket.extensions.markup.html.form.select

Class SelectOptions<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.repeater.AbstractRepeater

org.apache.wicket.markup.repeater.RepeatingView

org.apache.wicket.extensions.markup.html.form.select.SelectOptions<T>

Type Parameters:

T - type of elements contained in the model's collection

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class SelectOptions<T>
extends RepeatingView

Component that makes it easy to produce a list of SelectOption components.

Has to be attached to a <option> markup tag.

Note: The following pre Wicket 9 markup is deprecated and results in a log warning. Its support will be removed in Wicket 10:

 
 <wicket:container wicket:id="selectOptions"><option wicket:id="option"></option></wicket:container>
 
 

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Field Summary

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
SelectOptions(String id, Collection<? extends T> elements, IOptionRenderer<T> renderer)	Constructor
SelectOptions(String id, IModel<? extends Collection<? extends T>> model, IOptionRenderer<T> renderer)	Constructor

Method Summary

Modifier and Type	Method	Description
protected SelectOption<T>	newOption(String id, String text, IModel<T> model)	Factory method for creating a new SelectOption.
protected SelectOption<T>	newOption(String text, IModel<T> model)	Deprecated. override newOption(String, String, IModel) instead.
protected void	onDetach()	Called to allow a component to detach resources after use.
protected void	onPopulate()	Callback to let the repeater know it should populate itself with its items.
SelectOptions<T>	setRecreateChoices(boolean refresh)	Controls whether SelectOptions are recreated on each render.

Methods inherited from class org.apache.wicket.markup.repeater.RepeatingView

newChildId, renderIterator

Methods inherited from class org.apache.wicket.markup.repeater.AbstractRepeater

dequeue, getMarkup, onBeforeRender, onRender, renderChild

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, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, 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, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onComponentTag, onConfigure, onEvent, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

SelectOptions

public SelectOptions(String id,
                     IModel<? extends Collection<? extends T>> model,
                     IOptionRenderer<T> renderer)

Constructor

Parameters:

id -

model -

renderer -

SelectOptions

public SelectOptions(String id,
                     Collection<? extends T> elements,
                     IOptionRenderer<T> renderer)

Constructor

Parameters:

id -

elements -

renderer -

Method Detail

setRecreateChoices

public SelectOptions<T> setRecreateChoices(boolean refresh)

Controls whether SelectOptions are recreated on each render.

Note: When recreating on each render, newOption(String, IModel) should return SelectOptions with stable values, i.e. SelectOption.getValue() should return a value based on its model object instead of the default auto index. Otherwise the current selection will be lost on form errors.

Parameters:

refresh -

Returns:

this for chaining

See Also:

SelectOption.getValue()

onPopulate

protected final void onPopulate()

Callback to let the repeater know it should populate itself with its items.

Overrides:

onPopulate in class RepeatingView

See Also:

AbstractRepeater.onPopulate()

newOption

protected SelectOption<T> newOption(String text,
                                    IModel<T> model)

Deprecated.

override newOption(String, String, IModel) instead.

newOption

protected SelectOption<T> newOption(String id,
                                    String text,
                                    IModel<T> model)

Factory method for creating a new SelectOption. Override to add your own extensions, such as Ajax behaviors.

Parameters:

id - component id

text -

model -

Returns:

a SelectOption

onDetach

protected void onDetach()

Description copied from class: Component

Called to allow a component to detach resources after use. Overrides of this method MUST call the super implementation, the most logical place to do this is the last line of the override method.

Overrides:

onDetach in class MarkupContainer