com.vaadin.flow.component

Interface CompositionNotifier

All Superinterfaces:

Serializable

All Known Implementing Classes:

EmailField, NumberField, PasswordField, RichTextEditor, TextArea, TextField

public interface CompositionNotifier
extends Serializable

Mixin interface for components that support adding composition listeners to the their root elements. See CompositionEvent

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
default Registration	addCompositionEndListener(ComponentEventListener<CompositionEndEvent> listener) Adds a compositionend listener to this component.
default Registration	addCompositionStartListener(ComponentEventListener<CompositionStartEvent> listener) Adds a compositionstart listener to this component.
default Registration	addCompositionUpdateListener(ComponentEventListener<CompositionUpdateEvent> listener) Adds a compositionupdate listener to this component.

Method Detail

addCompositionStartListener

default Registration addCompositionStartListener(ComponentEventListener<CompositionStartEvent> listener)

Adds a compositionstart listener to this component.

Parameters:

listener - the listener to add, not null

Returns:

a handle that can be used for removing the listener

addCompositionUpdateListener

default Registration addCompositionUpdateListener(ComponentEventListener<CompositionUpdateEvent> listener)

Adds a compositionupdate listener to this component.

Parameters:

listener - the listener to add, not null

Returns:

a handle that can be used for removing the listener

addCompositionEndListener

default Registration addCompositionEndListener(ComponentEventListener<CompositionEndEvent> listener)

Adds a compositionend listener to this component.

Parameters:

listener - the listener to add, not null

Returns:

a handle that can be used for removing the listener