Package 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
,IFeedbackContributor
,IConverterLocator
,IMetadataContext<Serializable,Component>
,IQueueRegion
,IHeaderContributor
,IManageablePage
,IRequestableComponent
,IRequestablePage
,IHierarchical<Component>
,IClusterable
- Direct Known Subclasses:
AbstractErrorPage
,BaseWicketTester.StartComponentInPage
,BrowserInfoPage
,DevUtilsPage
,DummyHomePage
,DummyPanelPage
,GenericWebPage
,MockHomePage
,PopupCloseLink.ClosePopupPage
,RedirectPage
,SignInPage
,SignOutPage
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
-
-
Field Summary
-
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 Modifier Constructor Description protected
WebPage()
Constructor.protected
WebPage(IModel<?> model)
protected
WebPage(PageParameters parameters)
Constructor which receives wrapped query string parameters for a request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
configureResponse(WebResponse response)
Set-up response with appropriate content type, locale and encoding.void
dirty(boolean isInitialization)
Prevents page from get dirty inside an AJAX request.MarkupType
getMarkupType()
Gets the markup type for a WebPage, which is "html" by default.protected BookmarkablePageLink<Void>
homePageLink(String id)
Creates and returns a bookmarkable link to this application's home page.protected void
onAfterRender()
Called immediately after a component and all its children have been rendered, regardless of any exception.protected void
onRender()
Implementation that renders this component.protected void
renderXmlDecl()
The rules if and when to insert an xml decl in the response are a bit tricky.protected void
reportMissingHead(CharSequence collectedHeaderOutput)
Reports an error that there is no <head> and/or <body> in the page and there is no where to write the header response.protected void
setHeaders(WebResponse response)
Subclasses can override this to set there headers when the Page is being served.-
Methods inherited from class org.apache.wicket.Page
componentChanged, componentRendered, detachModels, dirty, getAutoIndex, getId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, isBookmarkable, isErrorPage, isPageStateless, onBeforeRender, onConfigure, onDetach, onInitialize, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, toString, wasCreatedBookmarkable, wasRendered
-
Methods inherited from class org.apache.wicket.MarkupContainer
add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, 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, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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.page.IManageablePage
detach
-
Methods inherited from interface org.apache.wicket.IQueueRegion
dequeue, getRegionMarkup, newDequeueContext
-
Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent
canCallListenerAfterExpiry, detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
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(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 if you want to remember the pageparametersPage.getPageParameters()
. So that they are reused for stateless links.- Parameters:
parameters
- Wrapped query string parameters.
-
-
Method Detail
-
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 classPage
- Returns:
- Markup type for HTML
-
onRender
protected void onRender()
Description copied from class:Component
Implementation that renders this component.
-
renderXmlDecl
protected void renderXmlDecl()
The rules if and when to insert an xml decl in the response are a bit tricky. Allow the user to replace the default per page and per application.
-
configureResponse
protected void configureResponse(WebResponse response)
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()). If null, no xml decl will be written.- Parameters:
response
- The WebResponse object
-
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 immediately after a component and all its children have been rendered, regardless of any exception.- Overrides:
onAfterRender
in classPage
- See Also:
Component.onAfterRender()
-
reportMissingHead
protected void reportMissingHead(CharSequence collectedHeaderOutput)
Reports an error that there is no <head> and/or <body> in the page and there is no where to write the header response.- Parameters:
collectedHeaderOutput
- The collected response that should have been written to the <head>- See Also:
validateHeaders()
-
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
-
-