Package org.apache.wicket.ajax.markup.html.navigation.paging

Class AjaxPagingNavigator

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.wicket.markup.html.navigation.paging.PagingNavigator

org.apache.wicket.ajax.markup.html.navigation.paging.AjaxPagingNavigator

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<java.io.Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class AjaxPagingNavigator
extends PagingNavigator

A Wicket panel component to draw and maintain a complete page navigator, meant to be easily added to any PageableListView. A navigation which contains links to the first and last page, the current page +- some increment and which supports paged navigation bars (@see PageableListViewNavigationWithMargin).

NOTE To use the AjaxPagingNavigator, you have to put your ListView in a WebMarkupContainer, otherwise it is not possible to update the contents of the listview using Ajax.

Since:

1.2

Author:

Martijn Dashorst

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

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
AjaxPagingNavigator(java.lang.String id, IPageable pageable)	Constructor.
AjaxPagingNavigator(java.lang.String id, IPageable pageable, IPagingLabelProvider labelProvider)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected PagingNavigation	newNavigation(java.lang.String id, IPageable pageable, IPagingLabelProvider labelProvider)	Create a new PagingNavigation.
protected AbstractLink	newPagingNavigationIncrementLink(java.lang.String id, IPageable pageable, int increment)	Create a new increment link.
protected AbstractLink	newPagingNavigationLink(java.lang.String id, IPageable pageable, int pageNumber)	Create a new pagenumber link.
protected void	onAjaxEvent(AjaxRequestTarget target)	Override this method to specify the markup container where your IPageable is part of.

Methods inherited from class org.apache.wicket.markup.html.navigation.paging.PagingNavigator

getPageable, getPagingNavigation, onInitialize

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, 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, 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, onAfterRender, onBeforeRender, 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 org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AjaxPagingNavigator

public AjaxPagingNavigator(java.lang.String id,
                           IPageable pageable)

Constructor.

Parameters:

id - See Component

pageable - The pageable component the page links are referring to.

AjaxPagingNavigator

public AjaxPagingNavigator(java.lang.String id,
                           IPageable pageable,
                           IPagingLabelProvider labelProvider)

Constructor.

Parameters:

id - See Component

pageable - The pageable component the page links are referring to.

labelProvider - The label provider for the link text.

Method Detail

newPagingNavigationIncrementLink

protected AbstractLink newPagingNavigationIncrementLink(java.lang.String id,
                                                        IPageable pageable,
                                                        int increment)

Create a new increment link. May be subclassed to make use of specialized links, e.g. Ajaxian links.

Overrides:

newPagingNavigationIncrementLink in class PagingNavigator

Parameters:

id - the link id

pageable - the pageable to control

increment - the increment

Returns:

the increment link

newPagingNavigationLink

protected AbstractLink newPagingNavigationLink(java.lang.String id,
                                               IPageable pageable,
                                               int pageNumber)

Create a new pagenumber link. May be subclassed to make use of specialized links, e.g. Ajaxian links.

Overrides:

newPagingNavigationLink in class PagingNavigator

Parameters:

id - the link id

pageable - the pageable to control

pageNumber - the page to jump to

Returns:

the pagenumber link

newNavigation

protected PagingNavigation newNavigation(java.lang.String id,
                                         IPageable pageable,
                                         IPagingLabelProvider labelProvider)

Description copied from class: PagingNavigator

Create a new PagingNavigation. May be subclassed to make us of specialized PagingNavigation.

Overrides:

newNavigation in class PagingNavigator

Parameters:

id - The id of the navigation component

pageable - the pageable component

labelProvider - The label provider for the link text.

Returns:

the navigation object

See Also:

PagingNavigator.newNavigation(java.lang.String, org.apache.wicket.markup.html.navigation.paging.IPageable, org.apache.wicket.markup.html.navigation.paging.IPagingLabelProvider)

onAjaxEvent

protected void onAjaxEvent(AjaxRequestTarget target)

Override this method to specify the markup container where your IPageable is part of. This default implementation tries to find a parent which is not an AbstractRepeater and outputs its markup id. This is necessary as ListViews can't be updated themselves.

Parameters:

target - the request target to add the components that need to be updated in the ajax event.

See Also:

Component#getOutputMarkupId(boolean)