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, IClusterable, IConverterLocator, IRequestListener, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IOnChangeListener

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

FormComponent.AbstractVisitor, FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

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

NO_SELECTION_VALUE

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_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Fields inherited from interface org.apache.wicket.markup.html.form.IOnChangeListener

INTERFACE

Constructor Summary

ListChoice(String id)

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, 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)

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

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, List<? extends T> choices, int maxRows)

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

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

Method Summary

protected static int	getDefaultMaxRows() Gets the default maximum number of rows to display.
int	getMaxRows() Gets the maximum number of rows to display.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected static void	setDefaultMaxRows(int defaultMaxRows) Sets the default maximum number of rows to display.
ListChoice<T>	setMaxRows(int maxRows) Sets the maximum number of rows to display.
protected boolean	supportsPersistence()

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

getStatelessHint, onSelectionChanged, onSelectionChanged, wantOnSelectionChangedNotifications

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

convertChoiceIdToChoice, convertValue, getDefaultChoice, getModelValue, getNoSelectionValue, getNullKey, getNullValidKey, isNullValid, isSelected, setNullValid

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

appendOptionHtml, detachModel, escapeOptionHtml, getChoiceRenderer, getChoices, isDisabled, localizeDisplayValues, onComponentTagBody, setChoiceRenderer, setChoices, setChoices

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

add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

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

getLabel, setLabelInternal

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ListChoice

public ListChoice(String id)

See Also:

AbstractChoice.AbstractChoice(String)

ListChoice

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

See Also:

AbstractChoice.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.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.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.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.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.DropDownChoice(String, IModel, List)

ListChoice

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

See Also:

AbstractChoice.AbstractChoice(String, IModel)

ListChoice

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

See Also:

AbstractChoice.AbstractChoice(String, IModel,IModel)

ListChoice

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

See Also:

AbstractChoice.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.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.AbstractChoice(String, IModel, IModel,IChoiceRenderer)

Method Detail

getDefaultMaxRows

protected static int getDefaultMaxRows()

Gets the default maximum number of rows to display.

Returns:

Returns the defaultMaxRows.

setDefaultMaxRows

protected static void setDefaultMaxRows(int defaultMaxRows)

Sets the default maximum number of rows to display.

Parameters:

defaultMaxRows - The defaultMaxRows to set.

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)

supportsPersistence

protected final boolean supportsPersistence()

Overrides:

supportsPersistence in class AbstractChoice<T,T>

Returns:

True if this type of FormComponent can be persisted.

See Also:

FormComponent.supportsPersistence()