Contact us
Create app
com.vaadin.server.

Interface BootstrapListener

  • All Superinterfaces:

    EventListener, Serializable, SerializableEventListener

    public interface BootstrapListener
extends SerializableEventListener

    Event listener notified when the bootstrap HTML is about to be generated and send to the client. The bootstrap HTML is first constructed as an in-memory DOM representation which registered listeners can modify before the final HTML is generated.

    Since:

    7.0.0

    Author:

    Vaadin Ltd

    • Method Summary

      All Methods
      Modifier and Type Method Description
      void modifyBootstrapFragment​(BootstrapFragmentResponse response)

      Lets this listener make changes to the fragment that makes up the actual Vaadin application.
      void modifyBootstrapPage​(BootstrapPageResponse response)

      Lets this listener make changes to the overall HTML document that will be used as the initial HTML page in a typical Servlet deployment as well as the HTTP headers in the response serving the initial HTML.

    • Method Detail

      • modifyBootstrapFragment

        void modifyBootstrapFragment​(BootstrapFragmentResponse response)

        Lets this listener make changes to the fragment that makes up the actual Vaadin application. In a typical Servlet deployment, this is the contents of the HTML body tag. In a typical Portlet deployment, this is the HTML that will be returned in a javax.portlet.RenderResponse.

        Parameters:

        response - the bootstrap response that can modified to cause changes in the generated HTML.

      • modifyBootstrapPage

        void modifyBootstrapPage​(BootstrapPageResponse response)

        Lets this listener make changes to the overall HTML document that will be used as the initial HTML page in a typical Servlet deployment as well as the HTTP headers in the response serving the initial HTML. In cases where a full HTML document is not generated, this method will not be invoked.

        If a full page is being generated, this method is invoked after modifyBootstrapFragment(BootstrapFragmentResponse) has been invoked for all registered listeners.

        Parameters:

        response - the bootstrap response that can be modified to cause change in the generate HTML and in the HTTP headers of the response.