org.apache.wicket.markup.html.form

Class AbstractChoice<T,E>

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

Type Parameters:

T - The model object type

E - class of a single element in the choices list

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<T>, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

AbstractSingleSelectChoice, ListMultipleChoice

public abstract class AbstractChoice<T,E>
extends FormComponent<T>

Abstract base class for all choice (html select) options.

This component uses String concatenation to keep its memory footprint light. Use Select, SelectOptions and SelectOption from wicket-extensions for more sophisticated needs.

Author:

Jonathan Locke, Eelco Hillenius, Johan Compagner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractChoice.LabelPosition An enumeration of possible positions of the label for a choice

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

Constructor Summary

Constructors

Constructor and Description
AbstractChoice(String id) Constructor.
AbstractChoice(String id, IModel<? extends List<? extends E>> choices) Constructor.
AbstractChoice(String id, IModel<? extends List<? extends E>> choices, IChoiceRenderer<? super E> renderer) Constructor.
AbstractChoice(String id, IModel<T> model, IModel<? extends List<? extends E>> choices) Constructor.
AbstractChoice(String id, IModel<T> model, IModel<? extends List<? extends E>> choices, IChoiceRenderer<? super E> renderer) Constructor.
AbstractChoice(String id, IModel<T> model, List<? extends E> choices) Constructor.
AbstractChoice(String id, IModel<T> model, List<? extends E> choices, IChoiceRenderer<? super E> renderer) Constructor.
AbstractChoice(String id, List<? extends E> choices) Constructor.
AbstractChoice(String id, List<? extends E> choices, IChoiceRenderer<? super E> renderer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendOptionHtml(AppendingStringBuffer buffer, E choice, int index, 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 CharSequence	escapeOptionHtml(String displayValue) Method to override if you want special escaping of the options html.
IChoiceRenderer<? super E>	getChoiceRenderer()
List<? extends E>	getChoices()
IModel<? extends List<? extends E>>	getChoicesModel()
protected CharSequence	getDefaultChoice(String selectedValue) Get a default choice to be rendered additionally to the choices available in the model.
protected boolean	isDisabled(E object, int index, String selected) Gets whether the given value is disabled.
protected abstract boolean	isSelected(E object, int index, String selected) Gets whether the given value represents the current selection.
protected boolean	localizeDisplayValues() Override this method if you want to localize the display values of the generated options.
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
AbstractChoice<T,E>	setChoiceRenderer(IChoiceRenderer<? super E> renderer) Set the choice renderer to be used.
AbstractChoice<T,E>	setChoices(IModel<? extends List<? extends E>> choices) Sets the list of choices
AbstractChoice<T,E>	setChoices(List<? extends E> choices) Sets the list of choices.
protected void	setOptionAttributes(AppendingStringBuffer buffer, E choice, int index, String selected) Sets the attributes of a single choice into the provided buffer.
FormComponent<T>	setType(Class<?> type) Sets the type that will be used when updating the model for this component.

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

add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onComponentTag, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, 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, onInitialize, 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, 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, getStatelessHint, 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, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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

AbstractChoice

public AbstractChoice(String id)

Constructor.

Parameters:

id - See Component

AbstractChoice

public AbstractChoice(String id,
              List<? extends E> choices)

Constructor.

Parameters:

id - See Component

choices - The collection of choices in the dropdown

AbstractChoice

public AbstractChoice(String id,
              List<? extends E> choices,
              IChoiceRenderer<? super E> renderer)

Constructor.

Parameters:

id - See Component

renderer - The rendering engine

choices - The collection of choices in the dropdown

AbstractChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The collection of choices in the dropdown

AbstractChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The drop down choices

renderer - The rendering engine

AbstractChoice

public AbstractChoice(String id,
              IModel<? extends List<? extends E>> choices)

Constructor.

Parameters:

id - See Component

choices - The collection of choices in the dropdown

AbstractChoice

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

Constructor.

Parameters:

id - See Component

renderer - The rendering engine

choices - The collection of choices in the dropdown

AbstractChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The collection of choices in the dropdown

AbstractChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

renderer - The rendering engine

choices - The drop down choices

Method Detail

getChoices

public List<? extends E> getChoices()

Returns:

The collection of object that this choice has

getChoicesModel

public IModel<? extends List<? extends E>> getChoicesModel()

Returns:

The model with the choices for this component

setChoices

public final AbstractChoice<T,E> setChoices(IModel<? extends List<? extends E>> choices)

Sets the list of choices

Parameters:

choices - model representing the list of choices

Returns:

this for chaining

setChoices

public final AbstractChoice<T,E> setChoices(List<? extends E> choices)

Sets the list of choices.

Parameters:

choices - the list of choices

Returns:

this for chaining

getChoiceRenderer

public final IChoiceRenderer<? super E> getChoiceRenderer()

Returns:

The IChoiceRenderer used for rendering the data objects

setChoiceRenderer

public final AbstractChoice<T,E> setChoiceRenderer(IChoiceRenderer<? super E> renderer)

Set the choice renderer to be used.

Parameters:

renderer - The IChoiceRenderer used for rendering the data objects

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

getDefaultChoice

protected CharSequence getDefaultChoice(String selectedValue)

Get a default choice to be rendered additionally to the choices available in the model.

Parameters:

selectedValue - The currently selected value

Returns:

Any default choice, such as "Choose One", depending on the subclass

See Also:

setChoices(IModel)

isSelected

protected abstract boolean isSelected(E object,
                 int index,
                 String selected)

Gets whether the given value represents the current selection.

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

isDisabled

protected boolean isDisabled(E object,
                 int index,
                 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

public 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

appendOptionHtml

protected void appendOptionHtml(AppendingStringBuffer buffer,
                    E choice,
                    int index,
                    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

setOptionAttributes

protected void setOptionAttributes(AppendingStringBuffer buffer,
                       E choice,
                       int index,
                       String selected)

Sets the attributes of 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 CharSequence escapeOptionHtml(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

setType

public final FormComponent<T> setType(Class<?> type)

Description copied from class: FormComponent

Sets the type that will be used when updating the model for this component. If no type is specified String type is assumed.

Overrides:

setType in class FormComponent<T>

Returns:

this for chaining