Class A_CmsUI

  • 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.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, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener
    Direct Known Subclasses:
    CmsAppWorkplaceUi, CmsEmbeddedDialogsUI, CmsErrorUI, CmsLoginUI, CmsSitemapUI

    public abstract class A_CmsUI
    extends com.vaadin.ui.UI
    Abstract UI class providing access to the OpenCms context.

    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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String LAST_OFFLINE_PROJECT
      The last offline project attribute key.
      • 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
      A_CmsUI()
      Constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void changeProject​(CmsProject project)
      Changes to the given project.
      void changeSite​(java.lang.String siteRoot)
      Changes to the given site.
      void closeWindows()
      Closes all opened dialog windows.
      static A_CmsUI get()
      Returns the current UI.
      java.io.Serializable getAttribute​(java.lang.String key)
      Returns the requested UI attribute.
      static CmsObject getCmsObject()
      Returns the current cms context.
      CmsDisplayType getDisplayType()
      Gets the display type from the time when the UI was initialized.
      javax.servlet.http.HttpSession getHttpSession()
      Returns the HTTP session.
      CmsProject getLastOfflineProject()
      Returns the last used offline project.
      com.google.common.collect.Multimap<java.lang.String,​java.lang.String> getParameters()
      Gets the request parameters with which the application was loaded.
      CmsWorkplaceSettings getWorkplaceSettings()
      Returns the workplace settings.
      protected void init​(com.vaadin.server.VaadinRequest request)  
      void openPageOrWarn​(java.lang.String link, java.lang.String target)
      Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).
      void openPageOrWarn​(java.lang.String link, java.lang.String target, java.lang.String warning)
      Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).
      void reload()
      Reloads the current UI.
      void setAttribute​(java.lang.String key, java.io.Serializable value)
      Sets an UI attribute.
      void setContentToDialog​(java.lang.String caption, com.vaadin.ui.Component component)
      Replaces the ui content with a single dialog.
      void setContentToDialog​(java.lang.String caption, CmsBasicDialog dialog)
      Replaces the ui content with a single dialog.
      void setError​(java.lang.String error)
      Displays an error message in a centered box.
      • Methods inherited from class com.vaadin.ui.UI

        access, accessSynchronously, addAction, addActionHandler, addClickListener, addPollListener, addWindow, addWindowOrderUpdateListener, attach, changeVariables, close, detach, 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, 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, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, 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, getLocale, 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
    • Constructor Detail

      • A_CmsUI

        public A_CmsUI()
        Constructor.

    • Method Detail

      • get

        public static A_CmsUI get()
        Returns the current UI.

        Returns:
        the current UI
      • getCmsObject

        public static CmsObject getCmsObject()
        Returns the current cms context.

        Returns:
        the current cms context
      • changeProject

        public void changeProject​(CmsProject project)
        Changes to the given project. Will update session and workplace settings.

        Parameters:
        project - the project to change to
      • changeSite

        public void changeSite​(java.lang.String siteRoot)
        Changes to the given site. Will update session and workplace settings.

        Parameters:
        siteRoot - the site to change to
      • closeWindows

        public void closeWindows()
        Closes all opened dialog windows.

      • getAttribute

        public java.io.Serializable getAttribute​(java.lang.String key)
        Returns the requested UI attribute.

        Parameters:
        key - the attribute key
        Returns:
        the attribute
      • getDisplayType

        public CmsDisplayType getDisplayType()
        Gets the display type from the time when the UI was initialized.

        Returns:
        the display type
      • getHttpSession

        public javax.servlet.http.HttpSession getHttpSession()
        Returns the HTTP session.

        Returns:
        the HTTP session
      • getParameters

        public com.google.common.collect.Multimap<java.lang.String,​java.lang.String> getParameters()
        Gets the request parameters with which the application was loaded.

        Returns:
        the request parameters
      • openPageOrWarn

        public void openPageOrWarn​(java.lang.String link,
                                   java.lang.String target)
        Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).

        Parameters:
        link - the URL to open in the new window
        target - the target window name
      • openPageOrWarn

        public void openPageOrWarn​(java.lang.String link,
                                   java.lang.String target,
                                   java.lang.String warning)
        Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).

        Parameters:
        link - the URL to open in the new window
        target - the target window name
        warning - the warning to show if opening the window fails
      • reload

        public void reload()
        Reloads the current UI.

      • setAttribute

        public void setAttribute​(java.lang.String key,
                                 java.io.Serializable value)
        Sets an UI attribute.

        Parameters:
        key - the attribute key
        value - the attribute value
      • setContentToDialog

        public void setContentToDialog​(java.lang.String caption,
                                       CmsBasicDialog dialog)
        Replaces the ui content with a single dialog.

        Parameters:
        caption - the caption
        dialog - the dialog content
      • setContentToDialog

        public void setContentToDialog​(java.lang.String caption,
                                       com.vaadin.ui.Component component)
        Replaces the ui content with a single dialog.

        TODO: In the future this should only handle window creation, refactor dialog contents to CmsBasicDialog

        Parameters:
        caption - the caption
        component - the dialog content
      • setError

        public void setError​(java.lang.String error)
        Displays an error message in a centered box.

        Parameters:
        error - the error message to display
      • init

        protected void init​(com.vaadin.server.VaadinRequest request)
        Specified by:
        init in class com.vaadin.ui.UI
        See Also:
        UI.init(com.vaadin.server.VaadinRequest)