com.vaadin.server

Class BootstrapHandler.BootstrapContext

java.lang.Object

com.vaadin.server.BootstrapHandler.BootstrapContext

All Implemented Interfaces:

Serializable

Enclosing class:

BootstrapHandler

protected class BootstrapHandler.BootstrapContext
extends Object
implements Serializable

Provides context information for the bootstrap process.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BootstrapContext(VaadinResponse response, BootstrapFragmentResponse bootstrapResponse) Creates a new context instance using the given Vaadin/HTTP response and bootstrap response.

Method Summary

Modifier and Type	Method and Description
String	getAppId() Gets the application id.
JsonObject	getApplicationParameters() Gets the application parameters specified by the BootstrapHandler.
BootstrapFragmentResponse	getBootstrapResponse() Gets the bootstrap response object.
PushMode	getPushMode() Gets the push mode to use.
VaadinRequest	getRequest() Gets the Vaadin/HTTP request.
VaadinResponse	getResponse() Gets the Vaadin/HTTP response.
VaadinSession	getSession() Gets the Vaadin session.
String	getThemeName() Gets the name of the theme to use.
Class<? extends UI>	getUIClass() Gets the UI class which will be used.
BootstrapHandler.BootstrapUriResolver	getUriResolver() Gets the URI resolver to use for bootstrap resources.
WidgetsetInfo	getWidgetsetInfo() Gets information about the widgetset to use.
String	getWidgetsetName() Deprecated. use getWidgetsetInfo() instead

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrapContext

public BootstrapContext(VaadinResponse response,
                        BootstrapFragmentResponse bootstrapResponse)

Creates a new context instance using the given Vaadin/HTTP response and bootstrap response.

Parameters:

response - the response object

bootstrapResponse - the bootstrap response object

Method Detail

getResponse

public VaadinResponse getResponse()

Gets the Vaadin/HTTP response.

Returns:

the Vaadin/HTTP response

getRequest

public VaadinRequest getRequest()

Gets the Vaadin/HTTP request.

Returns:

the Vaadin/HTTP request

getSession

public VaadinSession getSession()

Gets the Vaadin session.

Returns:

the Vaadin session

getUIClass

public Class<? extends UI> getUIClass()

Gets the UI class which will be used.

Returns:

the UI class

getWidgetsetInfo

public WidgetsetInfo getWidgetsetInfo()

Gets information about the widgetset to use.

Returns:

the widgetset which will be loaded

getWidgetsetName

@Deprecated
public String getWidgetsetName()

Deprecated. use getWidgetsetInfo() instead

Returns:

returns the name of the widgetset to use

getThemeName

public String getThemeName()

Gets the name of the theme to use.

Returns:

the name of the theme, with special characters escaped or removed

getPushMode

public PushMode getPushMode()

Gets the push mode to use.

Returns:

the desired push mode

getAppId

public String getAppId()

Gets the application id. The application id is defined by VaadinService.getMainDivId(VaadinSession, VaadinRequest, Class)

Returns:

the application id

getBootstrapResponse

public BootstrapFragmentResponse getBootstrapResponse()

Gets the bootstrap response object.

Returns:

the bootstrap response object

getApplicationParameters

public JsonObject getApplicationParameters()

Gets the application parameters specified by the BootstrapHandler.

Returns:

the application parameters which will be written on the page

getUriResolver

public BootstrapHandler.BootstrapUriResolver getUriResolver()

Gets the URI resolver to use for bootstrap resources.

Returns:

the URI resolver

Since:

8.1