com.premiumminds.webapp.wicket.repeaters

Class AjaxListSetView<T extends Serializable>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.premiumminds.webapp.wicket.repeaters.AjaxListSetView<T>

Type Parameters:

T - type of elements contained in the model's list

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, 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 abstract class AjaxListSetView<T extends Serializable>
extends org.apache.wicket.markup.html.WebMarkupContainer

An AjaxListSetView is a repeater that makes it easy to display/work with ListOrderedSets (collection with unique values, but with List order). This repeater is great when you have FormComponents for each row and want to change the list through AJAX, because only new elements of the list are created in the DOM, the rest is just reordered.

Example:

 <table>
   <tr wicket:id="rows" class="even">
     <td><span wicket:id="id">Test ID</span></td>
     ...
 

The related Java code:

 add(new AjaxListSetView<UserDetails>("rows", listModel, "tbody")
 {
                public void populateItem(final ListSetItem<UserDetails> item)
                {
                        item.add(new Label("id", new PropertyModel(item.getModel, "id")));
                }
 });
 

NOTE: AjaxListSetView creates a container between his items and the markups parent. In the example above, AjaxListSetView will insert the element tbody between table and tr.

Author:

acamilo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AjaxListSetView.AjaxListener FOR AjaxListSetView INTERNAL USE

Field Summary

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 and Description
AjaxListSetView(String id, org.apache.wicket.model.IModel<? extends org.apache.commons.collections4.set.ListOrderedSet<? extends T>> model, String bodyTag)

Method Summary

Modifier and Type	Method and Description
org.apache.wicket.markup.IMarkupFragment	getMarkup(org.apache.wicket.Component child)
protected ListSetItem<T>	newItem(org.apache.wicket.model.IModel<T> itemModel) Create a new ListSetItem for list item.
protected void	onBeforeRender()
protected void	onInitialize()
protected void	onPopulate() Callback to let the repeater know it should populate itself with its items.
protected void	onRender() Renders all child items in no specified order
protected abstract void	populateItem(ListSetItem<T> item) Populate a given item.
protected void	renderChild(org.apache.wicket.Component child) Render a single child.
protected Iterator<? extends org.apache.wicket.Component>	renderIterator() Returns an iterator for the collection of child components to be rendered.

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, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, 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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onComponentTag, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

AjaxListSetView

public AjaxListSetView(String id,
                       org.apache.wicket.model.IModel<? extends org.apache.commons.collections4.set.ListOrderedSet<? extends T>> model,
                       String bodyTag)

Parameters:

id - component id

model - model containing the listOrderedSet of

bodyTag - tag name for the container that will be created

See Also:

Component.Component(String, IModel)

Method Detail

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.MarkupContainer

renderIterator

protected Iterator<? extends org.apache.wicket.Component> renderIterator()

Returns an iterator for the collection of child components to be rendered. Users can override this to change order of rendered children.

Returns:

iterator over child components to be rendered

onPopulate

protected void onPopulate()

Callback to let the repeater know it should populate itself with its items.

newItem

protected ListSetItem<T> newItem(org.apache.wicket.model.IModel<T> itemModel)

Create a new ListSetItem for list item.

Parameters:

itemModel - object in the list that the item represents

Returns:

ListSetItem

populateItem

protected abstract void populateItem(ListSetItem<T> item)

Populate a given item.

be careful to add any components to the list item. So, don't do:

 add(new Label("foo", "bar"));
 

but:

 item.add(new Label("foo", "bar"));
 

Parameters:

item - The item to populate

onRender

protected final void onRender()

Renders all child items in no specified order

Overrides:

onRender in class org.apache.wicket.MarkupContainer

renderChild

protected void renderChild(org.apache.wicket.Component child)

Render a single child. This method can be overridden to modify how a single child component is rendered.

Parameters:

child - Child component to be rendered

onBeforeRender

protected void onBeforeRender()

Overrides:

onBeforeRender in class org.apache.wicket.Component

See Also:

Component.onBeforeRender()

getMarkup

public org.apache.wicket.markup.IMarkupFragment getMarkup(org.apache.wicket.Component child)

Overrides:

getMarkup in class org.apache.wicket.MarkupContainer

See Also:

MarkupContainer.getMarkup(org.apache.wicket.Component)