Uses of Class
com.vaadin.flow.component.UI

Packages that use UI

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.charts
com.vaadin.flow.component.combobox
com.vaadin.flow.component.internal
com.vaadin.flow.component.page
com.vaadin.flow.component.webcomponent
com.vaadin.flow.di
com.vaadin.flow.i18n
com.vaadin.flow.internal
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.communication
com.vaadin.flow.server.communication.rpc
com.vaadin.testbench.unit.mocks

Uses of UI in com.vaadin.flow.component

Methods in com.vaadin.flow.component that return UI

Modifier and Type	Method	Description
static UI	UI.getCurrent()	Gets the currently used UI.
UI	HeartbeatEvent.getSource()

Methods in com.vaadin.flow.component that return types with arguments of type UI

Modifier and Type	Method	Description
Optional<UI>	Component.getUI()	Gets the UI this component is attached to.
Optional<UI>	UI.getUI()

Methods in com.vaadin.flow.component with parameters of type UI

Modifier and Type	Method	Description
static void	UI.setCurrent(UI ui)	Sets the thread local for the current UI.

Constructors in com.vaadin.flow.component with parameters of type UI

Modifier	Constructor	Description
	BrowserLeaveNavigationEvent(UI source, boolean fromClient, String route, String query)	Creates a new event instance.
	BrowserNavigateEvent(UI source, boolean fromClient, String route, String query, String appShellTitle, elemental.json.JsonValue historyState, String trigger)	Creates a new event instance.
	BrowserRefreshEvent(UI source, boolean fromClient, boolean refreshRouteChain)	Creates a new event instance.
	HeartbeatEvent(UI ui, long heartbeatTime)	Constructs a heartbeat Event.
	PollEvent(UI ui, boolean fromClient)	Creates a new event using the given source and indicator whether the event originated from the client side or the server side.

Uses of UI in com.vaadin.flow.component.charts

Methods in com.vaadin.flow.component.charts with parameters of type UI

Modifier and Type	Method	Description
static ChartOptions	ChartOptions.get(UI ui)	Returns a ChartOptions instance for the given UI.

Uses of UI in com.vaadin.flow.component.combobox

Method parameters in com.vaadin.flow.component.combobox with type arguments of type UI

Modifier and Type	Method	Description
protected void	ComboBoxBase.runBeforeClientResponse(SerializableConsumer<UI> command)	Helper for running a command in the before client response hook

Uses of UI in com.vaadin.flow.component.internal

Methods in com.vaadin.flow.component.internal that return UI

Modifier and Type	Method	Description
UI	AbstractAttachDetachEvent.getUI()	Gets the UI the component is attached to.
UI	UIInternals.getUI()	Gets the UI that this instance belongs to.

Methods in com.vaadin.flow.component.internal with parameters of type UI

Modifier and Type	Method	Description
void	UIInternals.moveElementsFrom(UI otherUI)	Move all the children of the other UI to this current UI.
default void	UIInternalUpdater.moveToNewUI(UI oldUI, UI newUI)	Move all the children from the old UI to the new UI.
default void	UIInternalUpdater.updateRoot(UI ui, HasElement oldRoot, HasElement newRoot)	Update root element of the given UI.

Constructors in com.vaadin.flow.component.internal with parameters of type UI

Modifier	Constructor	Description
	UIInternals(UI ui)	Creates a new instance for the given UI.
	UIInternals(UI ui, UIInternalUpdater internalsHandler)	Creates a new instance for the given UI.

Uses of UI in com.vaadin.flow.component.page

Methods in com.vaadin.flow.component.page that return UI

Modifier and Type	Method	Description
UI	History.getUI()	Gets the UI that this instance belongs to.

Methods in com.vaadin.flow.component.page with parameters of type UI

Modifier and Type	Method	Description
static void	WebStorage.clear(UI ui, WebStorage.Storage storage)	Clears the given storage.
static CompletableFuture<String>	WebStorage.getItem(UI ui, WebStorage.Storage storage, String key)	Asynchronously gets an item from the given storage.
static void	WebStorage.getItem(UI ui, WebStorage.Storage storage, String key, WebStorage.Callback callback)	Asynchronously gets an item from the given storage.
static void	WebStorage.removeItem(UI ui, WebStorage.Storage storage, String key)	Removes the value associated by the given key from the provided storage type
static void	WebStorage.setItem(UI ui, WebStorage.Storage storage, String key, String value)	Sets given key-value pair to given storage type

