com.whitestein.lsps.vaadin.ui

Class UIEventQueue

java.lang.Object

com.whitestein.lsps.vaadin.ui.UIEventQueue

All Implemented Interfaces:

Serializable

public class UIEventQueue
extends Object
implements Serializable

Helper class responsible for the event queue for UIScreen.

Author:

mhi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UIEventQueue()

Method Summary

Modifier and Type	Method and Description
void	addEventToQueue(UIEvent uiEvent, UIListener uiListener) Adds an event to the event queue.
protected void	failNoInstances(Variant.RecordVariant executionContext, UIListener uiListener) By default LSPS rejects to silently not execute a listener if there are no instances of the 'execution context' components.
ComponentsToProcess	getComponentsToProcess(UIEvent triggeringEvent) Returns the definitions of the components for which value change events should be processed.
Map<UIEventQueueEntry,Set<RecordHolder>>	processEventQueue(ComponentsToProcess componentsToProcess, LspsFormConnector.ValidationErrors validationErrors) Processes the queued events.
void	removeAllActionEvents(boolean keepActionsWhichExecuteEvenWhenInvalidComponents) Removes all action and application events.
void	removeAllEvents() Removes all events.
void	removeInvalidPendingChangeEvents(Set<UIComponent> refreshedComponents) Removes all pending change events for the refreshed and hidden components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIEventQueue

public UIEventQueue()

Method Detail

addEventToQueue

public void addEventToQueue(UIEvent uiEvent,
                            UIListener uiListener)

Adds an event to the event queue.

Parameters:

uiEvent - not null.

uiListener - not null.

failNoInstances

protected void failNoInstances(Variant.RecordVariant executionContext,
                               UIListener uiListener)

By default LSPS rejects to silently not execute a listener if there are no instances of the 'execution context' components. This fixes https://experjira.whitestein.com/browse/LSPS-7355.

For backward compatibility with PM1 however, this has been made overridable.

Parameters:

executionContext - execution context of the listener, not null.

uiListener - the listener itself, not null.

getComponentsToProcess

public ComponentsToProcess getComponentsToProcess(UIEvent triggeringEvent)

Returns the definitions of the components for which value change events should be processed. If null is returned, all components should be processed.

Parameters:

triggeringEvent - the event which triggered the event processing, may be null.

Returns:

set of components to process or null

processEventQueue

public Map<UIEventQueueEntry,Set<RecordHolder>> processEventQueue(ComponentsToProcess componentsToProcess,
                                                                  LspsFormConnector.ValidationErrors validationErrors)

Processes the queued events.

Parameters:

componentsToProcess -

validationErrors - gradually filled with validation errors. Not null, modified by this method.

Returns:

processed queue entries, mapped to a set of ui::Action subtypes which defines actions to be taken.

removeAllEvents

public void removeAllEvents()

Removes all events.

removeAllActionEvents

public void removeAllActionEvents(boolean keepActionsWhichExecuteEvenWhenInvalidComponents)

Removes all action and application events.

removeInvalidPendingChangeEvents

public void removeInvalidPendingChangeEvents(Set<UIComponent> refreshedComponents)

Removes all pending change events for the refreshed and hidden components.

Parameters:

refreshedComponents - remove value change events for these components. Not null, may be empty.