We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
Uses of Class
com.vaadin.flow.component.UI
Packages that use UI
Package
Description
-
Uses of UI in com.vaadin.flow.component
Methods in com.vaadin.flow.component that return UIModifier and TypeMethodDescriptionstatic UIUI.getCurrent()Gets the currently used UI.
HeartbeatEvent.getSource()Methods in com.vaadin.flow.component that return types with arguments of type UIModifier and TypeMethodDescriptionComponent.getUI()Gets the UI this component is attached to.
UI.getUI()Methods in com.vaadin.flow.component with parameters of type UIModifier and TypeMethodDescriptionstatic voidUI.setCurrent(UI ui) Sets the thread local for the current UI.
Constructors in com.vaadin.flow.component with parameters of type UIModifierConstructorDescriptionBrowserLeaveNavigationEvent(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.
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 UIModifier and TypeMethodDescriptionstatic ChartOptionsReturns 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 UIModifier and TypeMethodDescriptionprotected voidComboBoxBase.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 UIModifier and TypeMethodDescriptionAbstractAttachDetachEvent.getUI()Gets the UI the component is attached to.
UIInternals.getUI()Gets the UI that this instance belongs to.
Methods in com.vaadin.flow.component.internal with parameters of type UIModifier and TypeMethodDescriptionvoidUIInternals.moveElementsFrom(UI otherUI) Move all the children of the other UI to this current UI.
default voidUIInternalUpdater.moveToNewUI(UI oldUI, UI newUI) Move all the children from the old UI to the new UI.
default voidUIInternalUpdater.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 UIModifierConstructorDescriptionUIInternals(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 UIMethods in com.vaadin.flow.component.page with parameters of type UIModifier and TypeMethodDescriptionstatic voidWebStorage.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 voidWebStorage.getItem(UI ui, WebStorage.Storage storage, String key, WebStorage.Callback callback) Asynchronously gets an item from the given storage.
static voidWebStorage.removeItem(UI ui, WebStorage.Storage storage, String key) Removes the value associated by the given key from the provided storage type
static voidWebStorage.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 -
Uses of UI in com.vaadin.flow.component.webcomponent
Subclasses of UI in com.vaadin.flow.component.webcomponentModifier and TypeClassDescriptionclassCustom UI for use with WebComponents served from the server.
Constructors in com.vaadin.flow.component.webcomponent with parameters of type UIModifierConstructorDescriptionWebComponentConnectEvent(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 UIModifier and TypeMethodDescriptionstatic InstantiatorGets the instantiator to use for the given UI.
-
Uses of UI in com.vaadin.flow.i18n
Methods in com.vaadin.flow.i18n that return UIModifier and TypeMethodDescriptionLocaleChangeEvent.getUI()Returns the UI where the locale changed in.
Constructors in com.vaadin.flow.i18n with parameters of type UIModifierConstructorDescriptionLocaleChangeEvent(UI ui, Locale locale) Locale change event constructor.
-
Uses of UI in com.vaadin.flow.internal
Methods in com.vaadin.flow.internal that return UIModifier and TypeMethodDescriptionExecutionContext.getUI()Gets the UI associated with the execution.
StateTree.getUI()Gets the
UIthat this tree belongs to.Methods in com.vaadin.flow.internal with parameters of type UIModifier and TypeMethodDescriptionstatic 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 UIModifier and TypeMethodDescriptionvoidStateNode.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 UIModifierConstructorDescriptionExecutionContext(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 UIModifier and TypeMethodDescriptionBeforeEvent.getUI()Gets the UI this navigation takes place inside.
LocationChangeEvent.getUI()Gets the UI in which the view is shown.
NavigationEvent.getUI()Gets the UI in which the navigation occurs.
Methods in com.vaadin.flow.router with parameters of type UIModifier and TypeMethodDescriptionstatic List<AfterNavigationObserver>EventUtil.collectAfterNavigationObservers(UI ui) Collect all Components implementing
AfterNavigationObserverthat are found in the given UI.static List<BeforeLeaveObserver>EventUtil.collectBeforeLeaveObservers(UI ui) Collect all Components implementing
BeforeLeaveObserverconnected to the given UI.static voidEventUtil.informLocaleChangeObservers(UI ui) Inform components connected to the given ui that implement
LocaleChangeObserverabout locale change.static voidEventUtil.informLocaleChangeObservers(UI ui, List<HasElement> components) Inform components implementing
LocaleChangeObserverabout locale change.voidRouter.initializeUI(UI ui, Location location) Enables navigation for a new UI instance.
intRouter.navigate(UI ui, Location location, NavigationTrigger trigger) Navigates the given UI to the given location.
intRouter.navigate(UI ui, Location location, NavigationTrigger trigger, elemental.json.JsonValue state) Navigates the given UI to the given location.
intRouter.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 UIModifierConstructorDescriptionBeforeEnterEvent(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 UIModifier and TypeMethodDescriptionRouteUtil.getDynamicTitle(UI ui) Get optional dynamic page title from the active router targets chain of a given UI instance.
static voidAbstractNavigationStateRenderer.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 UIModifier and TypeMethodDescriptionVaadinService.findUI(VaadinRequest request) Finds the
UIthat belongs to the provided request.BootstrapHandler.BootstrapContext.getUI()Gets the UI.
UIInitEvent.getUI()Get the initialized UI for this initialization event.
VaadinSession.getUIById(int uiId) Returns a UI with the given id.
Methods in com.vaadin.flow.server that return types with arguments of type UIModifier and TypeMethodDescriptionAppShellSettings.getUi()Get the target UI instance.
BootstrapHandler.getUIClass(VaadinRequest request) Returns the UI class mapped for servlet that handles the given request.
VaadinSession.getUIs()Gets all the UIs of this session.
Methods in com.vaadin.flow.server with parameters of type UIModifier and TypeMethodDescriptionvoidAdds an initialized UI to this session.
protected BootstrapHandler.BootstrapContextBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest, String> contextPathCallback) Creates a new instance of
BootstrapHandler.BootstrapContextfor givenrequest,responseandui.voidVaadinService.fireUIInitListeners(UI ui) Fire UI initialization event to all registered
UIInitListeners.protected static elemental.json.JsonObjectBootstrapHandler.getInitialUidl(UI ui) Generates the initial UIDL message which is included in the initial bootstrap page.
static booleanErrorHandlerUtil.handleErrorByRedirectingToErrorView(Exception exception, VaadinContext context, UI ui) Check if matching error handler target exists for exception and redraw view using ErrorTarget.
static booleanErrorHandlerUtil.handleErrorByRedirectingToErrorView(Throwable throwable, VaadinContext context, UI ui) Check throwable is Exception and redraw error view if matching error handler target exists.
protected voidBootstrapHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui) static booleanVaadinService.isCsrfTokenValid(UI ui, String requestToken) Verifies that the given CSRF token (synchronizer token pattern) is valid for the given UI.
booleanVaadinService.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.
voidCalled 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 UIModifier and TypeMethodDescriptionprotected BootstrapHandler.BootstrapContextBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session) Constructors in com.vaadin.flow.server with parameters of type UIModifierConstructorDescriptionprotectedBootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest, String> contextCallback) Creates a new context instance using the given parameters.
protectedBootstrapContext(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.
protectedCreates 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 UIMethods in com.vaadin.flow.server.communication that return types with arguments of type UIModifier and TypeMethodDescriptionIndexHtmlResponse.getUI()Gets the UI that will be displayed on the generated HTML page.
Methods in com.vaadin.flow.server.communication with parameters of type UIModifier and TypeMethodDescriptionprotected booleanReturnChannelHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson) protected BootstrapHandler.BootstrapContextJavaScriptBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest, String> callback) protected BootstrapHandler.BootstrapContextWebComponentBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest, String> callback) elemental.json.JsonObjectMetadataWriter.createMetadata(UI ui, boolean repaintAll, boolean async, SystemMessages messages) Creates a JSON object containing metadata related to the given UI.
elemental.json.JsonObjectUidlWriter.createUidl(UI ui, boolean async) Creates a JSON object containing all pending changes to the given UI.
elemental.json.JsonObjectUidlWriter.createUidl(UI ui, boolean async, boolean resync) Creates a JSON object containing all pending changes to the given UI.
voidServerRpcHandler.handleRpc(UI ui, Reader reader, VaadinRequest request) Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
voidServerRpcHandler.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 voidIndexHtmlRequestHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui) protected voidJavaScriptBootstrapHandler.initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui) Method parameters in com.vaadin.flow.server.communication with type arguments of type UIModifier and TypeMethodDescriptionprotected BootstrapHandler.BootstrapContextJavaScriptBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session) protected BootstrapHandler.BootstrapContextWebComponentBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session) Constructors in com.vaadin.flow.server.communication with parameters of type UIModifierConstructorDescriptionCreates 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 UIModifier and TypeMethodDescriptionprotected booleanAbstractRpcInvocationHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson) Specifies whether inert status should be ignored for an RPC invocation or not.
protected booleanEventRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson) protected booleanMapSyncRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson) protected booleanPublishedServerEventHandlerRpcHandler.allowInert(UI ui, elemental.json.JsonObject invocationJson) Handles RPC data
invocationJsonusinguias a context. -
Uses of UI in com.vaadin.testbench.unit.mocks
Fields in com.vaadin.testbench.unit.mocks with type parameters of type UIModifier and TypeFieldDescriptionfinal kotlin.jvm.functions.Function0<UI>MockSpringServlet.uiFactoryConstructor parameters in com.vaadin.testbench.unit.mocks with type arguments of type UIModifierConstructorDescriptionMockSpringServlet(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)