com.haulmont.cuba.web

Class AppUI

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractSingleComponentContainer

com.vaadin.ui.UI

com.haulmont.cuba.web.widgets.CubaUI

com.haulmont.cuba.web.AppUI

All Implemented Interfaces:

UiExceptionHandler.UiContext, EnhancedUI, 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.SerializableEventListener, com.vaadin.event.UIEvents.PollNotifier, com.vaadin.server.ClientConnector, com.vaadin.server.ErrorHandler, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener

@Component(value="cuba_AppUI")
 @Scope(value="prototype")
public class AppUI
extends CubaUI
implements com.vaadin.server.ErrorHandler, EnhancedUI, UiExceptionHandler.UiContext

Single window / page of web application. Root component of Vaadin layout.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.web.widgets.CubaUI

CubaUI.SystemMessages

Nested classes/interfaces inherited from class com.vaadin.ui.UI

com.vaadin.ui.UI.WindowOrderUpdateEvent, com.vaadin.ui.UI.WindowOrderUpdateListener

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

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.HasContextHelp, 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

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

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected App	app
protected BeanLocator	beanLocator
protected ScreenClientProfilerAgent	clientProfiler
protected Dialogs	dialogs
protected Events	events
protected CubaFileDownloader	fileDownloader
protected Fragments	fragments
protected GlobalConfig	globalConfig
protected History	history
protected IconResolver	iconResolver
static java.lang.String	LAST_REQUEST_ACTION_ATTR
static java.lang.String	LAST_REQUEST_PARAMS_ATTR
protected Messages	messages
static java.lang.String	NAME
protected Notifications	notifications
protected boolean	performanceTestMode
protected java.util.Map<java.lang.String,java.lang.String>	profiledScreens
protected java.lang.String	profilerMarker
protected ScreenProfilerConfig	screenProfilerConfig
protected Screens	screens
protected TestIdManager	testIdManager
protected boolean	testMode
protected ThemeConstantsRepository	themeConstantsRepository
protected RootWindow	topLevelWindow
protected TrustedClientService	trustedClientService
protected UiEventsMulticaster	uiEventsMulticaster
protected UrlChangeHandler	urlChangeHandler
protected UrlRouting	urlRouting
protected UserSession	userSession
protected UserSessionService	userSessionService
protected UserSessionSource	userSessionSource
protected UserSettingsTools	userSettingsTools
protected WebBrowserTools	webBrowserTools
protected WebConfig	webConfig
protected WebJarResourceResolver	webJarResourceResolver

Fields inherited from class com.vaadin.ui.UI

actionManager

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

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
AppUI()

Method Summary

