Package com.vaadin.flow.component

Class ComponentEvent<T extends Component>

java.lang.Object

java.util.EventObject

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

Type Parameters:

T - the event source type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractAttachDetachEvent, AbstractField.ComponentValueChangeEvent, AbstractLogin.ForgotPasswordEvent, AbstractLogin.LoginEvent, Accordion.OpenedChangeEvent, AllFinishedEvent, BlurNotifier.BlurEvent, CellFocusEvent, ChartAddSeriesEvent, ChartAfterPrintEvent, ChartBeforePrintEvent, ChartClickEvent, ChartDrillupAllEvent, ChartDrillupEvent, ChartLoadEvent, ChartRedrawEvent, ChartSelectionEvent, ClickEvent, CollapseEvent, ColumnReorderEvent, ColumnResizeEvent, CompositionEvent, ConfirmDialog.CancelEvent, ConfirmDialog.ConfirmEvent, ConfirmDialog.RejectEvent, Crud.CancelEvent, Crud.DeleteEvent, Crud.EditEvent, Crud.NewEvent, Crud.SaveEvent, CrudI18nUpdatedEvent, Details.OpenedChangeEvent, Dialog.DialogCloseActionEvent, Dialog.DialogResizeEvent, DragEndEvent, DragStartEvent, DrilldownEvent, DropEvent, ExpandEvent, FileRejectedEvent, FinishedEvent, FocusNotifier.FocusEvent, GeneratedVaadinCheckbox.ChangeEvent, GeneratedVaadinCheckbox.CheckedChangeEvent, GeneratedVaadinCheckbox.IndeterminateChangeEvent, GeneratedVaadinCheckboxGroup.InvalidChangeEvent, GeneratedVaadinComboBox.CustomValueSetEvent, GeneratedVaadinComboBox.FilterChangeEvent, GeneratedVaadinComboBox.InvalidChangeEvent, GeneratedVaadinComboBox.OpenedChangeEvent, GeneratedVaadinComboBox.SelectedItemChangeEvent, GeneratedVaadinContextMenu.OpenedChangeEvent, GeneratedVaadinDatePicker.ChangeEvent, GeneratedVaadinDatePicker.InvalidChangeEvent, GeneratedVaadinDatePicker.OpenedChangeEvent, GeneratedVaadinDialog.OpenedChangeEvent, GeneratedVaadinNotification.OpenedChangeEvent, GeneratedVaadinRadioButton.CheckedChangeEvent, GeneratedVaadinRadioGroup.InvalidChangeEvent, GeneratedVaadinRichTextEditor.ChangeEvent, GeneratedVaadinSelect.InvalidChangeEvent, GeneratedVaadinSelect.OpenedChangeEvent, GeneratedVaadinSplitLayout.IronResizeEvent, GeneratedVaadinSplitLayout.SplitterDragendEvent, GeneratedVaadinTextArea.ChangeEvent, GeneratedVaadinTextArea.InvalidChangeEvent, GeneratedVaadinTextField.ChangeEvent, GeneratedVaadinTextField.InvalidChangeEvent, GeneratedVaadinTimePicker.InvalidChangeEvent, GeneratedVaadinUpload.FileRejectEvent, GeneratedVaadinUpload.FilesChangeEvent, GeneratedVaadinUpload.MaxFilesReachedChangeEvent, GeneratedVaadinUpload.UploadAbortEvent, GeneratedVaadinUpload.UploadBeforeEvent, GeneratedVaadinUpload.UploadErrorEvent, GeneratedVaadinUpload.UploadProgressEvent, GeneratedVaadinUpload.UploadRequestEvent, GeneratedVaadinUpload.UploadResponseEvent, GeneratedVaadinUpload.UploadRetryEvent, GeneratedVaadinUpload.UploadStartEvent, GeneratedVaadinUpload.UploadSuccessEvent, GeneratedVaadinUploadFile.FileAbortEvent, GeneratedVaadinUploadFile.FileRemoveEvent, GeneratedVaadinUploadFile.FileRetryEvent, GeneratedVaadinUploadFile.FileStartEvent, GridContextMenu.GridContextMenuItemClickEvent, GridDragEndEvent, GridDragStartEvent, GridDropEvent, GridPro.CellEditStartedEvent, GridPro.ItemPropertyChangedEvent, HasClientValidation.ClientValidatedEvent, IdentifierProviderChangeEvent, InputEvent, ItemCountChangeEvent, KeyboardEvent, MapClickEvent, MapFeatureClickEvent, MapViewMoveEndEvent, MessageInput.SubmitEvent, NativeDetails.ToggleEvent, PointClickEvent, PointLegendItemClickEvent, PointMouseOutEvent, PointMouseOverEvent, PointRemoveEvent, PointSelectEvent, PointUnselectEvent, PointUpdateEvent, PollEvent, ProgressUpdateEvent, SeriesAfterAnimateEvent, SeriesCheckboxClickEvent, SeriesClickEvent, SeriesHideEvent, SeriesLegendItemClickEvent, SeriesMouseOutEvent, SeriesMouseOverEvent, SeriesShowEvent, SortEvent, StartedEvent, Tabs.SelectedChangeEvent, TabSheet.SelectedChangeEvent, WebComponentUI.WebComponentConnectEvent, XAxesExtremesSetEvent, YAxesExtremesSetEvent

public class ComponentEvent<T extends Component>
extends EventObject

An event whose source is a Component.

Typically used together with ComponentEventBus.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ComponentEvent(T source, boolean fromClient)	Creates a new event using the given source and indicator whether the event originated from the client side or the server side.

Method Summary

Modifier and Type	Method	Description
T	getSource()
boolean	isFromClient()	Checks if this event originated from the client side.
void	unregisterListener()	Unregisters the event listener currently being invoked.

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

ComponentEvent

public ComponentEvent(T source,
                      boolean fromClient)

Creates a new event using the given source and indicator whether the event originated from the client side or the server side.

Parameters:

source - the source component

fromClient - true if the event originated from the client side, false otherwise

Method Detail

getSource

public T getSource()

Overrides:

getSource in class EventObject

isFromClient

public boolean isFromClient()

Checks if this event originated from the client side.

Returns:

true if the event originated from the client side, false otherwise

unregisterListener

public void unregisterListener()

Unregisters the event listener currently being invoked.

This method can only be called from within an event listener. Calling it will remove the current event listener so no further events are passed to it.