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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  org.apache.wicket.markup.html.panel.Panel
                      org.apache.wicket.markup.html.navigation.paging.PagingNavigator

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IHeaderPartContainerProvider

Direct Known Subclasses:

AjaxPagingNavigator

public class PagingNavigator
extends Panel

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).

Enabled contract: The enabled contract (if the PagingNavigator is disabled so are all links inside) is enforced by links generated by newPagingNavigationIncrementLink(String, IPageable, int) and newPagingNavigationLink(String, IPageable, int). If these methods are overridden to return custom Link implementations it is up to that link to enforce the contract.

Author:

Juergen Donnerstag

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

PagingNavigator(java.lang.String id, IPageable pageable)
Constructor.

PagingNavigator(java.lang.String id, IPageable pageable, IPagingLabelProvider labelProvider)
Constructor.

Method Summary

IPageable	getPageable() IPageable this navigator is linked with
PagingNavigation	getPagingNavigation() Gets the pageable navigation component for configuration purposes.
protected PagingNavigation	newNavigation(IPageable pageable, IPagingLabelProvider labelProvider) Create a new PagingNavigation.
protected Link	newPagingNavigationIncrementLink(java.lang.String id, IPageable pageable, int increment) Create a new increment link.
protected Link	newPagingNavigationLink(java.lang.String id, IPageable pageable, int pageNumber) Create a new pagenumber link.
protected void	onBeforeRender() Called just before a component is rendered.

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

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, 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

PagingNavigator

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

Constructor.

Parameters:

id - See Component

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

PagingNavigator

public PagingNavigator(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

getPageable

public final IPageable getPageable()

IPageable this navigator is linked with

Returns:

IPageable instance

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

NOTE* If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class Component

See Also:

Component.callOnBeforeRenderIfNotVisible()

newPagingNavigationIncrementLink

protected Link 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.

Parameters:

id - the link id

pageable - the pageable to control

increment - the increment

Returns:

the increment link

newPagingNavigationLink

protected Link 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.

Parameters:

id - the link id

pageable - the pageable to control

pageNumber - the page to jump to

Returns:

the pagenumber link

newNavigation

protected PagingNavigation newNavigation(IPageable pageable,
                                         IPagingLabelProvider labelProvider)

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

Parameters:

pageable - the pageable component

labelProvider - The label provider for the link text.

Returns:

the navigation object

getPagingNavigation

public final PagingNavigation getPagingNavigation()

Gets the pageable navigation component for configuration purposes.

Returns:

the associated pageable navigation.