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.
com.vaadin.flow.component.internal.
Class JavaScriptBootstrapUI
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.UI
-
- com.vaadin.flow.component.internal.JavaScriptBootstrapUI
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasComponents,HasElement,HasEnabled,PollNotifier,RouterLayout,Serializablepublic class JavaScriptBootstrapUI extends UICustom UI for
JavaScriptBootstrapHandler. This class is intended for internal use in client side bootstrapping.For internal use only. May be renamed or removed in a future release.
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classJavaScriptBootstrapUI.ClientViewPlaceholderPlaceholder view when navigating from server-side views to client-side views.
-
Field Summary
Fields Modifier and Type Field Description static StringSERVER_ROUTING
-
Constructor Summary
Constructors Constructor Description JavaScriptBootstrapUI()Create UI for client side bootstrapping.
-
Method Summary
All Methods Modifier and Type Method Description voidconnectClient(String clientElementTag, String clientElementId, String flowRoute, String appShellTitle, elemental.json.JsonValue historyState)Connect a client with the server side UI.
Stream<Component>getChildren()Gets the child components of this component.
StringgetForwardToClientUrl()Gets the new forward url.
voidleaveNavigation(String route)Check that the view can be leave.
voidnavigate(String pathname, 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, addHeartbeatListener, addModal, addShortcutListener, addShortcutListener, addToModalComponent, beforeClientResponse, close, doInit, getActiveDragSourceComponent, getCsrfToken, getCurrent, getElement, getInternals, getLoadingIndicatorConfiguration, getLocale, getNavigationListeners, getPage, getPollInterval, getPushConfiguration, getReconnectDialogConfiguration, getRouter, getSession, getUI, getUIId, hasModalComponent, init, isClosing, isNavigationSupported, navigate, navigate, navigate, navigate, onAttach, onDetach, push, setChildComponentModal, setCurrent, setDirection, setLocale, setPollInterval
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getEventBus, getId, getParent, getTranslation, getTranslation, getTranslation, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, scrollIntoView, 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.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
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.component.PollNotifier
addPollListener
-
Methods inherited from interface com.vaadin.flow.router.RouterLayout
removeRouterLayoutContent, showRouterLayoutContent
-
-
-
-
Field Detail
-
SERVER_ROUTING
public static final String SERVER_ROUTINGSee Also:
-
-
Method Detail
-
getChildren
public Stream<Component> getChildren()Description copied from class:
ComponentGets the child components of this component.
The default implementation finds child components by traversing each child
Elementtree.If the component is injected to a PolymerTemplate using the
@Idannotation the getChildren method will only return children added from the server side and will not return any children declared in the template file.Overrides:
getChildrenin classComponentReturns:
the child components of this component
See Also:
-
getForwardToClientUrl
public String getForwardToClientUrl()Gets the new forward url.
Returns:
the new forward url
-
connectClient
@ClientCallable public void connectClient(String clientElementTag, String clientElementId, String flowRoute, String appShellTitle, elemental.json.JsonValue historyState)Connect a client with the server side UI. This method is invoked each time client router navigates to a server route.
Parameters:
clientElementTag- client side element tagclientElementId- client side element idflowRoute- flow route that should be attached to the client elementappShellTitle- client side title of the application shellhistoryState- client side history state value
-
leaveNavigation
@ClientCallable public void leaveNavigation(String route)Check that the view can be leave. This method is invoked when the client router tries to navigate to a client route while the current route is a server route. This is only called when client route navigates from a server to a client view.
Parameters:
route- the route that is navigating to.
-
navigate
public void navigate(String pathname, QueryParameters queryParameters)Description copied from class:
UIUpdates 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
locationthis method also updates the browser location (and page history).Overrides:
Parameters:
pathname- the location to navigate to, notnullqueryParameters- query parameters that are used for navigation, notnullSee Also:
UI.navigate(String),Router.navigate(UI, Location, NavigationTrigger)
-
-