Uses of Interface
com.vaadin.flow.shared.Registration

Packages that use Registration

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.internal
com.vaadin.flow.component.page
com.vaadin.flow.dom
com.vaadin.flow.dom.impl
com.vaadin.flow.internal
com.vaadin.flow.internal.nodefeature
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.streams
com.vaadin.flow.shared

Uses of Registration in com.vaadin.flow.component

Classes in com.vaadin.flow.component that implement Registration

Modifier and Type	Class	Description
class	ShortcutRegistration	A registration object for both configuring and removing the registered keyboard shortcut.

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

Modifier and Type	Method	Description
Registration	UI.addAfterNavigationListener(AfterNavigationListener listener)	Add a listener that will be informed when new components have been attached and all navigation tasks have resolved.
default Registration	AttachNotifier.addAttachListener(ComponentEventListener<AttachEvent> listener)	Adds a attach listener to this component.
Registration	UI.addBeforeEnterListener(BeforeEnterListener listener)	Add a listener that will be informed when a new set of components are going to be attached.
Registration	UI.addBeforeLeaveListener(BeforeLeaveListener listener)	Add a listener that will be informed when old components are detached.
default Registration	BlurNotifier.addBlurListener(ComponentEventListener<BlurNotifier.BlurEvent<T>> listener)	Add a listener to blur DOM events.
default Registration	ClickNotifier.addClickListener(ComponentEventListener<ClickEvent<T>> listener)	Adds a click listener to this component.
default Registration	CompositionNotifier.addCompositionEndListener(ComponentEventListener<CompositionEndEvent> listener)	Adds a compositionend listener to this component.
default Registration	CompositionNotifier.addCompositionStartListener(ComponentEventListener<CompositionStartEvent> listener)	Adds a compositionstart listener to this component.
default Registration	CompositionNotifier.addCompositionUpdateListener(ComponentEventListener<CompositionUpdateEvent> listener)	Adds a compositionupdate listener to this component.
default Registration	DetachNotifier.addDetachListener(ComponentEventListener<DetachEvent> listener)	Adds a detach listener to this component.
default Registration	ClickNotifier.addDoubleClickListener(ComponentEventListener<ClickEvent<T>> listener)	Adds a double click listener to this component.
default Registration	FocusNotifier.addFocusListener(ComponentEventListener<FocusNotifier.FocusEvent<T>> listener)	Add a listener to focus DOM events.
Registration	UI.addHeartbeatListener(HeartbeatListener listener)	Add a listener that will be informed when this UI received a heartbeat from the client-side.
default Registration	InputNotifier.addInputListener(ComponentEventListener<InputEvent> listener)	Adds an input listener to this component.
default Registration	KeyNotifier.addKeyDownListener(ComponentEventListener<KeyDownEvent> listener)	Adds a keydown listener to this component.
default Registration	KeyNotifier.addKeyDownListener(Key key, ComponentEventListener<KeyDownEvent> listener, KeyModifier... modifiers)	Adds a keydown listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
default Registration	KeyNotifier.addKeyPressListener(ComponentEventListener<KeyPressEvent> listener)	Adds a keypress listener to this component.
default Registration	KeyNotifier.addKeyPressListener(Key key, ComponentEventListener<KeyPressEvent> listener, KeyModifier... modifiers)	Adds a keypress listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
default Registration	KeyNotifier.addKeyUpListener(ComponentEventListener<KeyUpEvent> listener)	Adds a keyup listener to this component.
default Registration	KeyNotifier.addKeyUpListener(Key key, ComponentEventListener<KeyUpEvent> listener, KeyModifier... modifiers)	Adds a keyup listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
protected <T extends ComponentEvent<?>> Registration	Component.addListener(Class<T> eventType, ComponentEventListener<T> listener)	Adds a listener for an event of the given type.
<T extends ComponentEvent<?>> Registration	ComponentEventBus.addListener(Class<T> eventType, ComponentEventListener<T> listener)	Adds a listener for the given event type.
<T extends ComponentEvent<?>> Registration	ComponentEventBus.addListener(Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer)	Adds a listener for the given event type, and customizes the corresponding DOM event listener with the given consumer.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener)	Adds a listener for an event of the given type to the component.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer)	Adds a listener for an event of the given type to the component, and customizes the corresponding DOM event listener with the given consumer.
default Registration	PollNotifier.addPollListener(ComponentEventListener<PollEvent> listener)	Add a poll listener.
default Registration	ClickNotifier.addSingleClickListener(ComponentEventListener<ClickEvent<T>> listener)	Adds a single click listener to this component.
Registration	AbstractCompositeField.addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<S,T>> listener)
Registration	AbstractField.addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C,T>> listener)
Registration	HasValue.addValueChangeListener(HasValue.ValueChangeListener<? super E> listener)	Adds a value change listener.
static <C extends Component, T> Registration	ComponentEffect.bind(C owner, com.vaadin.signals.Signal<T> signal, SerializableBiConsumer<C,T> setter)	Binds a signal's value to a given owner component in a way defined in setter function and creates a Signal effect function executing the setter whenever the signal value changes.
static <C extends Component> Registration	ComponentEffect.effect(C owner, Runnable effectFunction)	Creates a Signal effect that is owned by a given component.
static Registration	Shortcuts.setShortcutListenOnElement(String elementLocatorJs, Component listenOnComponent)	Setup an element, that is only accessible on the browser (not server side), to listen for shortcut events on and delegate to the given component.

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

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

