com.vaadin.event

Interface UIEvents.PollNotifier

All Superinterfaces:

Serializable

All Known Implementing Classes:

LegacyWindow, UI

Enclosing interface:

UIEvents

public static interface UIEvents.PollNotifier
extends Serializable

The interface for adding and removing UIEvents.PollEvent listeners.

By implementing this interface, a class publicly announces that it is able to send PollEvents whenever the client sends a periodic poll message to the client, to check for asynchronous server-side modifications.

Since:

7.2

See Also:

UI.setPollInterval(int)

Method Summary

Modifier and Type	Method and Description
Registration	addPollListener(UIEvents.PollListener listener) Add a poll listener.
void	removePollListener(UIEvents.PollListener listener) Deprecated. As of 8.0, replaced by Registration.remove() in the registration object returned from #addPollListener(PollListener).

Method Detail

addPollListener

Registration addPollListener(UIEvents.PollListener listener)

Add a poll listener.

The listener is called whenever the client polls the server for asynchronous UI updates.

Parameters:

listener - the UIEvents.PollListener to add, not null

Returns:

a registration object for removing the listener

Since:

8.0

See Also:

UI.setPollInterval(int), #removePollListener(PollListener), Registration

removePollListener

@Deprecated
void removePollListener(UIEvents.PollListener listener)

Deprecated. As of 8.0, replaced by Registration.remove() in the registration object returned from #addPollListener(PollListener).

Remove a poll listener.

Parameters:

listener - the listener to be removed

See Also:

#addPollListener(PollListener)