de.alpharogroup.wicket.components.form

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

de.alpharogroup.wicket.components.form.CheckChoicesListView<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

public class CheckChoicesListView<T>
extends ChoicesListView<T>

A list view that renders a list of checkboxes with appropriate labels based on an IChoiceRenderer. When used in combination with a CheckGroup, this a good alternative to Wicket's built-in CheckBoxMultipleChoice, because it gives you full control over the markup and is extensible.

Your markup must contain the following:

• <input type="checkbox" wicket:id="check" /> where you want the checkbox to appear.
• A component with wicket:id="label" where you want the display value to appear.

For example:

 <wicket:container wicket:id="group">
   <label wicket:id="choices">
     <input type="checkbox" wicket:id="check" />
     <wicket:container wicket:id="label">Label</wicket:container>
   </label>
 </wicket:container>
 
 add(new CheckGroup("group", selectedItemsModel)
     .add(new CheckChoicesListView("choices", choicesModel, renderer)));
 

You can also override populateItem() if you want to display additional data per checkbox choice, like a description paragraph. 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
CheckChoicesListView(String id, org.apache.wicket.model.IModel<List<T>> choices, org.apache.wicket.markup.html.form.IChoiceRenderer<T> renderer)

Method Summary

Modifier and Type	Method and Description
protected org.apache.wicket.markup.html.form.Check<T>	newCheck(String id, org.apache.wicket.model.IModel<T> model, int index)
protected org.apache.wicket.markup.html.basic.Label	newLabel(String id, String label)
protected void	populateItem(org.apache.wicket.markup.html.list.ListItem<T> it)

Methods inherited from class de.alpharogroup.wicket.components.form.ChoicesListView

getChoiceLabel, getChoiceRenderer, getChoiceValue

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

getList, getListItemModel, getModel, getModelObject, getReuseItems, getStartIndex, getViewSize, moveDownLink, moveUpLink, newItem, onBeginPopulateItem, onPopulate, 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

CheckChoicesListView

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

Method Detail

populateItem

protected void populateItem(org.apache.wicket.markup.html.list.ListItem<T> it)

Specified by:

populateItem in class org.apache.wicket.markup.html.list.ListView<T>

newCheck

protected org.apache.wicket.markup.html.form.Check<T> newCheck(String id,
                                                               org.apache.wicket.model.IModel<T> model,
                                                               int index)

newLabel

protected org.apache.wicket.markup.html.basic.Label newLabel(String id,
                                                             String label)