Skip to content

[VALIDATION] docs: document ComponentEvent.getSource as the listener component #25451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
totally-not-ai wants to merge 1 commit into from
Closed

[VALIDATION] docs: document ComponentEvent.getSource as the listener component #25451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions flow-server/src/main/java/com/vaadin/flow/component/ComponentEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ public ComponentEvent(T source, boolean fromClient, UI ui) {
this.ui = ui;
}

/**
* Returns the component on which the listener has been attached.
* <p>
* This is the component the listener was registered with, not a nested
* child where a browser event may first have occurred. For example, if a
* listener is added to a layout that contains a checkbox,
* {@code getSource()} returns the layout, not the checkbox.
*
* @return the component on which the listener has been attached
*/
@SuppressWarnings("unchecked")
@Override
public T getSource() {
Expand Down
Loading