Module org.apache.wicket.core

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

Class PagingNavigationIncrementLink<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.PagingNavigationIncrementLink<T>

Type Parameters:

T - type of model object

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<T,Link<T>>, IMetadataContext<Serializable,Component>, IRequestListener, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

AjaxPagingNavigationIncrementLink

public class PagingNavigationIncrementLink<T>
extends Link<T>

An incremental link to a page of a PageableListView. Assuming your list view navigation looks like

 
         [first / << / <] 1 | 2 | 3 [> / >> /last]
 
 

and "<" meaning the previous and "<<" goto the "current page - 5", than it is this kind of incremental page links which can easily be created.

Author:

Juergen Donnerstag, Martijn Dashorst

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected IPageable	pageable	The PageableListView the page links are referring to.

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
PagingNavigationIncrementLink(String id, IPageable pageable, int increment)	Constructor.

Method Summary

Modifier and Type	Method	Description
long	getPageNumber()	Determines the next page number for the pageable component.
boolean	isFirst()
boolean	isLast()
boolean	linksTo(Page page)	Returns true if the page 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, renderHead, setAnchor, setAutoEnable, setPopupSettings, useJSEventBindingWhenNeeded

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, getMarkupTag, 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, 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.IGenericComponent

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

Methods inherited from interface org.apache.wicket.IRequestListener

rendersPage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

pageable

protected final IPageable pageable

The PageableListView the page links are referring to.

Constructor Detail

PagingNavigationIncrementLink

public PagingNavigationIncrementLink(String id,
                                     IPageable pageable,
                                     int increment)

Constructor.

Parameters:

id - See Component

pageable - The pageable component the page links are referring to

increment - increment by

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

Determines the next page number for the pageable component.

Returns:

the new page number

isFirst

public boolean isFirst()

Returns:

True if it is referring to the first page of the underlying PageableListView.

isLast

public boolean isLast()

Returns:

True if it is referring to the last page of the underlying PageableListView.

linksTo

public boolean linksTo(Page page)

Returns true if the page link links to the given page.

Overrides:

linksTo in class Link<T>

Parameters:

page - ignored

Returns:

True if this link links to the given page

See Also:

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