com.vaadin.flow.component

Class CompositionStartEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Component>

com.vaadin.flow.component.internal.CompositionEvent

com.vaadin.flow.component.CompositionStartEvent

All Implemented Interfaces:

Serializable

@DomEvent(value="compositionstart")
public class CompositionStartEvent
extends CompositionEvent

The event when a composition is started.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
CompositionStartEvent(Component source) Creates a new server-side composition event with no additional information.
CompositionStartEvent(Component source, boolean fromClient, String data, String locale) Creates a new composition event.

Method Summary

Methods inherited from class com.vaadin.flow.component.internal.CompositionEvent

getData, getLocale

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

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositionStartEvent

public CompositionStartEvent(Component source,
                             boolean fromClient,
                             @EventData(value="event.data")
                             String data,
                             @EventData(value="event.locale")
                             String locale)

Creates a new composition event.

Parameters:

source - the component that fired the event

fromClient - true if the event was originally fired on the client, false if the event originates from server-side logic

data - the string being composed

locale - language code for the composition event, if available; otherwise, the empty string

CompositionStartEvent

public CompositionStartEvent(Component source)

Creates a new server-side composition event with no additional information.

Parameters:

source - the component that fired the event