com.vaadin.flow.component

Interface ClickNotifier<T extends Component>

Type Parameters:

T - the type of the component returned at the ComponentEvent.getSource()

All Superinterfaces:

Serializable

All Known Implementing Classes:

Article, Aside, Button, Checkbox, ContextMenu, ContextMenuBase, DescriptionList, DescriptionList.Description, DescriptionList.Term, Div, DrawerToggle, Emphasis, FlexLayout, Footer, FormLayout, FormLayout.FormItem, GeneratedVaadinButton, GeneratedVaadinCheckbox, GeneratedVaadinContextMenu, GeneratedVaadinFormItem, GeneratedVaadinRadioButton, GeneratedVaadinSplitLayout, GridContextMenu, H1, H2, H3, H4, H5, H6, Header, HorizontalLayout, Icon, Image, IronIcon, ListItem, Main, MenuItem, NativeButton, Nav, OrderedList, Paragraph, Pre, Section, Span, SplitLayout, UnorderedList, VerticalLayout

public interface ClickNotifier<T extends Component>
extends Serializable

Mixin interface for components that support adding click listeners to the their root elements.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
default Registration	addClickListener(ComponentEventListener<ClickEvent<T>> listener) Adds a click listener to this component.
default ShortcutRegistration	addClickShortcut(Key key, KeyModifier... keyModifiers) Adds a shortcut which 'clicks' the Component which implements ClickNotifier interface.

Method Detail

addClickListener

default Registration addClickListener(ComponentEventListener<ClickEvent<T>> listener)

Adds a click listener to this component.

Parameters:

listener - the listener to add, not null

Returns:

a handle that can be used for removing the listener

addClickShortcut

default ShortcutRegistration addClickShortcut(Key key,
                                              KeyModifier... keyModifiers)

Adds a shortcut which 'clicks' the Component which implements ClickNotifier interface. The shortcut's event listener is in global scope and the shortcut's lifecycle is tied to this component.

Use the returned ShortcutRegistration to fluently configure the shortcut.

By default, the returned ShortcutRegistration allows browser's default behavior, unlike other ShortcutRegistrations. This is used to make sure that value synchronization of input fields is not blocked for the shortcut key (e.g. Enter key). To change this behavior, call ShortcutRegistration.setBrowserDefaultAllowed(boolean).

Parameters:

key - primary Key used to trigger the shortcut. Cannot be null.

keyModifiers - KeyModifiers that need to be pressed along with the key for the shortcut to trigger

Returns:

ShortcutRegistration for configuring the shortcut and removing