Package org.opencms.ui

Interface I_CmsDialogContext

All Known Subinterfaces:
I_CmsDialogContextWithAdeContext
All Known Implementing Classes:
A_CmsDialogContext, CmsEmbeddedDialogContext, CmsExplorerDialogContext, CmsFileTableDialogContext, CmsListManager.DialogContext, CmsSitemapTreeController.DialogContext, CmsToolBar.ToolbarContext
public interface I_CmsDialogContext
Context for dialogs opened from the context menu.

  • Field Details

  • Method Details

    • error

      void error(Throwable error)
      Signals an error which occurred in the dialog.

      Parameters:
      error - the error which occcurred

    • finish

      void finish(CmsProject project, String siteRoot)
      Signals that the dialog has finished.

      Call when current project and or site have been changed.

      Parameters:
      project - changed project
      siteRoot - changed site root

    • finish

      void finish(Collection<CmsUUID> result)
      Signals that the dialog has finished.

      Parameters:
      result - the list of structure ids of changed resources

    • focus

      void focus(CmsUUID structureId)
      Tell the system that the resource with the given id should be shown somehow.

      Parameters:
      structureId - the structure id of a resource

    • getAllStructureIdsInView

      List<CmsUUID> getAllStructureIdsInView()
      Gets a list of structure ids of all visible resources, not just the ones selected for the dialog.

      Returns:
      the structure ids of all the resources in the current view

    • getAppId

      String getAppId()
      Returns the app id.

      Returns:
      the app id

    • getCms

      CmsObject getCms()
      Gets the CMS context to be used for dialog operations.

      Returns:
      the CMS context

    • getContextType

      I_CmsDialogContext.ContextType getContextType()
      Returns the context type.

      May be used for visibility evaluation.

      Returns:
      the context type

    • getParameters

      default Map<String,String> getParameters()
      Gets additional parameters.
      Returns:
      the map of additional parameters

    • getResources

      List<CmsResource> getResources()
      Gets the list of resources for which the dialog should be opened.

      Returns:
      the list of resources

    • onViewChange

      void onViewChange()
      Call when the dialog view has changed to re-center the dialog window.

    • reload

      void reload()
      Reloads the UI.

    • setWindow

      void setWindow(com.vaadin.ui.Window window)
      Sets the current window.

      Parameters:
      window - the current dialog window

    • start

      void start(String title, com.vaadin.ui.Component dialog)
      Called to start up the dialog with the given main widget and title string.

      Parameters:
      title - the title to display
      dialog - the dialog main widget

    • start

      void start(String title, com.vaadin.ui.Component dialog, CmsBasicDialog.DialogWidth width)
      Called to start up the dialog with the given main widget and title string.

      Parameters:
      title - the title to display
      dialog - the dialog main widget
      width - the preferred width for the dialog

    • updateUserInfo

      void updateUserInfo()
      Called when the user info was changed.