Modifier and Type	Method and Description
void	addTimer(CubaTimer timer)
protected void	autowireContext(java.lang.Object instance, org.springframework.context.ApplicationContext applicationContext)
void	beforeTopLevelWindowInit()
void	clearProfiledScreens(java.util.List<java.lang.String> profilerMarkers)
protected App	createApplication()
com.vaadin.server.Resource	createVersionedResource(java.lang.String value)
void	detach()
void	error(com.vaadin.server.ErrorEvent event)
App	getApp()
static AppUI	getCurrent()
Dialogs	getDialogs()
protected java.lang.String	getExceptionCauseMessage(java.lang.Exception exception)
CubaFileDownloader	getFileDownloader()
Fragments	getFragments()
History	getHistory()
Notifications	getNotifications()
java.lang.String	getProfiledScreen(java.lang.String profilerMarker)
java.lang.String	getProfilerMarker()
Screens	getScreens()
TestIdManager	getTestIdManager()
java.util.List<CubaTimer>	getTimers()
RootWindow	getTopLevelWindow()
protected com.vaadin.ui.AbstractComponent	getTopLevelWindowComposition()
RootWindow	getTopLevelWindowNN()
UiEventsMulticaster	getUiEventsMulticaster()
UrlChangeHandler	getUrlChangeHandler()
UrlRouting	getUrlRouting()
UserSession	getUserSession()
WebBrowserTools	getWebBrowserTools()
java.lang.String	getWebJarPath(java.lang.String webjar, java.lang.String partialPath)
WindowManager	getWindowManager() Deprecated.
void	handleRequest(com.vaadin.server.VaadinRequest request)
boolean	hasAuthenticatedSession()
protected void	init(com.vaadin.server.VaadinRequest request)
protected void	initHistoryBackControl()
protected void	initInternalComponents()
protected void	initJsLibraries() Dynamically init external JS libraries.
protected boolean	isLinkHandlerRequest(com.vaadin.server.VaadinRequest request)
boolean	isPerformanceTestMode()
boolean	isTestMode()
protected boolean	isUserSessionAlive(Connection connection)
protected void	onHistoryBackPerformed()
void	paintContent(com.vaadin.server.PaintTarget target)
protected void	processExternalLink(com.vaadin.server.VaadinRequest request, NavigationState requestedState)
protected void	processLinkHandlerRequest(com.vaadin.server.VaadinRequest request)
protected void	processRequest(NavigationState navigationState)
protected void	publishAppInitializedEvent(App app)
protected void	refresh(com.vaadin.server.VaadinRequest request)
void	removeTimer(CubaTimer timer)
protected void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
protected void	setDialogs(Dialogs dialogs)
protected void	setFragments(Fragments fragments)
void	setHistory(History history)
protected void	setNotifications(Notifications notifications)
void	setProfiledScreen(java.lang.String profilerMarker, java.lang.String screen)
void	setProfilerMarker(java.lang.String profilerMarker)
protected void	setProfilerParameters()
protected void	setScreens(Screens screens)
void	setTopLevelWindow(RootWindow window) INTERNAL.
protected void	setupUI()
void	setUrlChangeHandler(UrlChangeHandler urlChangeHandler)
void	setUrlRouting(UrlRouting urlRouting)
void	setUserSession(UserSession userSession)
protected void	setWebBrowserTools(WebBrowserTools webBrowserTools)
protected void	showCriticalExceptionMessage(java.lang.Exception exception)
java.lang.String	translateToWebPath(java.lang.String fullWebJarPath)
protected void	updateClientSystemMessages(java.util.Locale locale)
protected void	updateUiTheme()

Methods inherited from class com.haulmont.cuba.web.widgets.CubaUI

isAccessibleForUser, updateSystemMessagesLocale

Methods inherited from class com.vaadin.ui.UI

access, accessSynchronously, addAction, addActionHandler, addClickListener, addPollListener, addWindow, addWindowOrderUpdateListener, attach, changeVariables, close, doInit, doRefresh, focus, getActionManager, getActiveDragSource, getComponentCount, getConnectorTracker, getEmbedId, getLastHeartbeatTimestamp, getLastProcessedClientToServerId, getLoadingIndicatorConfiguration, getLocaleService, getNavigator, getNotificationConfiguration, getOverlayContainerLabel, getPage, getPollInterval, getPushConfiguration, getPushConnection, getReconnectDialogConfiguration, getScrollLeft, getScrollTop, getSession, getState, getState, getStateType, getTabIndex, getTheme, getTooltipConfiguration, getUI, getUIId, getUiPathInfo, getUiRootPath, getWindows, isClosing, isConnectorEnabled, isMobileHtml5DndEnabled, isResizeLazy, isUsingThoroughSizeCheck, iterator, push, removeAction, removeActionHandler, removeClickListener, removePollListener, removeWindow, scrollIntoView, setActiveDragSource, setCaption, setContent, setCurrent, setFocusedComponent, setLastHeartbeatTimestamp, setLastProcessedClientToServerId, setMobileHtml5DndEnabled, setNavigator, setOverlayContainerLabel, setPollInterval, setPushConnection, setResizeLazy, setScrollLeft, setScrollTop, setSession, setTabIndex, setTheme, setUsingThoroughSizeCheck, 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, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getCubaId, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setCubaId, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, getCaption, getCubaId, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCubaId, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, 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, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

LAST_REQUEST_ACTION_ATTR

public static final java.lang.String LAST_REQUEST_ACTION_ATTR

See Also:

Constant Field Values

LAST_REQUEST_PARAMS_ATTR

public static final java.lang.String LAST_REQUEST_PARAMS_ATTR

See Also:

Constant Field Values

app

protected App app

messages

@Inject
protected Messages messages

events

@Inject
protected Events events

globalConfig

@Inject
protected GlobalConfig globalConfig

webConfig

@Inject
protected WebConfig webConfig

userSettingsTools

@Inject
protected UserSettingsTools userSettingsTools

themeConstantsRepository

