com.vaadin.flow.component.ComponentEvent API 24.7.0.alpha6 | Vaadin

com.vaadin.flow.component.

java.lang.Object

java.util.EventObject

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

Type Parameters:

T - the event source type

All Implemented Interfaces:

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, ClientItemToggleEvent, CollapseEvent, ColumnReorderEvent, ColumnResizeEvent, ComboBoxBase.CustomValueSetEvent, CompositionEvent, ConfirmDialog.CancelEvent, ConfirmDialog.ConfirmEvent, ConfirmDialog.RejectEvent, ContextMenuBase.OpenedChangeEvent, Crud.CancelEvent, Crud.DeleteEvent, Crud.EditEvent, Crud.NewEvent, Crud.SaveEvent, CrudI18nUpdatedEvent, DashboardItemMovedEvent, DashboardItemMoveModeChangedEvent, DashboardItemRemovedEvent, DashboardItemResizedEvent, DashboardItemResizeModeChangedEvent, DashboardItemSelectedChangedEvent, DatePicker.InvalidChangeEvent, DatePicker.OpenedChangeEvent, Details.OpenedChangeEvent, Dialog.DialogCloseActionEvent, Dialog.DialogDraggedEvent, Dialog.DialogResizeEvent, Dialog.OpenedChangeEvent, DragEndEvent, DragStartEvent, DrilldownEvent, DropEvent, ExpandEvent, FileRejectedEvent, FileRemovedEvent, FinishedEvent, FocusNotifier.FocusEvent, GridContextMenu.GridContextMenuItemClickEvent, GridDragEndEvent, GridDragStartEvent, GridDropEvent, GridPro.CellEditStartedEvent, GridPro.ItemPropertyChangedEvent, HasClientValidation.ClientValidatedEvent, IdentifierProviderChangeEvent, InputEvent, ItemCountChangeEvent, KeyboardEvent, MapClickEvent, MapFeatureClickEvent, MapFeatureDropEvent, MapViewMoveEndEvent, MessageInput.SubmitEvent, NativeDetails.ToggleEvent, Notification.OpenedChangeEvent, PointClickEvent, PointDragEvent, PointDragStartEvent, PointDropEvent, PointLegendItemClickEvent, PointMouseOutEvent, PointMouseOverEvent, PointRemoveEvent, PointSelectEvent, PointUnselectEvent, PointUpdateEvent, PollEvent, Popover.OpenedChangeEvent, ProgressUpdateEvent, Select.InvalidChangeEvent, Select.OpenedChangeEvent, SeriesAfterAnimateEvent, SeriesCheckboxClickEvent, SeriesClickEvent, SeriesHideEvent, SeriesLegendItemClickEvent, SeriesMouseOutEvent, SeriesMouseOverEvent, SeriesShowEvent, SortEvent, SplitLayout.SplitterDragendEvent, StartedEvent, Tabs.SelectedChangeEvent, TabSheet.SelectedChangeEvent, TimePicker.InvalidChangeEvent, UI.BrowserLeaveNavigationEvent, UI.BrowserNavigateEvent, UI.BrowserRefreshEvent, 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 Details
- 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 Details
- 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.