org.apache.wicket.request.component
Interface IRequestablePage

All Superinterfaces:
IClusterable, IManageablePage, IRequestableComponent, java.io.Serializable
All Known Implementing Classes:
AbstractErrorPage, AccessDeniedPage, AdminAnnotationsBookmarkablePage, AdminAnnotationsInternalPage, AdminBookmarkablePage, AdminInternalPage, AdminPage, AjaxDataTablePage, AlternativePageFromWebContext, AnnotationsPanelsPage, AnnotPage, AuthenticatedWebPage, AuthenticatedWebPage, AutoCompletePage, BasePage, BasePage, BasePage, BasePage, BasePage, BasePage, BaseTreePage, BaseWicketTester.StartComponentInPage, BodyFrame, BookDetails, BookDetails, BookmarkablePage, BookmarkablePageLinkPage, BorderPage, BrowserInfoPage, ButtonPage, Captcha, CheckBoxMultipleChoicePage, CheckBoxPage, CheckBoxSelectorPage, CheckGroupPage, CheckGroupPage2, ChoicePage, ClockPage, ContactsDisplayPage, DataGridPage, DataTablePage, DatesPage, DecoupledAjaxUpdatePage, DevUtilsPage, DiskStoreBrowserPage, DropDownChoicePage, DummyHomePage, DummyPanelPage, DynamicPage, Echo, EditableLabelPage, EditableTreeTablePage, EditBook, EffectsPage, ExamplePage, ExceptionErrorPage, ExternalLinkPage, FileUploadPage, FormInput, FormPage, FormPage, FormPage, FragmentPage, GenericWebPage, GridViewPage, Guess, GuestBook, GuestBook, HangmanPage, HelloBrowser, HelloWorld, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, Home, HomePage, HomePage, HomePage, HomePage, HomePage, HomePage, HttpsPage, IncludePage, Index, Index, Index, Index, Index, Index, Index, Index, Index, Index, IndexPage, InspectorPage, InternalErrorPage, LabelPage, LazyLoadingPage, LeftFrame, LinkPage, LinksPage, ListChoicePage, ListMultipleChoicePage, LiveSessionsPage, LocalizedPage, Lose, MockHomePage, ModalContent1Page, ModalContent2Page, ModalWindowPage, MultiLineLabelPage, MultiUploadPage, MySignInPage, NonBookmarkablePage, OIRPage, OnChangeAjaxBehaviorPage, PackageMountedPage, Page, Page1, Page1, Page1, Page1, Page1, Page1, Page2, Page2, Page2, Page2, Page2, Page2, Page2QP, Page3, Page3, Page3, Page4, Page5, PageablesPage, PageExpiredErrorPage, PageFromWebContext, PageLinkPage, PageWithCustomLoading, PagingPage, PalettePage, PanelPage, PanelsPage, Popup, PopupCloseLink.ClosePopupPage, RadioChoicePage, RadioGroupPage, RadioGroupPage2, RatingsPage, RedirectPage, RefreshingPage, RepeatingPage, RequestMapperHomePage, RequestsPage, ResourceTestPage, SelectPage, SignIn, SignIn, SignIn2, SignInPage, SignOut, SignOut, SignOut, SignOut, SignOutPage, SimplePage, SimpleTreePage, SortingPage, SourcesPage, StatefulPage, StatelessPage, StatelessPage1, StatelessPage2, StatelessPage3, StockQuotePage, SubmitLinkPage, TabbedPanelPage, TabbedPanelPage, TemplatePage, TemplatePage, TextAreaPage, TextFieldPage, TodoList, TopFrame, TreeTablePage, UnicodeConverter, UploadPage, WebPage, WicketExamplePage, Win, WizardPage, WorldClockPage, XmlPage

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
 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.request.component.IRequestableComponent
canCallListenerInterface, detach, get, getBehaviorById, getBehaviorId, getId, getPage, getPageRelativePath
 
Methods inherited from interface org.apache.wicket.page.IManageablePage
detach, getPageId, isPageStateless, setFreezePageId
 

Method Detail

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 listener interface links in order to prevent invoking listeners from staled page version.

For example a same page might have been rendered in two separate tabs. Page render doesn't change page id but it can modify component hierarchy. Listener interface links 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


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.