We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.server.
Class BootstrapPageResponse
- java.lang.Object
-
- java.util.EventObject
-
- com.vaadin.server.BootstrapResponse
-
- com.vaadin.server.BootstrapPageResponse
-
All Implemented Interfaces:
public class BootstrapPageResponse extends BootstrapResponseA representation of a bootstrap page being generated. The bootstrap page contains of the full DOM of the HTML document as well as the HTTP headers that will be included in the corresponding HTTP response.
Since:
7.0.0
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description BootstrapPageResponse(BootstrapHandler handler, VaadinRequest request, VaadinSession session, Class<? extends UI> uiClass, org.jsoup.nodes.Document document, Map<String,Object> headers, UIProvider uiProvider)Crate a new bootstrap page response.
-
Method Summary
All Methods Modifier and Type Method and Description org.jsoup.nodes.DocumentgetDocument()Gets the document node representing the root of the DOM hierarchy that will be used to generate the HTML page.
voidsetDateHeader(String name, long timestamp)Properly formats a timestamp as a date in a header that will be included in the HTTP response.
voidsetHeader(String name, String value)Sets a header value that will be added to the HTTP response.
-
Methods inherited from class com.vaadin.server.BootstrapResponse
getBootstrapHandler, getRequest, getSession, getUiClass, getUIProvider, getUriResolver, setUriResolver
-
Methods inherited from class java.util.EventObject
getSource, toString
-
-
-
-
Constructor Detail
-
BootstrapPageResponse
public BootstrapPageResponse(BootstrapHandler handler, VaadinRequest request, VaadinSession session, Class<? extends UI> uiClass, org.jsoup.nodes.Document document, Map<String,Object> headers, UIProvider uiProvider)Crate a new bootstrap page response.
Parameters:
handler- the bootstrap handler that is firing the eventrequest- the Vaadin request for which the bootstrap page should be generatedsession- the service session for which the bootstrap page should be generateduiClass- the class of the UI that will be displayed on the pagedocument- the DOM document making up the HTML pageheaders- a map into which header data can be addeduiProvider- the UI provider for the bootstrapSee Also:
-
-
Method Detail
-
setHeader
public void setHeader(String name, String value)Sets a header value that will be added to the HTTP response. If the header had already been set, the new value overwrites the previous one.
Parameters:
name- the name of the headervalue- the header valueSee Also:
-
setDateHeader
public void setDateHeader(String name, long timestamp)Properly formats a timestamp as a date in a header that will be included in the HTTP response. If the header had already been set, the new value overwrites the previous one.
Parameters:
name- the name of the headertimestamp- the number of milliseconds since epochSee Also:
setHeader(String, String),VaadinResponse.setDateHeader(String, long)
-
getDocument
public org.jsoup.nodes.Document getDocument()Gets the document node representing the root of the DOM hierarchy that will be used to generate the HTML page. Changes to the document will be reflected in the HTML.
Returns:
the document node
-
-