de.alpharogroup.wicket.components.form

Class ChoicesListView<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.repeater.AbstractRepeater

org.apache.wicket.markup.html.list.ListView<T>

de.alpharogroup.wicket.components.form.ChoicesListView<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

CheckChoicesListView, RadioChoicesListView

public abstract class ChoicesListView<T>
extends org.apache.wicket.markup.html.list.ListView<T>

A base ListView that provides conveniences for rendering its items using an IChoiceRenderer. This class is inspired from fiftyfive.wicket.core project. Some changes with the generic types was done.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
ChoicesListView(String id, org.apache.wicket.model.IModel<List<T>> choices, org.apache.wicket.markup.html.form.IChoiceRenderer<T> renderer) Construct a list view that will expose the specified IChoiceRenderer for rendering its list items.

Method Summary

Modifier and Type	Method and Description
protected String	getChoiceLabel(T choice) Convenience method exposed to subclasses for determining the display value of a given list item.
org.apache.wicket.markup.html.form.IChoiceRenderer<T>	getChoiceRenderer() Returns the IChoiceRenderer that was passed to the constructor.
protected String	getChoiceValue(T choice, int index) Convenience method exposed to subclasses for determining the unique ID of the given list item.

Methods inherited from class org.apache.wicket.markup.html.list.ListView

getList, getListItemModel, getModel, getModelObject, getReuseItems, getStartIndex, getViewSize, moveDownLink, moveUpLink, newItem, onBeginPopulateItem, onPopulate, populateItem, removeLink, renderChild, renderItem, renderIterator, setList, setModel, setModelObject, setReuseItems, setStartIndex, setViewSize

Methods inherited from class org.apache.wicket.markup.repeater.AbstractRepeater

getMarkup, onBeforeRender, onRender

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ChoicesListView

public ChoicesListView(String id,
                       org.apache.wicket.model.IModel<List<T>> choices,
                       org.apache.wicket.markup.html.form.IChoiceRenderer<T> renderer)

Construct a list view that will expose the specified IChoiceRenderer for rendering its list items.

Parameters:

id - the id

choices - the list of choices

renderer - the choice renderer

Method Detail

getChoiceRenderer

public org.apache.wicket.markup.html.form.IChoiceRenderer<T> getChoiceRenderer()

Returns the IChoiceRenderer that was passed to the constructor.

Returns:

the choice renderer

getChoiceLabel

protected String getChoiceLabel(T choice)

Convenience method exposed to subclasses for determining the display value of a given list item. This delegates to getDisplayValue() on the IChoiceRenderer. The display value will be coverted to a String if necessary using Wicket's IConverter system.

Parameters:

choice - The current value of the list that is being rendered.

Returns:

the choice label

getChoiceValue

protected String getChoiceValue(T choice,
                                int index)

Convenience method exposed to subclasses for determining the unique ID of the given list item. This delegates to getIdValue() on the IChoiceRenderer.

Parameters:

choice - The current value of the list that is being rendered.

index - The zero-indexed position of that value in the list.

Returns:

the choice value