com.vaadin.flow.component.CompositionNotifier API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractNumberField, BigDecimalField, EmailField, IntegerField, 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

All Methods
Modifier and Type	Method	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