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

Class AjaxPagingNavigationLink

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<Void>

org.apache.wicket.ajax.markup.html.navigation.paging.AjaxPagingNavigationLink

All Implemented Interfaces:

Serializable, Iterable<Component>, IAjaxLink, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<Void,Link<Void>>, IMetadataContext<Serializable,Component>, IRequestListener, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class AjaxPagingNavigationLink
extends PagingNavigationLink<Void>
implements IAjaxLink

An Ajax version of a link to a page of a PageableListView.

Since:

1.2

Author:

Martijn Dashorst

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.navigation.paging.PagingNavigationLink

pageable

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	Description
AjaxPagingNavigationLink(String id, IPageable pageable, long pageNumber)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected AjaxPagingNavigationBehavior	newAjaxPagingNavigationBehavior(IPageable pageable, String event)
void	onClick()	Fallback event listener, will redisplay the current page.
void	onClick(AjaxRequestTarget target)	Performs the actual action of this component, performing a non-ajax fallback when there was no AjaxRequestTarget available.
protected void	onComponentTag(ComponentTag tag)	Handles this link's tag.
protected void	onInitialize()	This method is meant to be used as an alternative to initialize components.
protected void	updateAjaxAttributes(AjaxRequestAttributes attributes)

Methods inherited from class org.apache.wicket.markup.html.navigation.paging.PagingNavigationLink

cullPageNumber, getPageNumber, isFirst, isLast, linksTo

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

appendAnchor, getAnchor, getAutoEnable, getOnClickScript, getPopupSettings, getStatelessHint, getURL, isEnabled, 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, 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

Constructor Details

AjaxPagingNavigationLink

public AjaxPagingNavigationLink(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 Details

onInitialize

protected void onInitialize()

Description copied from class: Component

This method is meant to be used as an alternative to initialize components. Usually the component's constructor is used for this task, but sometimes a component cannot be initialized in isolation, it may need to access its parent component or its markup in order to fully initialize. This method is invoked once per component's lifecycle when a path exists from this component to the Page thus providing the component with an atomic callback when the component's environment is built out.

Overrides must call super#Component.onInitialize(). Usually this should be the first thing an override does, much like a constructor.

Parent containers are guaranteed to be initialized before their children

It is safe to use Component.getPage() in this method

NOTE:The timing of this call is not precise, the contract is that it is called sometime before Component.onBeforeRender().

Overrides:

onInitialize in class MarkupContainer

newAjaxPagingNavigationBehavior

protected AjaxPagingNavigationBehavior newAjaxPagingNavigationBehavior(IPageable pageable,
 String event)

Parameters:

pageable - The pageable component the page links are referring to

event - the name of the default event on which this link will listen to

Returns:

the ajax behavior which will be executed when the user clicks the link

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

onClick

public void onClick()

Fallback event listener, will redisplay the current page.

Overrides:

onClick in class PagingNavigationLink<Void>

See Also:

• Link.onClick()

onClick

public void onClick(AjaxRequestTarget target)

Performs the actual action of this component, performing a non-ajax fallback when there was no AjaxRequestTarget available.

Specified by:

onClick in interface IAjaxLink

Parameters:

target - the request target, when null, a full page refresh will be generated

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Link

Handles this link's tag. OVERRIDES MUST CALL SUPER.

Overrides:

onComponentTag in class Link<Void>

Parameters:

tag - the component tag

See Also:

• Component.onComponentTag(ComponentTag)