@Inject
protected ThemeConstantsRepository themeConstantsRepository

userSessionSource

@Inject
protected UserSessionSource userSessionSource

userSessionService

@Inject
protected UserSessionService userSessionService

trustedClientService

@Inject
protected TrustedClientService trustedClientService

uiEventsMulticaster

@Inject
protected UiEventsMulticaster uiEventsMulticaster

iconResolver

@Inject
protected IconResolver iconResolver

webJarResourceResolver

@Inject
protected WebJarResourceResolver webJarResourceResolver

screenProfilerConfig

@Inject
protected ScreenProfilerConfig screenProfilerConfig

beanLocator

@Inject
protected BeanLocator beanLocator

testIdManager

protected TestIdManager testIdManager

testMode

protected boolean testMode

performanceTestMode

protected boolean performanceTestMode

fileDownloader

protected CubaFileDownloader fileDownloader

clientProfiler

protected ScreenClientProfilerAgent clientProfiler

topLevelWindow

protected RootWindow topLevelWindow

fragments

protected Fragments fragments

screens

protected Screens screens

dialogs

protected Dialogs dialogs

notifications

protected Notifications notifications

webBrowserTools

protected WebBrowserTools webBrowserTools

urlChangeHandler

protected UrlChangeHandler urlChangeHandler

urlRouting

protected UrlRouting urlRouting

history

protected History history

profilerMarker

protected java.lang.String profilerMarker

profiledScreens

protected java.util.Map<java.lang.String,java.lang.String> profiledScreens

userSession

protected UserSession userSession

Constructor Detail

AppUI

public AppUI()

Method Detail

getUserSession

public UserSession getUserSession()

setUserSession

public void setUserSession(UserSession userSession)

initJsLibraries

protected void initJsLibraries()

Dynamically init external JS libraries. You should create JavaScriptExtension class and extend UI object here.

Example:

 JavaScriptExtension:

  @JavaScript("resources/jquery/jquery-1.10.2.min.js")
 public class JQueryIntegration extends AbstractJavaScriptExtension {

      @Override
     public void extend(AbstractClientConnector target) {
         super.extend(target);
     }

      @Override
     protected Class<? extends ClientConnector> getSupportedParentType() {
         return UI.class;
     }
 }

 AppUI:

 protected void initJsLibraries() {
     new JQueryIntegration().extend(this);
 }

If you want to include scripts to generated page statically see CubaBootstrapListener.

initInternalComponents

protected void initInternalComponents()

initHistoryBackControl

protected void initHistoryBackControl()

createApplication

protected App createApplication()

getWindowManager

@Deprecated
public WindowManager getWindowManager()

Deprecated.

Returns:

Use getScreens() instead.

getScreens

public Screens getScreens()

Specified by:

getScreens in interface UiExceptionHandler.UiContext

Returns:

screens manager

setScreens

protected void setScreens(Screens screens)

getDialogs

public Dialogs getDialogs()

Specified by:

getDialogs in interface UiExceptionHandler.UiContext

Returns:

dialogs API

setDialogs

protected void setDialogs(Dialogs dialogs)

getNotifications

public Notifications getNotifications()

Specified by:

getNotifications in interface UiExceptionHandler.UiContext

Returns:

notifications API

setNotifications

protected void setNotifications(Notifications notifications)

getWebBrowserTools

public WebBrowserTools getWebBrowserTools()

Specified by:

getWebBrowserTools in interface UiExceptionHandler.UiContext

Returns:

web browser API

setWebBrowserTools

protected void setWebBrowserTools(WebBrowserTools webBrowserTools)

getFragments

public Fragments getFragments()

Specified by:

getFragments in interface UiExceptionHandler.UiContext

Returns:

fragments API

setFragments

protected void setFragments(Fragments fragments)

getUrlRouting

public UrlRouting getUrlRouting()

setUrlRouting

public void setUrlRouting(UrlRouting urlRouting)

getUrlChangeHandler

public UrlChangeHandler getUrlChangeHandler()

setUrlChangeHandler

public void setUrlChangeHandler(UrlChangeHandler urlChangeHandler)

getHistory

public History getHistory()

setHistory

public void setHistory(History history)

init

protected void init(com.vaadin.server.VaadinRequest request)

Specified by:

init in class com.vaadin.ui.UI

setApplicationContext

@Inject
protected void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

autowireContext

