org.apache.wicket.markup.html.form
Class ListChoice

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
                      org.apache.wicket.markup.html.form.AbstractSingleSelectChoice
                          org.apache.wicket.markup.html.form.DropDownChoice
                              org.apache.wicket.markup.html.form.ListChoice

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IRequestListener, IFormVisitorParticipant, ILabelProvider, IOnChangeListener

public class ListChoice
extends DropDownChoice

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

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

INTERFACE

Constructor Summary

ListChoice(java.lang.String id)

ListChoice(java.lang.String id, IModel choices)

ListChoice(java.lang.String id, IModel choices, IChoiceRenderer renderer)

ListChoice(java.lang.String id, IModel model, IModel choices)

ListChoice(java.lang.String id, IModel model, IModel choices, IChoiceRenderer renderer)

ListChoice(java.lang.String id, IModel model, IModel choices, IChoiceRenderer renderer, int maxRows)

ListChoice(java.lang.String id, IModel model, java.util.List choices)

ListChoice(java.lang.String id, IModel model, java.util.List choices, IChoiceRenderer renderer)

ListChoice(java.lang.String id, IModel model, java.util.List choices, IChoiceRenderer renderer, int maxRows)

ListChoice(java.lang.String id, IModel model, java.util.List choices, int maxRows)

ListChoice(java.lang.String id, java.util.List choices)

ListChoice(java.lang.String id, java.util.List choices, IChoiceRenderer renderer)

Method Summary

protected void	appendOptionHtml(AppendingStringBuffer buffer, java.lang.Object choice, int index, java.lang.String selected) Generates and appends html for a single choice into the provided buffer
protected void	detachModel() Detaches the model for this component if it is detachable.
protected java.lang.CharSequence	escapeOptionHtml(java.lang.String displayValue) Method to override if you want special escaping of the options html.
IChoiceRenderer	getChoiceRenderer()
java.util.List	getChoices()
protected static int	getDefaultMaxRows() Gets the default maximum number of rows to display.
int	getMaxRows() Gets the maximum number of rows to display.
protected boolean	isDisabled(java.lang.Object object, int index, java.lang.String selected) Gets whether the given value is disabled.
protected boolean	localizeDisplayValues() Override this method if you want to localize the display values of the generated options.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
org.apache.wicket.markup.html.form.AbstractChoice	setChoiceRenderer(IChoiceRenderer renderer) Set the choice renderer to be used.
org.apache.wicket.markup.html.form.AbstractChoice	setChoices(IModel choices) Sets the list of choices
org.apache.wicket.markup.html.form.AbstractChoice	setChoices(java.util.List choices) Sets the list of choices.
protected static void	setDefaultMaxRows(int defaultMaxRows) Sets the default maximum number of rows to display.
ListChoice	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, isNullValid, isSelected, setNullValid

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

add, checkRequired, clearInput, convertInput, error, getBehaviors, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, updateModel, valid, validate, validateRequired, validateValidators, 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

Methods inherited from class org.apache.wicket.MarkupContainer

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

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, 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, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, 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(java.lang.String id)

See Also:

AbstractChoice.AbstractChoice(String)

ListChoice

public ListChoice(java.lang.String id,
                  java.util.List choices)

See Also:

AbstractChoice.AbstractChoice(String, List)

ListChoice

public ListChoice(java.lang.String id,
                  java.util.List choices,
                  IChoiceRenderer renderer)

Parameters:

id - See Component

choices - The collection of values in the list

renderer - See AbstractChoice

See Also:

AbstractChoice.AbstractChoice(String, List,IChoiceRenderer)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  java.util.List choices)

Parameters:

id - See Component

model - See Component

choices - The collection of values in the list

See Also:

DropDownChoice.DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  java.util.List choices,
                  int maxRows)

Parameters:

id - See Component

model - See Component

choices - The collection of values in the list

maxRows - Maximum number of rows to show

See Also:

DropDownChoice.DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  java.util.List choices,
                  IChoiceRenderer renderer)

Parameters:

id - See Component

model - See Component

choices - The collection of values in the list

renderer - See AbstractChoice

See Also:

DropDownChoice.DropDownChoice(String, IModel, List)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  java.util.List choices,
                  IChoiceRenderer renderer,
                  int maxRows)

Parameters:

id - See Component

model - See Component

choices - The collection 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(java.lang.String id,
                  IModel choices)

See Also:

AbstractChoice.AbstractChoice(String, IModel)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  IModel choices)

See Also:

AbstractChoice.AbstractChoice(String, IModel,IModel)

ListChoice

public ListChoice(java.lang.String id,
                  IModel choices,
                  IChoiceRenderer renderer)

See Also:

AbstractChoice.AbstractChoice(String, IModel,IChoiceRenderer)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  IModel choices,
                  IChoiceRenderer renderer)

See Also:

AbstractChoice.AbstractChoice(String, IModel, IModel,IChoiceRenderer)

ListChoice

public ListChoice(java.lang.String id,
                  IModel model,
                  IModel choices,
                  IChoiceRenderer renderer,
                  int 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 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

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(ComponentTag)

supportsPersistence

protected final boolean supportsPersistence()

Returns:

True if this type of FormComponent can be persisted.

See Also:

FormComponent.supportsPersistence()

getChoices

public java.util.List getChoices()

Returns:

The collection of object that this choice has

setChoices

public final org.apache.wicket.markup.html.form.AbstractChoice setChoices(IModel choices)

Sets the list of choices

Parameters:

choices - model representing the list of choices

Returns:

this for chaining

setChoices

public final org.apache.wicket.markup.html.form.AbstractChoice setChoices(java.util.List choices)

Sets the list of choices.

Parameters:

choices - the list of choices

Returns:

this for chaining

getChoiceRenderer

public final IChoiceRenderer getChoiceRenderer()

Returns:

The IChoiceRenderer used for rendering the data objects

setChoiceRenderer

public final org.apache.wicket.markup.html.form.AbstractChoice setChoiceRenderer(IChoiceRenderer renderer)

Set the choice renderer to be used.

Parameters:

renderer -

Returns:

this for chaining

detachModel

protected void detachModel()

Description copied from class: Component

Detaches the model for this component if it is detachable.

Overrides:

detachModel in class Component

See Also:

Component.detachModel()

isDisabled

protected boolean isDisabled(java.lang.Object object,
                             int index,
                             java.lang.String selected)

Gets whether the given value is disabled. This default implementation always returns false.

Parameters:

object - The object to check

index - The index in the choices collection this object is in.

selected - The currently selected string value

Returns:

Whether the given value represents the current selection

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag openTag)

Handle the container's body.

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

Component.onComponentTagBody(MarkupStream, ComponentTag)

appendOptionHtml

protected void appendOptionHtml(AppendingStringBuffer buffer,
                                java.lang.Object choice,
                                int index,
                                java.lang.String selected)

Generates and appends html for a single choice into the provided buffer

Parameters:

buffer - Appending string buffer that will have the generated html appended

choice - Choice object

index - The index of this option

selected - The currently selected string value

escapeOptionHtml

protected java.lang.CharSequence escapeOptionHtml(java.lang.String displayValue)

Method to override if you want special escaping of the options html.

Parameters:

displayValue -

Returns:

The escaped display value

localizeDisplayValues

protected boolean localizeDisplayValues()

Override this method if you want to localize the display values of the generated options. By default false is returned so that the display values of options are not tested if they have a i18n key.

Returns:

true If you want to localize the display values, default == false