Module org.apache.wicket.core

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

Class DropDownChoice<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>

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, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

ListChoice

public class DropDownChoice<T>
extends AbstractSingleSelectChoice<T>

A choice implemented as a dropdown menu/list.

Java:

 List SITES = Arrays.asList(new String[] { "The Server Side", "Java Lobby", "Java.Net" });
 
 // Add a dropdown choice component that uses Input's 'site' property to designate the
 // current selection, and that uses the SITES list for the available options.
 // Note that when the selection is null, Wicket will lookup a localized string to
 // represent this null with key: "id + '.null'". In this case, this is 'site.null'
 // which can be found in DropDownChoicePage.properties
 form.add(new DropDownChoice("site", SITES));
 

HTML:

        <select wicket:id="site">
                <option>site 1</option>
                <option>site 2</option>
        </select>
 

Author:

Jonathan Locke, Eelco Hillenius, Johan Compagner

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	onComponentTag(ComponentTag tag)	Processes the component tag.

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, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, 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, 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, onBeforeRender, 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 Detail

DropDownChoice

public DropDownChoice(String id)

Constructor.

Parameters:

id - See Component

DropDownChoice

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

Constructor.

Parameters:

id - See Component

choices - The collection of choices in the dropdown

DropDownChoice

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

Constructor.

Parameters:

id - See Component

renderer - The rendering engine

choices - The collection of choices in the dropdown

DropDownChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The collection of choices in the dropdown

DropDownChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The drop down choices

renderer - The rendering engine

DropDownChoice

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

Constructor.

Parameters:

id - See Component

choices - The collection of choices in the dropdown

DropDownChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The drop down choices

DropDownChoice

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

Constructor.

Parameters:

id - See Component

choices - The drop down choices

renderer - The rendering engine

DropDownChoice

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

Constructor.

Parameters:

id - See Component

model - See Component

choices - The drop down choices

renderer - The rendering engine

Method Detail

onComponentTag

protected void onComponentTag(ComponentTag tag)

Processes the component tag.

Overrides:

onComponentTag in class FormComponent<T>

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(org.apache.wicket.markup.ComponentTag)