com.vaadin.flow.component.webcomponent

Class WebComponentUI

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.UI

com.vaadin.flow.component.webcomponent.WebComponentUI

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasComponents, HasElement, HasEnabled, PollNotifier, RouterLayout, Serializable

public class WebComponentUI
extends UI

Custom UI for use with WebComponents served from the server.

Since:

2.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_NAVIGATION

Constructor Summary

Constructors

Constructor and Description
WebComponentUI()

Method Summary

Modifier and Type	Method and Description
void	connectWebComponent(String tag, String webComponentElementId, elemental.json.JsonObject attributeJson) Connect a client side web component element with a server side Component that's added as a virtual child to the UI as the actual relation of the elements is unknown.
void	doInit(VaadinRequest request, int uiId) Internal initialization method, should not be overridden.
Router	getRouter() Gets the router used for navigating in this UI.
Optional<ThemeDefinition>	getThemeFor(Class<?> navigationTarget, String path) Gets the ThemeDefinition associated with the given navigation target, if any.
<T,C extends Component & HasUrlParameter<T>> void	navigate(Class<? extends C> navigationTarget, T parameter) Updates this UI to show the view corresponding to the given navigation target with the specified parameter.
void	navigate(Class<? extends Component> navigationTarget) Updates this UI to show the view corresponding to the given navigation target.
void	navigate(String location) Updates this UI to show the view corresponding to the given location.
void	navigate(String location, QueryParameters queryParameters) Updates this UI to show the view corresponding to the given location and query parameters.

Methods inherited from class com.vaadin.flow.component.UI

access, accessLater, accessLater, accessSynchronously, add, addAfterNavigationListener, addBeforeEnterListener, addBeforeLeaveListener, addShortcutListener, addShortcutListener, beforeClientResponse, close, getActiveDragSourceComponent, getCsrfToken, getCurrent, getElement, getInternals, getLoadingIndicatorConfiguration, getLocale, getNavigationListeners, getPage, getPollInterval, getPushConfiguration, getReconnectDialogConfiguration, getSession, getUI, getUIId, init, isClosing, onAttach, onDetach, push, setCurrent, setLocale, setPollInterval

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getEventBus, getId, getParent, getTranslation, getTranslation, hasListener, isTemplateMapped, isVisible, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.PollNotifier

addPollListener

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.router.RouterLayout

removeRouterLayoutContent, showRouterLayoutContent

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Field Detail

NO_NAVIGATION

public static final String NO_NAVIGATION

See Also:

Constant Field Values

Constructor Detail

WebComponentUI

public WebComponentUI()

Method Detail

doInit

public void doInit(VaadinRequest request,
                   int uiId)

Description copied from class: UI

Internal initialization method, should not be overridden. This method is not declared as final because that would break compatibility with e.g. CDI.

Overrides:

doInit in class UI

Parameters:

request - the initialization request

uiId - the id of the new ui

See Also:

UI.getUIId()

connectWebComponent

@ClientCallable
public void connectWebComponent(String tag,
                                                String webComponentElementId,
                                                elemental.json.JsonObject attributeJson)

Connect a client side web component element with a server side Component that's added as a virtual child to the UI as the actual relation of the elements is unknown.

Parameters:

tag - web component tag

webComponentElementId - client side id of the element

attributeJson - initial attribute values as a JsonObject. If present, these will override the default value designated by the WebComponentExporter but only for this instance.

getRouter

public Router getRouter()

Description copied from class: UI

Gets the router used for navigating in this UI.

Overrides:

getRouter in class UI

Returns:

a router

getThemeFor

public Optional<ThemeDefinition> getThemeFor(Class<?> navigationTarget,
                                             String path)

Description copied from class: UI

Gets the ThemeDefinition associated with the given navigation target, if any. The theme is defined by using the Theme annotation on the navigation target class.

If no Theme and NoTheme annotation are used, by default the com.vaadin.flow.theme.lumo.Lumo class is used (if present on the classpath).

Overrides:

getThemeFor in class UI

Parameters:

navigationTarget - the navigation target class

path - the resolved route path so we can determine what the rendered target is for

Returns:

the associated ThemeDefinition, or empty if none is defined and the Lumo class is not in the classpath, or if the NoTheme annotation is being used.

See Also:

ThemeUtil.findThemeForNavigationTarget(UI, Class, String)

navigate

public void navigate(String location)

Description copied from class: UI

Updates this UI to show the view corresponding to the given location. The location must be a relative path without any ".." segments.

Besides the navigation to the location this method also updates the browser location (and page history).

Overrides:

navigate in class UI

Parameters:

location - the location to navigate to, not null

See Also:

UI.navigate(String, QueryParameters), Router.navigate(UI, Location, NavigationTrigger)

navigate

public void navigate(Class<? extends Component> navigationTarget)

Description copied from class: UI

Updates this UI to show the view corresponding to the given navigation target.

Besides the navigation to the location this method also updates the browser location (and page history).

Overrides:

navigate in class UI

Parameters:

navigationTarget - navigation target to navigate to

navigate

public <T,C extends Component & HasUrlParameter<T>> void navigate(Class<? extends C> navigationTarget,
                                                                  T parameter)

Description copied from class: UI

Updates this UI to show the view corresponding to the given navigation target with the specified parameter. The parameter needs to be the same as defined in the route target HasUrlParameter.

Besides the navigation to the location this method also updates the browser location (and page history).

Note! A null parameter will be handled the same as navigate(navigationTarget) and will throw an exception if HasUrlParameter is not @OptionalParameter or @WildcardParameter.

Overrides:

navigate in class UI

Type Parameters:

T - url parameter type

C - navigation target type

Parameters:

navigationTarget - navigation target to navigate to

parameter - parameter to pass to view

navigate

public void navigate(String location,
                     QueryParameters queryParameters)

Description copied from class: UI

Updates this UI to show the view corresponding to the given location and query parameters. The location must be a relative path without any ".." segments.

Besides the navigation to the location this method also updates the browser location (and page history).

Overrides:

navigate in class UI

Parameters:

location - the location to navigate to, not null

queryParameters - query parameters that are used for navigation, not null

See Also:

UI.navigate(String), Router.navigate(UI, Location, NavigationTrigger)