Package com.vaadin.server

Class UICreateEvent

java.lang.Object

java.util.EventObject

com.vaadin.server.UIProviderEvent

com.vaadin.server.UICreateEvent

All Implemented Interfaces:

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, 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, Class<? extends UI> uiClass, Integer uiId)	Creates a new UI create event for a given VaadinRequest, UI class and UI id

Method Summary

Modifier and Type	Method	Description
Class<? extends UI>	getUIClass()	Gets the UI class that will be created.
Integer	getUiId()	Gets the id of the UI about to be created.

Methods inherited from class com.vaadin.server.UIProviderEvent

getRequest, getService

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,
                     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,
                     Class<? extends UI> uiClass,
                     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 Class<? extends UI> getUIClass()

Gets the UI class that will be created.

Returns:

the UI class

getUiId

public 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.