Modifier and Type	Method	Description
Registration	UIInternals.addAfterNavigationListener(AfterNavigationListener listener)	Add a listener that will be informed when new components have been attached and all navigation tasks have resolved.
Registration	UIInternals.addBeforeEnterListener(BeforeEnterListener listener)	Add a listener that will be informed when a new set of components are going to be attached.
Registration	UIInternals.addBeforeLeaveListener(BeforeLeaveListener listener)	Add a listener that will be informed when old components are detached.
Registration	UIInternals.addHeartbeatListener(HeartbeatListener listener)
Registration	AbstractFieldSupport.addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C,T>> listener)	Delegate method for HasValue.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

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

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

Modifier and Type	Method	Description
Registration	Page.addBrowserWindowResizeListener(BrowserWindowResizeListener resizeListener)	Adds a new BrowserWindowResizeListener to this UI.
Registration	Page.addStyleSheet(String url)	Adds the given style sheet to the page and ensures that it is loaded successfully.
Registration	Page.addStyleSheet(String url, LoadMode loadMode)	Adds the given style sheet to the page and ensures that it is loaded successfully.

Uses of Registration in com.vaadin.flow.dom

Subinterfaces of Registration in com.vaadin.flow.dom

Modifier and Type	Interface	Description
interface	DomListenerRegistration	A registration for configuring or removing a DOM event listener added to an element.

Methods in com.vaadin.flow.dom that return Registration

Modifier and Type	Method	Description
Registration	Element.addAttachListener(ElementAttachListener attachListener)	Adds an attach listener for this element.
Registration	Element.addDetachListener(ElementDetachListener detachListener)	Adds a detach listener for this element.
Registration	Element.addPropertyChangeListener(String name, PropertyChangeListener listener)	Adds a property change listener which is triggered when the property's value is updated on the server side.
Registration	ElementStateProvider.addPropertyChangeListener(StateNode node, String name, PropertyChangeListener listener)	Adds a property change listener.

Uses of Registration in com.vaadin.flow.dom.impl

Methods in com.vaadin.flow.dom.impl that return Registration

Modifier and Type	Method	Description
Registration	AbstractTextElementStateProvider.addPropertyChangeListener(StateNode node, String name, PropertyChangeListener listener)
Registration	BasicElementStateProvider.addPropertyChangeListener(StateNode node, String name, PropertyChangeListener listener)
Registration	ShadowRootStateProvider.addPropertyChangeListener(StateNode node, String name, PropertyChangeListener listener)

