com.whitestein.lsps.vaadin.util

Class LspsUIBase

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractSingleComponentContainer

com.vaadin.ui.UI

com.whitestein.lsps.vaadin.util.LspsUIBase

All Implemented Interfaces:

com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.UIEvents.PollNotifier, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, Serializable, Iterable<com.vaadin.ui.Component>, EventListener

public abstract class LspsUIBase
extends com.vaadin.ui.UI

An ui implementation which does not perform navigation right away. It stores navigate-to viewId in a field until afterRequestHandling() method is called. The navigation itself must happen only after the database transaction is committed - this is so that new https request generated by the navigation can open new transaction and see all data modifications performed by this one. (LSPS-8988 and subsequent LSPS-9005)

Author:

mna

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Field Summary

Fields inherited from class com.vaadin.ui.UI

actionManager

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
LspsUIBase()

Method Summary

Modifier and Type	Method and Description
void	afterRequestHandling() Perform all the logic needed to happen after request was handled and before response json was created.
protected void	closeTransactionAndNavigate() Commit (close) database transaction and then navigate away.
abstract void	error(Throwable error) Handle error.
LspsAppConnector	getAppConnector() Returns the LSPS connector object.
protected void	handleErrors()
protected void	handleNotifications()
void	navigateTo(String viewId) Opens a view for the given viewId.
void	postponeErrorHandling(Throwable throwable) Error handling in case we want to notify the user or log the error, but we can't throw it right away.
void	postponeNotification(com.vaadin.ui.Notification notification) Postpone the notification till the end of request.
protected void	setAppConnector(LspsAppConnector appConnector)

Methods inherited from class com.vaadin.ui.UI

access, accessSynchronously, addAction, addActionHandler, addClickListener, addListener, addPollListener, addWindow, attach, changeVariables, close, detach, doInit, doRefresh, focus, getActionManager, getComponentCount, getConnectorTracker, getCurrent, getEmbedId, getLastHeartbeatTimestamp, getLastProcessedClientToServerId, getLoadingIndicatorConfiguration, getLocaleService, getNavigator, getNotificationConfiguration, getOverlayContainerLabel, getPage, getPollInterval, getPushConfiguration, getPushConnection, getReconnectDialogConfiguration, getScrollLeft, getScrollTop, getSession, getState, getState, getStateType, getTabIndex, getTheme, getTooltipConfiguration, getUI, getUIId, getWindows, init, isClosing, isConnectorEnabled, isResizeLazy, iterator, paintContent, push, refresh, removeAction, removeActionHandler, removeClickListener, removeListener, removePollListener, removeWindow, scrollIntoView, setCaption, setContent, setCurrent, setFocusedComponent, setLastHeartbeatTimestamp, setLastProcessedClientToServerId, setNavigator, setOverlayContainerLabel, setPollInterval, setPushConnection, setResizeLazy, setScrollLeft, setScrollTop, setSession, setTabIndex, setTheme, showNotification, showNotification, showNotification, showNotification, showNotification, showNotification

Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getContent, readDesign, readDesignChildren, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setHeight, setWidth, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, encodeState, getErrorHandler, getExtensions, getRpcManager, handleConnectorRequest, isAttached, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LspsUIBase

public LspsUIBase()

Method Detail

setAppConnector

protected void setAppConnector(LspsAppConnector appConnector)

getAppConnector

public LspsAppConnector getAppConnector()

Returns the LSPS connector object.

Returns:

LSPS connector

error

public abstract void error(Throwable error)

Handle error.

Parameters:

error - to be handled.

navigateTo

public void navigateTo(String viewId)

Opens a view for the given viewId. See Navigator.navigateTo(String). The navigation is postponed till afterRequestHandling() is called. This method only stores the target view id in a field.

Parameters:

viewId -

postponeErrorHandling

public void postponeErrorHandling(Throwable throwable)

Error handling in case we want to notify the user or log the error, but we can't throw it right away. The error will be stored in the lsps UI and handled right before next uidl json is created. E.g., in most common cases (button clicks and other rpc calls) the error will be handled by the end of this request. Important: if the error was thrown from paint method (which is called during the time json response is formed), the error appears only after *next* request. This may mean that it will appear only after next random click on page.

Parameters:

throwable -

postponeNotification

public void postponeNotification(com.vaadin.ui.Notification notification)

Postpone the notification till the end of request. If the json response was already written or is being written, the notification will appear after next request. Depending on circumstances, that may mean that it wont appear until user clicks on the page, button etc.

Parameters:

notification -

closeTransactionAndNavigate

protected void closeTransactionAndNavigate()

Commit (close) database transaction and then navigate away. This must be called by the end of the request handling, but before the response json was created and sent: * transaction needs to be closed before navigation as explained above (LSPS-8988) * transaction can not be closed mid request - lsps interpreter and debugger store data in current transaction * vaadin session needs to be locked while the navigation happen (else we get runtime errors) * navigation can not be happen in VaadinService.requestEnd(com.vaadin.server.VaadinRequest, com.vaadin.server.VaadinResponse, com.vaadin.server.VaadinSession), because json was created and sent already * navigation can not be happen in VaadinServletWithTransaction, because the same as above apply and ui object does not exist anymore at that point.

handleErrors

protected void handleErrors()

handleNotifications

protected void handleNotifications()

afterRequestHandling

public void afterRequestHandling()

Perform all the logic needed to happen after request was handled and before response json was created.