wicket
Class Page

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.Page

All Implemented Interfaces:

IFeedbackBoundary, IRedirectListener, IRequestListener, java.io.Serializable

Direct Known Subclasses:

WebPage

public abstract class Page

extends MarkupContainer

implements IRedirectListener, IFeedbackBoundary

Abstract base class for pages. As a MarkupContainer subclass, a Page can contain a component hierarchy and markup in some markup language such as HTML. Users of the framework should not attempt to subclass Page directly. Instead they should subclass a subclass of Page that is appropriate to the markup type they are using, such as WebPage (for HTML markup).

• Construction - When a page is constructed, it is automatically added to the current PageMap in the Session. When a Page is added to the Session's PageMap, the PageMap assigns the Page an id. A PageMap is roughly equivalent to a browser window and encapsulates a set of pages accessible through that window. When a popup window is created, a new PageMap is created for the popup.
• Identity - The Session that a Page is contained in can be retrieved by calling Page.getSession(). Page identifiers start at 0 for each PageMap in the Session and increment as new pages are added to the map. The PageMap-(and Session)-unique identifier assigned to a given Page can be retrieved by calling getId(). So, the first Page added to a new user Session will always be named "0".
• LifeCycle - Subclasses of Page which are interested in lifecycle events can override onBeginRequest, onEndRequest() and onModelChanged(). The onBeginRequest() method is inherited from Component. A call to onBeginRequest() is made for every Component on a Page before page rendering begins. At the end of a request (when rendering has completed) to a Page, the onEndRequest() method is called for every Component on the Page.
• Nested Component Hierarchy - The Page class is a subclass of MarkupContainer. All MarkupContainers can have "associated markup", which resides alongside the Java code by default. All MarkupContainers are also Component containers. Through nesting, of containers, a Page can contain any arbitrary tree of Components. For more details on MarkupContainers, see MarkupContainer.
• Bookmarkable Pages - Pages can be constructed with any constructor when they are being used in a Wicket session, but if you wish to link to a Page using a URL that is "bookmarkable" (which implies that the URL will not have any session information encoded in it, and that you can call this page directly without having a session first directly from your browser), you need to implement your Page with a no-arg constructor or with a constructor that accepts a PageParameters argument (which wraps any query string parameters for a request). In case the page has both constructors, the constructor with PageParameters will be used.
• Models - Pages, like other Components, can have models (see IModel). A Page can be assigned a model by passing one to the Page's constructor, by overriding initModel() or with an explicit invocation of setModel(). If the model is a CompoundPropertyModel, Components on the Page can use the Page's model implicitly via container inheritance. If a Component is not assigned a model, the initModel() override in Component will cause that Component to use the nearest CompoundModel in the parent chain, in this case, the Page's model. For basic CompoundModels, the name of the Component determines which property of the implicit page model the component is bound to. If more control is desired over the binding of Components to the page model (for example, if you want to specify some OGNL expression other than the component's name for retrieving the model object), BoundCompoundPropertyModel can be used.
• Back Button - Pages can support the back button by enabling versioning with a call to setVersioned(boolean). If a Page is versioned and changes occur to it which need to be tracked, a verison manager will be installed using the overridable factory method newVersionManager(). The default version manager returned by the base implementation of this method is an instance of UndoPageVersionManager, which manages versions of a page by keeping change records that can be reversed at a later time.
• Security - Pages can be secured by overriding checkAccess(). If checkAccess() returns ACCESS_ALLOWED (true), then onRender() will render the page. If it returns false (ACCESS_DENIED), then onRender() will not render the page. Besides returning true or false, an implementation of checkAccess() may also choose to send the user to another page with Component.setResponsePage() or Page.redirectToInterceptPage(). This can be used to allow a user to authenticate themselves if they were denied access.
• Clustering - The newPageState() method provides a convenient way for a Page to create a PageStaterecord that reconstitutes the Page when replicated in a cluster.

  Author:

  Jonathan Locke, Chris Turner, Eelco Hillenius, Johan Compagner

  See Also:

  WebPage, MarkupContainer, CompoundPropertyModel, BoundCompoundPropertyModel, Component, IPageVersionManager, UndoPageVersionManager, Serialized Form

  Nested Class Summary

  Nested classes inherited from class wicket.Component

  Component.ComponentModelChange, Component.IVisitor, Component.VisibilityChange

  Field Summary

  protected static boolean	ACCESS_ALLOWED Access allowed flag (value == true).
  protected static boolean	ACCESS_DENIED Access denied flag (value == false).

  Fields inherited from class wicket.Component

  FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4

  Constructor Summary

  protected	Page() Constructor.
  protected	Page(IModel model)

  Method Summary

  protected boolean	checkAccess() Whether access is allowed to this page.
  protected void	configureResponse() Set-up response with appropriate content type and locale.
  boolean	continueToOriginalDestination() Redirects to any intercept page previously specified by a call to redirectToInterceptPage.
  void	doRender() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  int	getAutoIndex() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  int	getCurrentVersionNumber()
  FeedbackMessages	getFeedbackMessages()
  PageMap	getPageMap()
  java.util.Iterator	getPageSets() THIS FEATURE IS CURRENTLY EXPERIMENTAL.
  Page	getVersion(int versionNumber) Override this method to implement a custom way of producing a version of a Page when it cannot be found in the Session.
  java.lang.String	hierarchyAsString()
  protected void	internalOnEndRequest() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalOnModelChanged() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  boolean	isDirty()
  boolean	isErrorPage() Override this method and return true if your page is used to display Wicket errors.
  PageState	newPageState()
  protected IPageVersionManager	newVersionManager()
  void	onRedirect() Redirect to this page.
  protected void	onRender() Renders this container to the given response object.
  void	redirectToInterceptPage(Page page) Redirects browser to an intermediate page such as a sign-in page.
  void	removePersistedFormData(java.lang.Class formClass, boolean disablePersistence) Convenience method.
  void	setDirty(boolean dirty)
  void	setPageMap(java.lang.String pageMapName) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  java.lang.String	toString() Get the string representation of this container.
  abstract java.lang.String	urlFor(Component component, java.lang.Class listenerInterface) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  abstract java.lang.String	urlFor(java.lang.String path) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  abstract java.lang.String	urlFor(java.lang.String pageMapName, java.lang.Class pageClass, PageParameters parameters) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.

  Methods inherited from class wicket.MarkupContainer

  add, autoAdd, contains, findMarkupStream, get, getMarkupStream, getMarkupType, internalAdd, internalBeginRequest, internalEndRequest, iterator, onComponentTagBody, remove, removeAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, visitChildren, visitChildren

  Methods inherited from class wicket.Component

  add, addStateChange, checkComponentTag, checkComponentTagAttribute, debug, detachModel, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getId, getLocale, getLocalizer, getModel, getModelObject, getModelObjectAsString, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResource, getResponse, getSession, getString, getString, getString, getStyle, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnBeginRequest, internalOnModelChanging, isAncestorOf, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onBeginRequest, onComponentTag, onEndRequest, onModelChanged, onModelChanging, onSessionAttach, redirectTo, remove, render, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, sameRootModel, sameRootModel, setFlag, setModelObject, setRedirect, setRenderBodyOnly, setResponsePage, setShouldEscapeModelStrings, setVersioned, setVisible, urlFor, visitParents, warn

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Field Detail

  ACCESS_ALLOWED

  protected static final boolean ACCESS_ALLOWED

  Access allowed flag (value == true).

  See Also:

  Constant Field Values

  ACCESS_DENIED

  protected static final boolean ACCESS_DENIED

  Access denied flag (value == false).

  See Also:

  Constant Field Values

  Constructor Detail

  Page

  protected Page()

  Constructor.

  Page

  protected Page(IModel model)

  Parameters:

  model - See Component

  See Also:

  Component.Component(String, IModel)

  Method Detail

  continueToOriginalDestination

  public final boolean continueToOriginalDestination()

  Redirects to any intercept page previously specified by a call to redirectToInterceptPage.

  Returns:

  True if an original destination was redirected to

  See Also:

  PageMap.redirectToInterceptPage(Page)

  getAutoIndex

  public final int getAutoIndex()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT. Get a page unique number, which will be increased with each call.

  Returns:

  A page unique number

  getCurrentVersionNumber

  public final int getCurrentVersionNumber()

  Returns:

  The current version number of this page. If the page has been changed once, the return value will be 1. If the page has not yet been revised, the version returned will be 0, indicating that the page is still in its original state.

  getFeedbackMessages

  public final FeedbackMessages getFeedbackMessages()

  Returns:

  Returns the feedbackMessages.

  getPageMap

  public final PageMap getPageMap()

  Returns:

  Returns the PageMap that this Page is stored in.

  getPageSets

  public final java.util.Iterator getPageSets()

  THIS FEATURE IS CURRENTLY EXPERIMENTAL. DO NOT USE THIS METHOD.

  Returns:

  The list of PageSets to which this Page belongs.

  getVersion

  public Page getVersion(int versionNumber)

  Override this method to implement a custom way of producing a version of a Page when it cannot be found in the Session.

  Parameters:

  versionNumber - The version desired

  Returns:

  A Page object with the component/model hierarchy that was attached to this page at the time represented by the requested version.

  hierarchyAsString

  public final java.lang.String hierarchyAsString()

  Returns:

  This page's component hierarchy as a string

  isDirty

  public final boolean isDirty()

  Returns:

  True if this Page is dirty and needs to be replicated

  isErrorPage

  public boolean isErrorPage()

  Override this method and return true if your page is used to display Wicket errors. This can help the framework prevent infinite failure loops.

  Returns:

  True if this page is intended to display an error to the end user.

  newPageState

  public PageState newPageState()

  Returns:

  Gets a PageState record for this page

  onRedirect

  public final void onRedirect()

  Redirect to this page.

  Specified by:

  onRedirect in interface IRedirectListener

  See Also:

  IRedirectListener.onRedirect()

  redirectToInterceptPage

  public final void redirectToInterceptPage(Page page)

  Redirects browser to an intermediate page such as a sign-in page. The current request's url is saved for future use by method continueToOriginalDestination(); Only use this method when you plan to continue to the current url at some later time; otherwise just use setResponsePage or - when you are in a constructor or checkAccessMethod, call redirectTo.

  Parameters:

  page - The sign in page

  removePersistedFormData

  public final void removePersistedFormData(java.lang.Class formClass,
                                            boolean disablePersistence)

  Convenience method. Search for children of type fromClass and invoke their respective removePersistedFormData() methods.

  Parameters:

  formClass - Form to be selected. Pages may have more than one Form.

  disablePersistence - if true, disable persistence for all FormComponents on that page. If false, it will remain unchanged.

  See Also:

  Form.removePersistentFormComponentValues(boolean)

  doRender

  public final void doRender()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  setDirty

  public final void setDirty(boolean dirty)

  Parameters:

  dirty - True to make this page dirty, false to make it clean.

  setPageMap

  public final void setPageMap(java.lang.String pageMapName)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Parameters:

  pageMapName - Sets this page into the page map with the given name. If the page map does not yet exist, it is automatically created.

  toString

  public java.lang.String toString()

  Get the string representation of this container.

  Overrides:

  toString in class MarkupContainer

  Returns:

  String representation of this container

  See Also:

  Component.toString()

  urlFor

  public abstract java.lang.String urlFor(Component component,
                                          java.lang.Class listenerInterface)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Gets a url that invokes the given listener interface on the given component. The listener interface can be any interface with a single method taking no arguments which has been registered with a call to RequestCycle.registerRequestListenerInterface(Class). The component must implement the given interface.

  Parameters:

  component - Component implementing listener interface

  listenerInterface - The listener interface to invoke when the URL is requested

  Returns:

  A URL that encodes an interface to call on a given component

  urlFor

  public abstract java.lang.String urlFor(java.lang.String path)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Parameters:

  path - The path

  Returns:

  The url for the path

  urlFor

  public abstract java.lang.String urlFor(java.lang.String pageMapName,
                                          java.lang.Class pageClass,
                                          PageParameters parameters)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Gets the url for the given page class using the given parameters.

  Parameters:

  pageMapName - Name of pagemap to use

  pageClass - Class of page

  parameters - Parameters to page

  Returns:

  Bookmarkable URL to page

  checkAccess

  protected boolean checkAccess()

  Whether access is allowed to this page.

  Returns:

  true if access is allowed, false otherwise

  configureResponse

  protected void configureResponse()

  Set-up response with appropriate content type and locale.

  internalOnEndRequest

  protected final void internalOnEndRequest()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE.

  Overrides:

  internalOnEndRequest in class Component

  See Also:

  Component.internalOnEndRequest()

  internalOnModelChanged

  protected final void internalOnModelChanged()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE.

  Overrides:

  internalOnModelChanged in class Component

  See Also:

  Component.internalOnModelChanged()

  newVersionManager

  protected IPageVersionManager newVersionManager()

  Returns:

  Factory method that creates a version manager for this Page

  onRender

  protected final void onRender()

  Renders this container to the given response object.

  Overrides:

  onRender in class MarkupContainer