Package org.opencms.ui.dialogs

Class CmsEmbeddedDialogContext

  • All Implemented Interfaces:
    com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, java.io.Serializable, I_CmsDialogContext
    public class CmsEmbeddedDialogContext
extends com.vaadin.server.AbstractExtension
implements I_CmsDialogContext
    Context for dialogs embedded into plain GWT modules.

    See Also:
    Serialized Form

    • Nested Class Summary

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeWindow​(boolean keepFrame)
      Closes the dialog window.
      void error​(java.lang.Throwable error)
      Signals an error which occurred in the dialog.
      void finish​(java.util.Collection<CmsUUID> result)
      Signals that the dialog has finished.
      void finish​(CmsProject project, java.lang.String siteRoot)
      Signals that the dialog has finished.
      void finish​(CmsExtendedSiteSelector.SiteSelectorOption option)
      Opens the location from the site selector option.
      void finishWithString​(java.lang.String str)
      Finishes the dialog and returns an arbitrary string to the opener.
      void focus​(CmsUUID structureId)
      Tell the system that the resource with the given id should be shown somehow.
      java.util.List<CmsUUID> getAllStructureIdsInView()
      Gets a list of structure ids of all visible resources, not just the ones selected for the dialog.
      java.lang.String getAppId()
      Returns the app id.
      protected I_CmsEmbeddedDialogClientRPC getClientRPC()
      Returns the client RPC.
      CmsObject getCms()
      Gets the CMS context to be used for dialog operations.
      I_CmsDialogContext.ContextType getContextType()
      Returns the context type.
      java.util.List<CmsResource> getResources()
      Gets the list of resources for which the dialog should be opened.
      void leavePage​(java.lang.String uri)
      Leaves page by navigating to given URI.
      void navigateTo​(java.lang.String appId)
      Navigates to the given app.
      void onViewChange()
      Call when the dialog view has changed to re-center the dialog window.
      void reload()
      Reloads the UI.
      void selectString​(java.lang.String principalName)
      Sets the principal.
      void setWindow​(com.vaadin.ui.Window window)
      Sets the current window.
      void start​(java.lang.String title, com.vaadin.ui.Component dialog)
      Called to start up the dialog with the given main widget and title string.
      void start​(java.lang.String title, com.vaadin.ui.Component dialog, CmsBasicDialog.DialogWidth width)
      Called to start up the dialog with the given main widget and title string.
      void updateUserInfo()
      Called when the user info was changed.

      • Methods inherited from class com.vaadin.server.AbstractExtension

        extend, getParent, getSupportedParentType, remove, setParent

      • Methods inherited from class com.vaadin.server.AbstractClientConnector

        addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, 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, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

      • Methods inherited from interface com.vaadin.shared.Connector

        getConnectorId