org.apache.wicket.page

Class PartialPageUpdate

java.lang.Object

org.apache.wicket.page.PartialPageUpdate

Direct Known Subclasses:

XmlPartialPageUpdate

public abstract class PartialPageUpdate
extends Object

A partial update of a page that collects components and header contributions to be written to the client in a specific String-based format (XML, JSON, * ...).

The elements of such response are:

• priority-evaluate - an item of the prepend JavaScripts
• component - the markup of the updated component
• evaluate - an item of the onDomReady and append JavaScripts
• header-contribution - all HeaderItems which have been contributed in components' and their behaviors' #renderHead(Component, IHeaderResponse)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PartialPageUpdate.ResponseBuffer Wrapper of a response that buffers its contents.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CharSequence>	appendJavaScripts A list of scripts (JavaScript) which should be executed on the client side after the components' replacement
protected PartialPageUpdate.ResponseBuffer	bodyBuffer Buffer of response body.
protected boolean	componentsFrozen A flag that indicates that components cannot be added anymore.
protected List<CharSequence>	domReadyJavaScripts A list of scripts (JavaScript) which should be executed on the client side after the components' replacement.
protected HtmlHeaderContainer	header
protected PartialPageUpdate.ResponseBuffer	headerBuffer Buffer of response header.
protected Map<String,Component>	markupIdToComponent The component instances that will be rendered/replaced.
protected List<CharSequence>	prependJavaScripts A list of scripts (JavaScript) which should be executed on the client side before the components' replacement

Constructor Summary

Constructors

Constructor and Description
PartialPageUpdate(Page page) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component component, String markupId) Adds a component to be updated at the client side with its current markup
void	appendJavaScript(CharSequence javascript) Adds script to the ones which are executed after the component replacement.
protected boolean	containsAncestorFor(Component component) Checks if the target contains an ancestor for the given component
boolean	containsPage()
void	detach(IRequestCycle requestCycle) Detaches the page if at least one of its components was updated.
boolean	equals(Object o)
Collection<? extends Component>	getComponents()
IHeaderResponse	getHeaderResponse() Gets or creates an IHeaderResponse instance to use for the header contributions.
int	hashCode()
protected void	onAfterRespond(Response response) Hook-method called after components are written.
protected void	onBeforeRespond(Response response) Hook-method called before components are written.
void	prependJavaScript(CharSequence javascript) Adds script to the ones which are executed before the component replacement.
abstract void	setContentType(WebResponse response, String encoding) Sets the Content-Type header to indicate the type of the response.
protected abstract void	writeComponent(Response response, String markupId, Component component, String encoding) Writes a single component
protected abstract void	writeFooter(Response response, String encoding)
protected abstract void	writeHeader(Response response, String encoding) Writes the head part of the response.
protected abstract void	writeHeaderContribution(Response response) Writes header contribution ( or Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2006–2018 Apache Software Foundation. All rights reserved.