org.apache.wicket.markup.html.navigation.paging
Class PagingNavigationLink<T>

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.link.AbstractLink
                  org.apache.wicket.markup.html.link.Link<T>
                      org.apache.wicket.markup.html.navigation.paging.PagingNavigationLink<T>

Type Parameters:

T - type of model object

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IRequestListener, ILinkListener

Direct Known Subclasses:

AjaxPagingNavigationLink

public class PagingNavigationLink<T>
extends Link<T>

A link to a page of a PageableListView.

Author:

Jonathan Locke, Eelco Hillenius, Martijn Dashorst

See Also:

Serialized Form

Nested Class Summary

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

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

protected IPageable

pageable The pageable list view.

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_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Fields inherited from interface org.apache.wicket.markup.html.link.ILinkListener

INTERFACE

Constructor Summary

PagingNavigationLink(String id, IPageable pageable, int pageNumber)
Constructor.

Method Summary

protected int	cullPageNumber(int pageNumber) Allows the link to cull the page number to the valid range before it is retrieved from the link
int	getPageNumber() Get pageNumber.
boolean	isFirst()
boolean	isLast()
boolean	linksTo(Page page) Returns true if this PageableListView navigation link links to the given page.
void	onClick() Called when a link is clicked.

Methods inherited from class org.apache.wicket.markup.html.link.Link

appendAnchor, getAnchor, getAutoEnable, getModel, getModelObject, getOnClickScript, getOnClickScript, getPopupSettings, getStatelessHint, getURL, isEnabled, onComponentTag, onLinkClicked, setAnchor, setAutoEnable, setModel, setModelObject, setPopupSettings

Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink

disableLink, getAfterDisabledLink, getBeforeDisabledLink, isLinkEnabled, onBeforeRender, onComponentTagBody, setAfterDisabledLink, setBeforeDisabledLink

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

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

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, 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

Field Detail

pageable

protected final IPageable pageable

The pageable list view.

Constructor Detail

PagingNavigationLink

public PagingNavigationLink(String id,
                            IPageable pageable,
                            int pageNumber)

Constructor.

Parameters:

id - See Component

pageable - The pageable component for this page link

pageNumber - The page number in the PageableListView that this link links to. Negative pageNumbers are relative to the end of the list.

Method Detail

onClick

public void onClick()

Description copied from class: Link

Called when a link is clicked.

Specified by:

onClick in class Link<T>

See Also:

Link.onClick()

getPageNumber

public final int getPageNumber()

Get pageNumber.

Returns:

pageNumber.

cullPageNumber

protected int cullPageNumber(int pageNumber)

Allows the link to cull the page number to the valid range before it is retrieved from the link

Parameters:

pageNumber -

Returns:

culled page number

isFirst

public final boolean isFirst()

Returns:

True if this page is the first page of the containing PageableListView

isLast

public final boolean isLast()

Returns:

True if this page is the last page of the containing PageableListView

linksTo

public final boolean linksTo(Page page)

Returns true if this PageableListView navigation link links to the given page.

Overrides:

linksTo in class Link<T>

Parameters:

page - The page

Returns:

True if this link links to the given page

See Also:

PageLink.linksTo(org.apache.wicket.Page)