protected void autowireContext(java.lang.Object instance,
                               org.springframework.context.ApplicationContext applicationContext)

isUserSessionAlive

protected boolean isUserSessionAlive(Connection connection)

hasAuthenticatedSession

public boolean hasAuthenticatedSession()

publishAppInitializedEvent

protected void publishAppInitializedEvent(App app)

showCriticalExceptionMessage

protected void showCriticalExceptionMessage(java.lang.Exception exception)

getExceptionCauseMessage

protected java.lang.String getExceptionCauseMessage(java.lang.Exception exception)

setupUI

protected void setupUI()
                throws LoginException

Throws:

LoginException

refresh

protected void refresh(com.vaadin.server.VaadinRequest request)

Overrides:

refresh in class com.vaadin.ui.UI

handleRequest

public void handleRequest(com.vaadin.server.VaadinRequest request)

Overrides:

handleRequest in class com.vaadin.ui.UI

getCurrent

public static AppUI getCurrent()

Returns:

current AppUI

getApp

public App getApp()

Returns:

this App instance

getTopLevelWindow

@Nullable
public RootWindow getTopLevelWindow()

Returns:

currently displayed top-level window

getTopLevelWindowNN

@Nonnull
public RootWindow getTopLevelWindowNN()

setTopLevelWindow

public void setTopLevelWindow(@Nullable
                              RootWindow window)

INTERNAL. Set currently displayed top-level window.

getTestIdManager

public TestIdManager getTestIdManager()

isTestMode

public boolean isTestMode()

Returns:

true if UI test mode is enabled and cuba-id attribute should be added to DOM tree

isPerformanceTestMode

public boolean isPerformanceTestMode()

error

public void error(com.vaadin.server.ErrorEvent event)

Specified by:

error in interface com.vaadin.server.ErrorHandler

processExternalLink

protected void processExternalLink(com.vaadin.server.VaadinRequest request,
                                   NavigationState requestedState)

isLinkHandlerRequest

protected boolean isLinkHandlerRequest(com.vaadin.server.VaadinRequest request)

processLinkHandlerRequest

protected void processLinkHandlerRequest(com.vaadin.server.VaadinRequest request)

processRequest

protected void processRequest(NavigationState navigationState)

detach

public void detach()

Specified by:

detach in interface com.vaadin.server.ClientConnector

Overrides:

detach in class com.vaadin.ui.UI

updateClientSystemMessages

protected void updateClientSystemMessages(java.util.Locale locale)

onHistoryBackPerformed

protected void onHistoryBackPerformed()

getTopLevelWindowComposition

protected com.vaadin.ui.AbstractComponent getTopLevelWindowComposition()

getTimers

public java.util.List<CubaTimer> getTimers()

addTimer

public void addTimer(CubaTimer timer)

removeTimer

public void removeTimer(CubaTimer timer)

beforeTopLevelWindowInit

public void beforeTopLevelWindowInit()

setProfilerParameters

protected void setProfilerParameters()

updateUiTheme

protected void updateUiTheme()

getFileDownloader

public CubaFileDownloader getFileDownloader()

getUiEventsMulticaster

public UiEventsMulticaster getUiEventsMulticaster()

createVersionedResource

public com.vaadin.server.Resource createVersionedResource(java.lang.String value)

Specified by:

createVersionedResource in interface EnhancedUI

getWebJarPath

public java.lang.String getWebJarPath(java.lang.String webjar,
                                      java.lang.String partialPath)

Specified by:

getWebJarPath in interface EnhancedUI

translateToWebPath

public java.lang.String translateToWebPath(java.lang.String fullWebJarPath)

Specified by:

translateToWebPath in interface EnhancedUI

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Overrides:

paintContent in class com.vaadin.ui.UI

Throws:

com.vaadin.server.PaintException

getProfilerMarker

public java.lang.String getProfilerMarker()

setProfilerMarker

public void setProfilerMarker(java.lang.String profilerMarker)

Specified by:

setProfilerMarker in interface EnhancedUI

setProfiledScreen

public void setProfiledScreen(java.lang.String profilerMarker,
                              java.lang.String screen)

getProfiledScreen

public java.lang.String getProfiledScreen(java.lang.String profilerMarker)

clearProfiledScreens

public void clearProfiledScreens(java.util.List<java.lang.String> profilerMarkers)