Constructors in com.vaadin.flow.component.page with parameters of type UI

Modifier	Constructor	Description
	History(UI ui)	Creates a history API endpoint for the given UI.
	Page(UI ui)	Creates a page instance for the given UI.

Uses of UI in com.vaadin.flow.component.webcomponent

Subclasses of UI in com.vaadin.flow.component.webcomponent

Modifier and Type	Class	Description
class	WebComponentUI	Custom UI for use with WebComponents served from the server.

Constructors in com.vaadin.flow.component.webcomponent with parameters of type UI

Modifier	Constructor	Description
	WebComponentConnectEvent(UI source, boolean fromClient, String tag, String webComponentElementId, String userAssignedId, elemental.json.JsonObject attributeValues)	Creates a new web component connection event.

Uses of UI in com.vaadin.flow.di

Methods in com.vaadin.flow.di with parameters of type UI

Modifier and Type	Method	Description
static Instantiator	Instantiator.get(UI ui)	Gets the instantiator to use for the given UI.

Uses of UI in com.vaadin.flow.i18n

Methods in com.vaadin.flow.i18n that return UI

Modifier and Type	Method	Description
UI	LocaleChangeEvent.getUI()	Returns the UI where the locale changed in.

Constructors in com.vaadin.flow.i18n with parameters of type UI

Modifier	Constructor	Description
	LocaleChangeEvent(UI ui, Locale locale)	Locale change event constructor.

Uses of UI in com.vaadin.flow.internal

Methods in com.vaadin.flow.internal that return UI

Modifier and Type	Method	Description
UI	ExecutionContext.getUI()	Gets the UI associated with the execution.
UI	StateTree.getUI()	Gets the UI that this tree belongs to.

Methods in com.vaadin.flow.internal with parameters of type UI

Modifier and Type	Method	Description
static Map<Class<?>,CurrentInstance>	CurrentInstance.setCurrent(UI ui)	Sets current instances for the UI and all related classes.

Method parameters in com.vaadin.flow.internal with type arguments of type UI

Modifier and Type	Method	Description
void	StateNode.runWhenAttached(SerializableConsumer<UI> command)	Runs the command when the node is attached to a UI.

Constructors in com.vaadin.flow.internal with parameters of type UI

Modifier	Constructor	Description
	ExecutionContext(UI ui, boolean clientSideInitialized)	Creates a new, immutable context.

Uses of UI in com.vaadin.flow.router

Methods in com.vaadin.flow.router that return UI

Modifier and Type	Method	Description
UI	BeforeEvent.getUI()	Gets the UI this navigation takes place inside.
UI	LocationChangeEvent.getUI()	Gets the UI in which the view is shown.
UI	NavigationEvent.getUI()	Gets the UI in which the navigation occurs.

Methods in com.vaadin.flow.router with parameters of type UI

Modifier and Type	Method	Description
static List<AfterNavigationObserver>	EventUtil.collectAfterNavigationObservers(UI ui)	Collect all Components implementing AfterNavigationObserver that are found in the given UI.
static List<BeforeLeaveObserver>	EventUtil.collectBeforeLeaveObservers(UI ui)	Collect all Components implementing BeforeLeaveObserver connected to the given UI.
static void	EventUtil.informLocaleChangeObservers(UI ui)	Inform components connected to the given ui that implement LocaleChangeObserver about locale change.
static void	EventUtil.informLocaleChangeObservers(UI ui, List<HasElement> components)	Inform components implementing LocaleChangeObserver about locale change.
void	Router.initializeUI(UI ui, Location location)	Enables navigation for a new UI instance.
int	Router.navigate(UI ui, Location location, NavigationTrigger trigger)	Navigates the given UI to the given location.
int	Router.navigate(UI ui, Location location, NavigationTrigger trigger, elemental.json.JsonValue state)	Navigates the given UI to the given location.
int	Router.navigate(UI ui, Location location, NavigationTrigger trigger, elemental.json.JsonValue state, boolean forceInstantiation, boolean recreateLayoutChain)	Navigates the given UI to the given location.