Uses of Registration in com.vaadin.flow.internal

Subinterfaces of Registration in com.vaadin.flow.internal

Modifier and Type	Interface	Description
static interface	StateTree.ExecutionRegistration	A registration object for removing a task registered for execution before the client response.

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

Modifier and Type	Method	Description
Registration	StateNode.addAttachListener(Command attachListener)	Adds a command as an attach listener.
static Registration	ReflectionCache.addClearAllAction(Runnable action)	Adds an action that will be run when all reflection caches are cleared.
Registration	StateNode.addDetachListener(Command detachListener)	Adds a command as a detach listener.

Uses of Registration in com.vaadin.flow.internal.nodefeature

Subinterfaces of Registration in com.vaadin.flow.internal.nodefeature

Modifier and Type	Interface	Description
interface	ReturnChannelRegistration	A registration for a return channel.

Methods in com.vaadin.flow.internal.nodefeature that return Registration

Modifier and Type	Method	Description
Registration	PolymerEventListenerMap.add(String methodName, String[] eventDataExpressions)	Adds a listener for a event created from a template method.
Registration	ElementPropertyMap.addPropertyChangeListener(String name, PropertyChangeListener listener)	Adds a property change listener.

Uses of Registration in com.vaadin.flow.router

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

Modifier and Type	Method	Description
Registration	RouteConfiguration.addRoutesChangeListener(RoutesChangedListener listener)	Add a listener that is notified when routes change for the registry.

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

Methods in com.vaadin.flow.router.internal that return Registration

Modifier and Type	Method	Description
Registration	AbstractRouteRegistry.addRoutesChangeListener(RoutesChangedListener listener)

Uses of Registration in com.vaadin.flow.server

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

Modifier and Type	Method	Description
Registration	RouteRegistry.addRoutesChangeListener(RoutesChangedListener listener)	Adds the given route change listener to the registry.
Registration	SessionRouteRegistry.addRoutesChangeListener(RoutesChangedListener listener)	Adds the given route change listener to the registry.
Registration	VaadinService.addServiceDestroyListener(ServiceDestroyListener listener)	Adds a service destroy listener that gets notified when this service is destroyed.
Registration	VaadinService.addSessionDestroyListener(SessionDestroyListener listener)	Adds a listener that gets notified when a Vaadin service session that has been initialized for this service is destroyed.
Registration	VaadinSession.addSessionDestroyListener(SessionDestroyListener listener)	Adds a listener that gets notified when this session is destroyed.
Registration	VaadinService.addSessionInitListener(SessionInitListener listener)	Adds a listener that gets notified when a new Vaadin service session is initialized for this service.
Registration	VaadinService.addUIInitListener(UIInitListener listener)	Adds a listener that gets notified when a new UI has been initialized.

Uses of Registration in com.vaadin.flow.server.streams

Methods in com.vaadin.flow.server.streams that return Registration

Modifier and Type	Method	Description
protected Registration	TransferProgressAwareHandler.addTransferProgressListener(TransferProgressListener listener)	Adds a listener to be notified of data transfer progress events, such as: TransferProgressListener.onStart(TransferContext) TransferProgressListener.onProgress(TransferContext, long, long) TransferProgressListener.onError(TransferContext, IOException) TransferProgressListener.onComplete(TransferContext, long)

Uses of Registration in com.vaadin.flow.shared

Methods in com.vaadin.flow.shared that return Registration

Modifier and Type	Method	Description
static <T> Registration	Registration.addAndRemove(Collection<T> collection, T item)	Creates a registration by adding an item to a collection immediately and removing the item from the collection when the registration is removed.
static Registration	Registration.combine(Registration... registrations)	Creates a registration that will remove multiple registrations.
static Registration	Registration.once(Command command)	Creates a registration that will run a command only once.

Methods in com.vaadin.flow.shared with parameters of type Registration

Modifier and Type	Method	Description
static Registration	Registration.combine(Registration... registrations)	Creates a registration that will remove multiple registrations.