org.apache.wicket.markup.html
Class WebPage
java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.Page
org.apache.wicket.markup.html.WebPage
- All Implemented Interfaces:
- Serializable, Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IRedirectListener, IRequestListener, IHeaderContributor, IManageablePage, IRequestableComponent, IRequestablePage, IHierarchical<Component>
- Direct Known Subclasses:
- AccessDeniedPage, BrowserInfoPage, DummyHomePage, DummyPanelPage, ExceptionErrorPage, InternalErrorPage, MockHomePage, PageExpiredErrorPage, PopupCloseLink.ClosePopupPage, RedirectPage
public class WebPage
- extends Page
Base class for HTML pages. This subclass of Page simply returns HTML when asked for its markup
type. It also has a method which subclasses can use to retrieve a bookmarkable link to the
application's home page.
WebPages 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.
- Author:
- Jonathan Locke, Eelco Hillenius, Juergen Donnerstag, Gwyn Evans
- See Also:
- Serialized Form
Fields inherited from class org.apache.wicket.Component |
ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PATH_SEPARATOR, RENDER |
Constructor Summary |
protected |
WebPage()
Constructor. |
protected |
WebPage(IModel<?> model)
|
protected |
WebPage(PageParameters parameters)
Constructor which receives wrapped query string parameters for a request. |
Methods inherited from class org.apache.wicket.Page |
afterCallComponent, beforeCallComponent, componentChanged, componentRendered, detachModels, dirty, dirty, endComponentRender, getAutoIndex, getId, getMarkup, getNumericId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, internalPrepareForRender, isBookmarkable, isErrorPage, isPageStateless, onBeforeRender, onDetach, onInitialize, onPageAttached, onRedirect, onRender, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, startComponentRender, toString, wasCreatedBookmarkable |
Methods inherited from class org.apache.wicket.MarkupContainer |
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, hasAssociatedMarkup, internalAdd, iterator, iterator, onComponentTagBody, onMarkupAttached, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, visitChildren, visitChildren |
Methods inherited from class org.apache.wicket.Component |
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap |
WebPage
protected WebPage()
- Constructor. Having this constructor public means that your page is 'bookmarkable' and hence
can be called/ created from anywhere.
WebPage
protected WebPage(IModel<?> model)
- See Also:
Page.Page(IModel)
WebPage
protected WebPage(PageParameters parameters)
- Constructor which receives wrapped query string parameters for a request. Having this
constructor public means that your page is 'bookmarkable' and hence can be called/ created
from anywhere. For bookmarkable pages (as opposed to when you construct page instances
yourself, this constructor will be used in preference to a no-arg constructor, if both exist.
Note that nothing is done with the page parameters argument. This constructor is provided so
that tools such as IDEs will include it their list of suggested constructors for derived
classes.
Please call this constructor (or the one with the pagemap) if you want to remember the
pageparameters
Page.getPageParameters()
. So that they are reused for stateless links.
- Parameters:
parameters
- Wrapped query string parameters.
getMarkupType
public MarkupType getMarkupType()
- Gets the markup type for a WebPage, which is "html" by default. Support for pages in another
markup language, such as VXML, would require the creation of a different Page subclass in an
appropriate package under org.apache.wicket.markup. To support VXML (voice markup), one might
create the package org.apache.wicket.markup.vxml and a subclass of Page called VoicePage.
- Overrides:
getMarkupType
in class Page
- Returns:
- Markup type for HTML
- See Also:
MarkupContainer.getMarkupType()
configureResponse
protected void configureResponse()
- Description copied from class:
Page
- Set-up response with appropriate content type, locale and encoding. The locale is set equal
to the session's locale. The content type header contains information about the markup type
(@see #getMarkupType()) and the encoding. The response (and request) encoding is determined
by an application setting (@see ApplicationSettings#getResponseRequestEncoding()). In
addition, if the page's markup contains a xml declaration like <?xml ... ?> an xml
declaration with proper encoding information is written to the output as well, provided it is
not disabled by an application setting (@see
ApplicationSettings#getStripXmlDeclarationFromOutput()).
Note: Prior to Wicket 1.1 the output encoding was determined by the page's markup encoding.
Because this caused uncertainties about the /request/ encoding, it has been changed in favor
of the new, much safer, approach. Please see the Wiki for more details.
- Overrides:
configureResponse
in class Page
- See Also:
Page.configureResponse()
setHeaders
protected void setHeaders(WebResponse response)
- Subclasses can override this to set there headers when the Page is being served. By default
these headers are set:
response.setHeader("Date", "[now]");
response.setHeader("Expires", "[0]");
response.setHeader("Pragma", "no-cache");
response.setHeader("Cache-Control", "no-cache");
So if a Page wants to control this or doesn't want to set this info it should override this
method and don't call super.
- Parameters:
response
- The WebResponse where set(Date)Header can be called on.
onAfterRender
protected void onAfterRender()
- Description copied from class:
Component
- Called just after a component is rendered.
- Overrides:
onAfterRender
in class Page
- See Also:
Component.onAfterRender()
homePageLink
protected final BookmarkablePageLink<Void> homePageLink(String id)
- Creates and returns a bookmarkable link to this application's home page.
- Parameters:
id
- Name of link
- Returns:
- Link to home page for this application
Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.