Module org.apache.wicket.core

Package org.apache.wicket.request.component

Interface IRequestablePage

All Superinterfaces:

IClusterable, IManageablePage, IRequestableComponent, Serializable

All Known Implementing Classes:

AbstractErrorPage, AccessDeniedPage, BaseWicketTester.StartComponentInPage, BrowserInfoPage, DevUtilsPage, DummyHomePage, DummyPanelPage, ExceptionErrorPage, GenericWebPage, InspectorPage, InternalErrorPage, LiveSessionsPage, MockHomePage, Page, PageExpiredErrorPage, PageStorePage, PopupCloseLink.ClosePopupPage, RedirectPage, RequestsPage, SignInPage, SignOutPage, WebPage

public interface IRequestablePage
extends IRequestableComponent, IManageablePage

Base interface for pages. The purpose of this interface is to make certain parts of Wicket easier to mock and unit test.

Author:

Matej Knopp, Igor Vaynberg (ivaynberg)

Method Summary

Modifier and Type	Method	Description
PageParameters	getPageParameters()	Returns the PageParameters for the page.
int	getRenderCount()	Returns the number of times this page has been rendered.
boolean	isBookmarkable()	Bookmarkable page can be instantiated using a bookmarkable URL.
void	renderPage()	Renders the page
boolean	wasCreatedBookmarkable()	Returns whether the page instance was created by a bookmarkable URL.

Methods inherited from interface org.apache.wicket.page.IManageablePage

detach, getPageId, isPageStateless, setFreezePageId

Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent

canCallListenerAfterExpiry, detach, get, getBehaviorById, getBehaviorId, getId, getPage, getPageRelativePath

Method Details

renderPage

void renderPage()

Renders the page

isBookmarkable

boolean isBookmarkable()

Bookmarkable page can be instantiated using a bookmarkable URL.

Returns:

Returns true if the page is bookmarkable.

getRenderCount

int getRenderCount()

Returns the number of times this page has been rendered. The number will be appended to request listener links in order to prevent invoking listeners from staled page version.

For example, the same page might have been rendered in two separate tabs. Page render doesn't change page id, but it can modify component hierarchy. Request listeners on such page should only work in tab where the page was rendered most recently.

Returns:

render count

wasCreatedBookmarkable

boolean wasCreatedBookmarkable()

Returns whether the page instance was created by a bookmarkable URL. Non mounted pages have to be created using bookmarkable URL in order to have hybrid URLs later. Otherwise it would be a potential security risk.

Returns:

true if this page has been created by a bookmarkable URL, false otherwise.

getPageParameters

PageParameters getPageParameters()

Returns the PageParameters for the page. Each bookmarkable page instance should have PageParameters associated with it. The page parameters are initialized from URL when page is created and are updated on every page render request.

Returns:

page parameters or null