org.apache.wicket.markup.repeater
Class RefreshingView<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.repeater.RepeatingView
                      org.apache.wicket.markup.repeater.RefreshingView<T>

Type Parameters:

T - Model object type

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>

Direct Known Subclasses:

AbstractPageableView

public abstract class RefreshingView<T>
extends RepeatingView

An abstract repeater view that provides refreshing functionality to its subclasses. The view is refreshed every request, making it well suited for displaying dynamic data.

The view is populated by implementing getItemModels() and populateItem(Item) methods. RefreshingView builds the items that will be rendered by looping over the models retrieved from getItemModels() and calling the newItem(String, int, IModel) to generate the child item container followed by a call to populateItem(Item) to let the user populate the newly created item container with custom components.

The provided ModelIteratorAdapter can make implementing getItemModels() easier if you have an iterator over item objects.

Author:

Igor Vaynberg (ivaynberg)

See Also:

RepeatingView, ModelIteratorAdapter, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

RefreshingView(String id)
Constructor

RefreshingView(String id, IModel<?> model)
Constructor

Method Summary

protected void	addItems(Iterator<Item<T>> items) Add items to the view.
protected abstract Iterator<IModel<T>>	getItemModels() Returns an iterator over models for items that will be added to this view
IItemReuseStrategy	getItemReuseStrategy()
Iterator<Item<T>>	getItems()
protected Item<T>	newItem(String id, int index, IModel<T> model) Factory method for Item container.
protected IItemFactory<T>	newItemFactory() Create a new IItemFactory based upon the RefreshingView
protected void	onPopulate() Refresh the items in the view.
protected abstract void	populateItem(Item<T> item) Populate the given Item container.
RefreshingView<T>	setItemReuseStrategy(IItemReuseStrategy strategy) Sets the item reuse strategy.

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

newChildId, renderIterator

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

getMarkup, onBeforeRender, onRender, renderChild

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

getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupStream, getMarkupType, hasAssociatedMarkup, internalAdd, iterator, iterator, onComponentTagBody, onMarkupAttached, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponent, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RefreshingView

public RefreshingView(String id)

Constructor

Parameters:

id - component id

RefreshingView

public RefreshingView(String id,
                      IModel<?> model)

Constructor

Parameters:

id - component id

model - model

Method Detail

onPopulate

protected final void onPopulate()

Refresh the items in the view. Delegates the creation of items to the selected item reuse strategy

Overrides:

onPopulate in class RepeatingView

See Also:

AbstractRepeater.onPopulate()

newItemFactory

protected IItemFactory<T> newItemFactory()

Create a new IItemFactory based upon the RefreshingView

Returns:

An Item factory that delegates to the RefreshingView

getItemModels

protected abstract Iterator<IModel<T>> getItemModels()

Returns an iterator over models for items that will be added to this view

Returns:

an iterator over models for items that will be added to this view

populateItem

protected abstract void populateItem(Item<T> item)

Populate the given Item container.

be carefull to add any components to the item and not the view itself. So, don't do:

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

but:

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

Parameters:

item - The item to populate

newItem

protected Item<T> newItem(String id,
                          int index,
                          IModel<T> model)

Factory method for Item container. Item containers are simple MarkupContainer used to aggregate the user added components for a row inside the view.

Parameters:

id - component id for the new data item

index - the index of the new data item

model - the model for the new data item

Returns:

DataItem created DataItem

See Also:

Item

getItems

public Iterator<Item<T>> getItems()

Returns:

iterator over item instances that exist as children of this view

addItems

protected void addItems(Iterator<Item<T>> items)

Add items to the view. Prior to this all items were removed so every request this function starts from a clean slate.

Parameters:

items - item instances to be added to this view

getItemReuseStrategy

public IItemReuseStrategy getItemReuseStrategy()

Returns:

currently set item reuse strategy. Defaults to DefaultItemReuseStrategy if none was set.

See Also:

DefaultItemReuseStrategy

setItemReuseStrategy

public RefreshingView<T> setItemReuseStrategy(IItemReuseStrategy strategy)

Sets the item reuse strategy. This strategy controls the creation of Items.

Parameters:

strategy - item reuse strategy

Returns:

this for chaining

See Also:

IItemReuseStrategy