Package org.apache.wicket.page

Class XmlPartialPageUpdate

java.lang.Object

org.apache.wicket.page.PartialPageUpdate

org.apache.wicket.page.XmlPartialPageUpdate

public class XmlPartialPageUpdate
extends PartialPageUpdate

A PartialPageUpdate that serializes itself to XML.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.page.PartialPageUpdate

PartialPageUpdate.ResponseBuffer

Field Summary

Fields

Modifier and Type	Field	Description
static String	END_ROOT_ELEMENT
static String	START_ROOT_ELEMENT	The name of the root element in the produced XML document.

Fields inherited from class org.apache.wicket.page.PartialPageUpdate

appendJavaScripts, bodyBuffer, componentsFrozen, domReadyJavaScripts, header, headerBuffer, javascriptsFrozen, markupIdToComponent, prependJavaScripts

Constructor Summary

Constructors

Constructor	Description
XmlPartialPageUpdate(Page page)

Method Summary

Modifier and Type	Method	Description
protected CharSequence	encode(CharSequence str)
void	setContentType(WebResponse response, String encoding)	Sets the Content-Type header to indicate the type of the response.
protected void	writeComponent(Response response, String markupId, CharSequence contents)	Writes a component to the response.
protected void	writeComponent(Response response, String markupId, Component component, String encoding)	TODO remove in Wicket 10
protected void	writeEvaluation(Response response, CharSequence contents)	TODO make abstract in Wicket 10
protected void	writeFooter(Response response, String encoding)
protected void	writeHeader(Response response, String encoding)	Writes the head part of the response.
protected void	writeHeaderContribution(Response response, CharSequence contents)	Writes a header contribution to the response.
protected void	writePriorityEvaluation(Response response, CharSequence contents)	TODO make abstract in Wicket 10

Methods inherited from class org.apache.wicket.page.PartialPageUpdate

add, appendJavaScript, containsAncestorFor, containsPage, detach, equals, getComponents, getHeaderResponse, hashCode, isEmpty, onAfterRespond, onBeforeRespond, prepareComponent, prependJavaScript, writeEvaluations, writeHeaderContribution, writePriorityEvaluations, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

START_ROOT_ELEMENT

public static final String START_ROOT_ELEMENT

The name of the root element in the produced XML document.

See Also:

Constant Field Values

END_ROOT_ELEMENT

public static final String END_ROOT_ELEMENT

See Also:

Constant Field Values

Constructor Detail

XmlPartialPageUpdate

public XmlPartialPageUpdate(Page page)

Method Detail

setContentType

public void setContentType(WebResponse response,
                           String encoding)

Description copied from class: PartialPageUpdate

Sets the Content-Type header to indicate the type of the response.

Specified by:

setContentType in class PartialPageUpdate

Parameters:

response - the current we response

encoding - the encoding to use

writeHeader

protected void writeHeader(Response response,
                           String encoding)

Description copied from class: PartialPageUpdate

Writes the head part of the response. For example XML preamble

Specified by:

writeHeader in class PartialPageUpdate

Parameters:

response - the response to write to

encoding - the encoding for the response

writeComponent

protected void writeComponent(Response response,
                              String markupId,
                              Component component,
                              String encoding)

TODO remove in Wicket 10

Overrides:

writeComponent in class PartialPageUpdate

Parameters:

response - the response to write to

markupId - the markup id to use for the component replacement

component - the component which markup will be used as replacement

encoding - the encoding for the response

writeComponent

protected void writeComponent(Response response,
                              String markupId,
                              CharSequence contents)

Description copied from class: PartialPageUpdate

Writes a component to the response.

TODO make abstract in Wicket 10

Overrides:

writeComponent in class PartialPageUpdate

Parameters:

response - the response to write to

contents - the contents

writeFooter

protected void writeFooter(Response response,
                           String encoding)

Specified by:

writeFooter in class PartialPageUpdate

Parameters:

response - the response to write to

encoding - the encoding for the response

writePriorityEvaluation

protected void writePriorityEvaluation(Response response,
                                       CharSequence contents)

Description copied from class: PartialPageUpdate

TODO make abstract in Wicket 10

Overrides:

writePriorityEvaluation in class PartialPageUpdate

writeHeaderContribution

protected void writeHeaderContribution(Response response,
                                       CharSequence contents)

Description copied from class: PartialPageUpdate

Writes a header contribution to the response.

Specified by:

writeHeaderContribution in class PartialPageUpdate

Parameters:

response - the response to write to

contents - the contents

writeEvaluation

protected void writeEvaluation(Response response,
                               CharSequence contents)

Description copied from class: PartialPageUpdate

TODO make abstract in Wicket 10

Overrides:

writeEvaluation in class PartialPageUpdate

encode

protected CharSequence encode(CharSequence str)