Constructors in com.vaadin.flow.router with parameters of type UI

Modifier	Constructor	Description
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	ErrorNavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, ErrorParameter<?> errorParameter)	Creates a new navigation event.
	ErrorNavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, ErrorParameter<?> errorParameter, elemental.json.JsonValue state)	Creates a new navigation event.
	LocationChangeEvent(Router router, UI ui, NavigationTrigger trigger, Location location, List<HasElement> routeTargetChain)	Creates a new location change event.
	NavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger)	Creates a new navigation event.
	NavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, elemental.json.JsonValue state, boolean forwardTo)	Creates a new navigation event.
	NavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, elemental.json.JsonValue state, boolean forwardTo, boolean forceInstantiation, boolean recreateLayoutChain)	Creates a new navigation event.

Uses of UI in com.vaadin.flow.router.internal

Methods in com.vaadin.flow.router.internal with parameters of type UI

Modifier and Type	Method	Description
static Optional<String>	RouteUtil.getDynamicTitle(UI ui)	Get optional dynamic page title from the active router targets chain of a given UI instance.
static void	AbstractNavigationStateRenderer.purgeInactiveUIPreservedChainCache(UI inactiveUI)	Removes preserved component cache for an inactive UI.

Uses of UI in com.vaadin.flow.server

Methods in com.vaadin.flow.server that return UI

Modifier and Type	Method	Description
UI	VaadinService.findUI(VaadinRequest request)	Finds the UI that belongs to the provided request.
UI	BootstrapHandler.BootstrapContext.getUI()	Gets the UI.
UI	UIInitEvent.getUI()	Get the initialized UI for this initialization event.
UI	VaadinSession.getUIById(int uiId)	Returns a UI with the given id.

Methods in com.vaadin.flow.server that return types with arguments of type UI

Modifier and Type	Method	Description
Optional<UI>	AppShellSettings.getUi()	Get the target UI instance.
protected static Class<? extends UI>	BootstrapHandler.getUIClass(VaadinRequest request)	Returns the UI class mapped for servlet that handles the given request.
Collection<UI>	VaadinSession.getUIs()	Gets all the UIs of this session.

Methods in com.vaadin.flow.server with parameters of type UI

Modifier and Type	Method	Description
void	VaadinSession.addUI(UI ui)	Adds an initialized UI to this session.
protected BootstrapHandler.BootstrapContext	BootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> contextPathCallback)	Creates a new instance of BootstrapHandler.BootstrapContext for given request, response and ui.
void	VaadinService.fireUIInitListeners(UI ui)	Fire UI initialization event to all registered UIInitListeners.
protected static elemental.json.JsonObject	BootstrapHandler.getInitialUidl(UI ui)	Generates the initial UIDL message which is included in the initial bootstrap page.
static boolean	ErrorHandlerUtil.handleErrorByRedirectingToErrorView(Exception exception, VaadinContext context, UI ui)	Check if matching error handler target exists for exception and redraw view using ErrorTarget.
static boolean	ErrorHandlerUtil.handleErrorByRedirectingToErrorView(Throwable throwable, VaadinContext context, UI ui)	Check throwable is Exception and redraw error view if matching error handler target exists.
protected void	BootstrapHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui)
static boolean	VaadinService.isCsrfTokenValid(UI ui, String requestToken)	Verifies that the given CSRF token (synchronizer token pattern) is valid for the given UI.
boolean	VaadinService.isUIActive(UI ui)	Returns whether the given UI is active (the client-side actively communicates with the server) or whether it can be removed from the session and eventually collected.
void	VaadinSession.removeUI(UI ui)	Called by the framework to remove an UI instance from the session because it has been closed.

Method parameters in com.vaadin.flow.server with type arguments of type UI

Modifier and Type	Method	Description
protected BootstrapHandler.BootstrapContext	BootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)

Constructors in com.vaadin.flow.server with parameters of type UI

