Class UICreateEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class UICreateEvent
    extends UIProviderEvent
    Contains data used by various methods in UIProvider for determining information about a new UI that is about to be created.
    Since:
    7.0.0
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class java.util.EventObject

        source
    • Constructor Summary

      Constructors 
      Constructor Description
      UICreateEvent​(VaadinRequest request, java.lang.Class<? extends UI> uiClass)
      Creates a new UI create event for a given VaadinRequest and UI class but without a UI id.
      UICreateEvent​(VaadinRequest request, java.lang.Class<? extends UI> uiClass, java.lang.Integer uiId)
      Creates a new UI create event for a given VaadinRequest, UI class and UI id.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Class<? extends UI> getUIClass()
      Gets the UI class that will be created.
      java.lang.Integer getUiId()
      Gets the id of the UI about to be created.
      • Methods inherited from class java.util.EventObject

        getSource, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • UICreateEvent

        public UICreateEvent​(VaadinRequest request,
                             java.lang.Class<? extends UI> uiClass)
        Creates a new UI create event for a given VaadinRequest and UI class but without a UI id.
        Parameters:
        request - the request for which the UI will be created
        uiClass - the UI class that will be created
      • UICreateEvent

        public UICreateEvent​(VaadinRequest request,
                             java.lang.Class<? extends UI> uiClass,
                             java.lang.Integer uiId)
        Creates a new UI create event for a given VaadinRequest, UI class and UI id.
        Parameters:
        request - the request for which the UI will be created
        uiClass - the UI class that will be created
        uiId - the id reserved for the UI; or null if no id has yet been allocated.
    • Method Detail

      • getUIClass

        public java.lang.Class<? extends UI> getUIClass()
        Gets the UI class that will be created.
        Returns:
        the UI class
      • getUiId

        public java.lang.Integer getUiId()
        Gets the id of the UI about to be created. This might be null if the id has not yet been determined.

        The UI id is generally only available in UIProvider.createInstance(UICreateEvent)

        Returns:
        the UI id; or null if the UI id is not yet known.