Class CmsAppWorkplaceUi

  • 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.SerializableEventListener, com.vaadin.event.UIEvents.PollNotifier, com.vaadin.navigator.ViewChangeListener, com.vaadin.navigator.ViewDisplay, com.vaadin.navigator.ViewProvider, com.vaadin.server.ClientConnector, com.vaadin.server.Page.BrowserWindowResizeListener, 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, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener, I_CmsWindowCloseListener

    public class CmsAppWorkplaceUi
    extends A_CmsUI
    implements com.vaadin.navigator.ViewDisplay, com.vaadin.navigator.ViewProvider, com.vaadin.navigator.ViewChangeListener, I_CmsWindowCloseListener, com.vaadin.server.Page.BrowserWindowResizeListener
    The workplace ui.

    See Also:
    Serialized Form
    • Nested Class Summary

      • 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 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.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.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.server.Sizeable

        com.vaadin.server.Sizeable.Unit
      • Nested classes/interfaces inherited from interface com.vaadin.navigator.ViewChangeListener

        com.vaadin.navigator.ViewChangeListener.ViewChangeEvent
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vaadin.navigator.View m_launchRedirect
      Launch pad redirect view.
      static java.lang.String WINDOW_TITLE_PREFIX
      The OpenCms window title prefix.
      static java.lang.String WORKPLACE_APP_ID_SEPARATOR
      The workplace app id separator.
      static java.lang.String WORKPLACE_STATE_SEPARATOR
      The workplace state separator.
      • 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 Description
      CmsAppWorkplaceUi()
      Constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterViewChange​(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)  
      boolean beforeViewChange​(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)  
      void browserWindowResized​(com.vaadin.server.Page.BrowserWindowResizeEvent event)  
      void changeCurrentAppState​(java.lang.String state)
      Call to add a new browser history entry.
      void checkBroadcasts()
      Checks for new broadcasts.
      void closeWindows()
      Closes all opened dialog windows.
      void detach()  
      void disableGlobalShortcuts()
      Disables the global keyboard shortcuts.
      void enableGlobalShortcuts()
      Enables the global keyboard shortcuts.
      static CmsAppWorkplaceUi get()
      Gets the current UI instance.
      java.lang.String getAppState()
      Returns the state parameter of the current app.
      com.vaadin.navigator.View getCurrentView()
      Gets the current view.
      java.util.Locale getLocale()  
      com.vaadin.navigator.View getView​(java.lang.String viewName)  
      java.lang.String getViewName​(java.lang.String viewAndParameters)  
      void historyBack()
      Executes the history back function.
      void historyForward()
      Executes the history forward function.
      protected void init​(com.vaadin.server.VaadinRequest req)  
      static boolean isOnlineProject()
      Returns whether the current project is the online project.
      void onError()
      Called when an error occurs.
      void onWindowClose()
      Executed on window close.
      void reload()
      Reloads the current UI.
      void setLastHeartbeatTimestamp​(long lastHeartbeat)  
      static void setWindowTitle​(java.lang.String title)
      Sets the window title adding an OpenCms prefix.
      void showApp​(java.lang.String appId, java.lang.String state)
      Navigates to the given app.
      void showApp​(I_CmsWorkplaceAppConfiguration appConfig)
      Navigates to the given app.
      void showApp​(I_CmsWorkplaceAppConfiguration appConfig, java.lang.String state)
      Navigates to the given app.
      void showHome()
      Navigates to the home screen.
      void showView​(com.vaadin.navigator.View view)  
      • 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, 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, getUiPathInfo, getUiRootPath, getWindows, isClosing, isConnectorEnabled, isMobileHtml5DndEnabled, isResizeLazy, isUsingThoroughSizeCheck, iterator, paintContent, push, refresh, removeAction, removeActionHandler, removeClickListener, removePollListener, removeWindow, scrollIntoView, setActiveDragSource, setCaption, setContent, setCurrent, setFocusedComponent, 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, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, 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, getListeners, getResource, getRpcManager, getRpcProxy, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • 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.ui.Component

        addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getParent, getPrimaryStyleName, getStyleName, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign
      • Methods inherited from interface com.vaadin.shared.Connector

        getConnectorId
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
      • Methods inherited from interface com.vaadin.ui.LegacyComponent

        markAsDirty
      • 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 com.vaadin.server.VariableOwner

        isEnabled
    • Method Detail

      • get

        public static CmsAppWorkplaceUi get()
        Gets the current UI instance.

        Returns:
        the current UI instance
      • isOnlineProject

        public static boolean isOnlineProject()
        Returns whether the current project is the online project.

        Returns:
        true if the current project is the online project
      • setWindowTitle

        public static void setWindowTitle​(java.lang.String title)
        Sets the window title adding an OpenCms prefix.

        Parameters:
        title - the window title
      • afterViewChange

        public void afterViewChange​(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
        Specified by:
        afterViewChange in interface com.vaadin.navigator.ViewChangeListener
        See Also:
        ViewChangeListener.afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
      • beforeViewChange

        public boolean beforeViewChange​(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
        Specified by:
        beforeViewChange in interface com.vaadin.navigator.ViewChangeListener
        See Also:
        ViewChangeListener.beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
      • browserWindowResized

        public void browserWindowResized​(com.vaadin.server.Page.BrowserWindowResizeEvent event)
        Specified by:
        browserWindowResized in interface com.vaadin.server.Page.BrowserWindowResizeListener
        See Also:
        Page.BrowserWindowResizeListener.browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent)
      • changeCurrentAppState

        public void changeCurrentAppState​(java.lang.String state)
        Call to add a new browser history entry.

        Parameters:
        state - the current app view state
      • checkBroadcasts

        public void checkBroadcasts()
        Checks for new broadcasts.

      • detach

        public void detach()
        Specified by:
        detach in interface com.vaadin.server.ClientConnector
        Overrides:
        detach in class com.vaadin.ui.UI
        See Also:
        UI.detach()
      • getAppState

        public java.lang.String getAppState()
        Returns the state parameter of the current app.

        Returns:
        the state parameter of the current app
      • getCurrentView

        public com.vaadin.navigator.View getCurrentView()
        Gets the current view.

        Returns:
        the current view
      • getLocale

        public java.util.Locale getLocale()
        Specified by:
        getLocale in interface com.vaadin.ui.Component
        Overrides:
        getLocale in class com.vaadin.ui.AbstractComponent
        See Also:
        AbstractComponent.getLocale()
      • getView

        public com.vaadin.navigator.View getView​(java.lang.String viewName)
        Specified by:
        getView in interface com.vaadin.navigator.ViewProvider
        See Also:
        ViewProvider.getView(java.lang.String)
      • getViewName

        public java.lang.String getViewName​(java.lang.String viewAndParameters)
        Specified by:
        getViewName in interface com.vaadin.navigator.ViewProvider
        See Also:
        ViewProvider.getViewName(java.lang.String)
      • historyBack

        public void historyBack()
        Executes the history back function.

      • historyForward

        public void historyForward()
        Executes the history forward function.

      • onError

        public void onError()
        Called when an error occurs.

      • setLastHeartbeatTimestamp

        public void setLastHeartbeatTimestamp​(long lastHeartbeat)
        Overrides:
        setLastHeartbeatTimestamp in class com.vaadin.ui.UI
        See Also:
        UI.setLastHeartbeatTimestamp(long)
      • showApp

        public void showApp​(I_CmsWorkplaceAppConfiguration appConfig,
                            java.lang.String state)
        Navigates to the given app.

        Parameters:
        appConfig - the app configuration
        state - the app state to call
      • showApp

        public void showApp​(java.lang.String appId,
                            java.lang.String state)
        Navigates to the given app.

        Parameters:
        appId - the app id
        state - the app state to call
      • showHome

        public void showHome()
        Navigates to the home screen.

      • showView

        public void showView​(com.vaadin.navigator.View view)
        Specified by:
        showView in interface com.vaadin.navigator.ViewDisplay
        See Also:
        ViewDisplay.showView(com.vaadin.navigator.View)
      • init

        protected void init​(com.vaadin.server.VaadinRequest req)
        Overrides:
        init in class A_CmsUI
        See Also:
        UI.init(com.vaadin.server.VaadinRequest)