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

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.panel.Panel
                  extended by org.apache.wicket.markup.html.navigation.paging.PagingNavigator
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>
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).

Author:
Juergen Donnerstag
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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, 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(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 onBeforeRender()
          Called just before a component is rendered.
 
Methods inherited from class org.apache.wicket.markup.html.panel.Panel
newMarkupSourcingStrategy
 
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, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, 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, 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, getFeedbackMessage, 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, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, 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, 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.onBeforeRender()

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.

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.

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)
Create a new PagingNavigation. May be subclassed to make us of specialized PagingNavigation.

Parameters:
id - The id of the navigation component
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.


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.