Modifier	Constructor	Description
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback)	Creates a new context instance using the given parameters.
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback, Function<VaadinRequest,Location> routeCallback)	Creates a new context instance using the given parameters.
protected	BootstrapUriResolver(UI ui)	Creates a new bootstrap resolver based on the given ui.
	UIInitEvent(UI ui, VaadinService service)	Constructs a prototypical Event.

Uses of UI in com.vaadin.flow.server.communication

Methods in com.vaadin.flow.server.communication that return UI

Modifier and Type	Method	Description
protected UI	AtmospherePushConnection.getUI()

Methods in com.vaadin.flow.server.communication that return types with arguments of type UI

Modifier and Type	Method	Description
Optional<UI>	IndexHtmlResponse.getUI()	Gets the UI that will be displayed on the generated HTML page.

Methods in com.vaadin.flow.server.communication with parameters of type UI

Modifier and Type	Method	Description
protected boolean	ReturnChannelHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson)
protected BootstrapHandler.BootstrapContext	JavaScriptBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)
protected BootstrapHandler.BootstrapContext	WebComponentBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)
elemental.json.JsonObject	MetadataWriter.createMetadata(UI ui, boolean repaintAll, boolean async, SystemMessages messages)	Creates a JSON object containing metadata related to the given UI.
elemental.json.JsonObject	UidlWriter.createUidl(UI ui, boolean async)	Creates a JSON object containing all pending changes to the given UI.
elemental.json.JsonObject	UidlWriter.createUidl(UI ui, boolean async, boolean resync)	Creates a JSON object containing all pending changes to the given UI.
void	ServerRpcHandler.handleRpc(UI ui, Reader reader, VaadinRequest request)	Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
void	ServerRpcHandler.handleRpc(UI ui, String message, VaadinRequest request)	Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
protected void	IndexHtmlRequestHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui)
protected void	JavaScriptBootstrapHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui)

Method parameters in com.vaadin.flow.server.communication with type arguments of type UI

Modifier and Type	Method	Description
protected BootstrapHandler.BootstrapContext	JavaScriptBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)
protected BootstrapHandler.BootstrapContext	WebComponentBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)

Constructors in com.vaadin.flow.server.communication with parameters of type UI

Modifier	Constructor	Description
	AtmospherePushConnection(UI ui)	Creates an instance connected to the given UI.
	IndexHtmlResponse(VaadinRequest vaadinRequest, VaadinResponse vaadinResponse, org.jsoup.nodes.Document document, UI ui)	Create a response object for client side bootstrapping with UI.
	JavaScriptBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)	Creates a new context instance using the given parameters.

Uses of UI in com.vaadin.flow.server.communication.rpc

Methods in com.vaadin.flow.server.communication.rpc with parameters of type UI

Modifier and Type	Method	Description
protected boolean	AbstractRpcInvocationHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson)	Specifies whether inert status should be ignored for an RPC invocation or not.
protected boolean	EventRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson)
protected boolean	MapSyncRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson)
protected boolean	PublishedServerEventHandlerRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson)
Optional<Runnable>	AbstractRpcInvocationHandler.handle(UI ui, elemental.json.JsonObject invocationJson)
Optional<Runnable>	NavigationRpcHandler.handle(UI ui, elemental.json.JsonObject invocationJson)
Optional<Runnable>	RpcInvocationHandler.handle(UI ui, elemental.json.JsonObject invocationJson)	Handles RPC data invocationJson using ui as a context.

Uses of UI in com.vaadin.testbench.unit.mocks

Fields in com.vaadin.testbench.unit.mocks with type parameters of type UI

Modifier and Type	Field	Description
final kotlin.jvm.functions.Function0<UI>	MockSpringServlet.uiFactory

Constructor parameters in com.vaadin.testbench.unit.mocks with type arguments of type UI

Modifier	Constructor	Description
	MockSpringServlet(com.vaadin.testbench.unit.internal.Routes routes, org.springframework.context.ApplicationContext ctx, kotlin.jvm.functions.Function0<UI> uiFactory)
	MockSpringServletService(MockSpringServlet servlet, DeploymentConfiguration deploymentConfiguration, org.springframework.context.ApplicationContext ctx, kotlin.jvm.functions.Function0<UI> uiFactory)
	MockSpringVaadinSession(VaadinService service, kotlin.jvm.functions.Function0<UI> uiFactory)