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, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<T,Link<T>>, IRequestListener, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected IPageable	pageable The pageable list view.

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, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor and Description
PagingNavigationLink(String id, IPageable pageable, long pageNumber) Constructor.

Method Summary

Modifier and Type	Method and Description
protected long	cullPageNumber(long pageNumber) Allows the link to cull the page number to the valid range before it is retrieved from the link
long	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, getOnClickScript, getPopupSettings, getStatelessHint, getURL, isEnabled, onComponentTag, onRequest, setAnchor, setAutoEnable, setPopupSettings

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

disableLink, getBody, onComponentTagBody, onDetach, setBody

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, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onInitialize, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, 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.IRequestListener

rendersPage

Methods inherited from interface org.apache.wicket.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

pageable

protected final IPageable pageable

The pageable list view.

Constructor Detail

PagingNavigationLink

public PagingNavigationLink(String id,
                            IPageable pageable,
                            long 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 long getPageNumber()

Get pageNumber.

Returns:

pageNumber.

cullPageNumber

protected long cullPageNumber(long 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:

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