Package com.vaadin.event

Interface LayoutEvents.LayoutClickNotifier

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbsoluteLayout, AbstractOrderedLayout, ColorPickerPreview, CssLayout, FormLayout, GridLayout, HorizontalLayout, Navigator.EmptyView, VerticalLayout

Enclosing interface:

LayoutEvents

public static interface LayoutEvents.LayoutClickNotifier
extends Serializable

The interface for adding and removing LayoutClickEvent listeners. By implementing this interface a class explicitly announces that it will generate a LayoutClickEvent when a component inside it is clicked and a LayoutClickListener is registered.

Note: The general Java convention is not to explicitly declare that a class generates events, but to directly define the addListener and removeListener methods. That way the caller of these methods has no real way of finding out if the class really will send the events, or if it just defines the methods to be able to implement an interface.

Since:

6.5.2

See Also:

LayoutEvents.LayoutClickListener, LayoutEvents.LayoutClickEvent

Method Summary

Modifier and Type	Method	Description
void	addLayoutClickListener(LayoutEvents.LayoutClickListener listener)	Add a click listener to the layout.
void	addListener(LayoutEvents.LayoutClickListener listener)	Deprecated. As of 7.0, replaced by addLayoutClickListener(LayoutClickListener)
void	removeLayoutClickListener(LayoutEvents.LayoutClickListener listener)	Removes an LayoutClickListener.
void	removeListener(LayoutEvents.LayoutClickListener listener)	Deprecated. As of 7.0, replaced by removeLayoutClickListener(LayoutClickListener)

Method Detail

addLayoutClickListener

void addLayoutClickListener(LayoutEvents.LayoutClickListener listener)

Add a click listener to the layout. The listener is called whenever the user clicks inside the layout. An event is also triggered when the click targets a component inside a nested layout or Panel, provided the targeted component does not prevent the click event from propagating. A caption is not considered part of a component. The child component that was clicked is included in the LayoutEvents.LayoutClickEvent. Use removeListener(LayoutClickListener) to remove the listener.

Parameters:

listener - The listener to add

addListener

@Deprecated
void addListener(LayoutEvents.LayoutClickListener listener)

Deprecated.

As of 7.0, replaced by addLayoutClickListener(LayoutClickListener)

removeLayoutClickListener

void removeLayoutClickListener(LayoutEvents.LayoutClickListener listener)

Removes an LayoutClickListener.

Parameters:

listener - LayoutClickListener to be removed

removeListener

@Deprecated
void removeListener(LayoutEvents.LayoutClickListener listener)

Deprecated.

As of 7.0, replaced by removeLayoutClickListener(LayoutClickListener)