Module org.apache.wicket.core

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

Class ListChoice<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.AbstractChoice<T,T>

org.apache.wicket.markup.html.form.AbstractSingleSelectChoice<T>

org.apache.wicket.markup.html.form.DropDownChoice<T>

org.apache.wicket.markup.html.form.ListChoice<T>

Type Parameters:

T - The model object type

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 ListChoice<T>
extends DropDownChoice<T>

Essentially a drop down choice that doesn't drop down. Instead, it scrolls and displays a given number of rows.

Author:

Jonathan Locke, Johan Compagner, Eelco Hillenius

See Also:

• Serialized Form

Nested Class Summary

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

AbstractChoice.LabelPosition

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
ListChoice(String id)
ListChoice(String id, List<? extends T> choices)
ListChoice(String id, List<? extends T> choices, IChoiceRenderer<? super T> renderer)
ListChoice(String id, IModel<? extends List<? extends T>> choices)
ListChoice(String id, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer)
ListChoice(String id, IModel<T> model, List<? extends T> choices)
ListChoice(String id, IModel<T> model, List<? extends T> choices, int maxRows)
ListChoice(String id, IModel<T> model, List<? extends T> choices, IChoiceRenderer<? super T> renderer)
ListChoice(String id, IModel<T> model, List<? extends T> choices, IChoiceRenderer<? super T> renderer, int maxRows)
ListChoice(String id, IModel<T> model, IModel<? extends List<? extends T>> choices)
ListChoice(String id, IModel<T> model, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer)
ListChoice(String id, IModel<T> model, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer, int maxRows)

Method Summary

Modifier and Type	Method	Description
final int	getMaxRows()	Gets the maximum number of rows to display.
protected void	onComponentTag(ComponentTag tag)	Processes the component tag.
final ListChoice<T>	setMaxRows(int maxRows)	Sets the maximum number of rows to display.

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

convertChoiceIdToChoice, convertValue, getDefaultChoice, getModelValue, getNullKey, getNullKeyDisplayValue, getNullValidDisplayValue, getNullValidKey, isNullValid, isSelected, setNullValid

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

appendOptionHtml, detachModel, escapeOptionHtml, getChoiceRenderer, getChoices, getChoicesModel, isDisabled, localizeDisplayValues, onComponentTagBody, onDetach, setChoiceRenderer, setChoices, setChoices, setOptionAttributes, setType

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

add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onBeforeRender, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, 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, 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, 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, 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.IGenericComponent

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ListChoice

public ListChoice(String id)

See Also:

• AbstractChoice(String)

ListChoice

public ListChoice(String id,
 List<? extends T> choices)

See Also:

• AbstractChoice(String, List)

ListChoice

public ListChoice(String id,
 List<? extends T> choices,
 IChoiceRenderer<? super T> renderer)

Parameters:

id - See Component

choices - The list of values in the list

renderer - See AbstractChoice

See Also:

• AbstractChoice(String, List,IChoiceRenderer)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 List<? extends T> choices)

Parameters:

id - See Component

model - See Component

choices - The list of values in the list

See Also:

• DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 List<? extends T> choices,
 int maxRows)

Parameters:

id - See Component

model - See Component

choices - The list of values in the list

maxRows - Maximum number of rows to show

See Also:

• DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 List<? extends T> choices,
 IChoiceRenderer<? super T> renderer)

Parameters:

id - See Component

model - See Component

choices - The list of values in the list

renderer - See AbstractChoice

See Also:

• DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 List<? extends T> choices,
 IChoiceRenderer<? super T> renderer,
 int maxRows)

Parameters:

id - See Component

model - See Component

choices - The list of values in the list

renderer - See AbstractChoice

maxRows - Maximum number of rows to show

See Also:

• DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(String id,
 IModel<? extends List<? extends T>> choices)

See Also:

• AbstractChoice(String, IModel)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 IModel<? extends List<? extends T>> choices)

See Also:

• AbstractChoice(String, IModel,IModel)

ListChoice

public ListChoice(String id,
 IModel<? extends List<? extends T>> choices,
 IChoiceRenderer<? super T> renderer)

See Also:

• AbstractChoice(String, IModel,IChoiceRenderer)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 IModel<? extends List<? extends T>> choices,
 IChoiceRenderer<? super T> renderer)

See Also:

• AbstractChoice(String, IModel, IModel,IChoiceRenderer)

ListChoice

public ListChoice(String id,
 IModel<T> model,
 IModel<? extends List<? extends T>> choices,
 IChoiceRenderer<? super T> renderer,
 int maxRows)

Parameters:

id -

model -

choices -

renderer -

maxRows -

See Also:

• AbstractChoice(String, IModel, IModel,IChoiceRenderer)

Method Details

getMaxRows

public final int getMaxRows()

Gets the maximum number of rows to display.

Returns:

the maximum number of rows to display

setMaxRows

public final ListChoice<T> setMaxRows(int maxRows)

Sets the maximum number of rows to display.

Parameters:

maxRows - the maximum number of rows to display

Returns:

This

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: DropDownChoice

Processes the component tag.

Overrides:

onComponentTag in class DropDownChoice<T>

Parameters:

tag - Tag to modify

See Also:

• Component.onComponentTag(ComponentTag)