Package de.espirit.firstspirit.webedit

Interface WebeditUiAgent

public interface WebeditUiAgent
Agent providing specific information of the webedit UI.
Since:
5.0.103

  • Field Details

  • Method Details

    • getLocale

      @NotNull @NotNull Locale getLocale()
      Provides the locale with which the webedit UI is localized.
      Returns:
      The client's locale.
      Since:
      5.2.609

    • getDisplayLanguage

      Language getDisplayLanguage()
      Provides the display language of the client UI.
      Returns:
      The client's display language.
      Since:
      5.0.103

    • getPreviewLanguage

      @Nullable @Nullable Language getPreviewLanguage()
      Provides the language the preview element is shown in.
      Returns:
      The preview language.
      Since:
      5.0.103

    • getPreviewElement

      @Nullable @Nullable IDProvider getPreviewElement()
      Provides the currently shown element. This is usually a PageRef, but may be a Dataset for a detail page on a content projection that renders multiple datasets. Use getPreviewPageRef() to obtain the hosting PageRef in that case.
      Returns:
      The current element.
      Since:
      5.0.103

    • getPreviewPageRef

      @Nullable @Nullable PageRef getPreviewPageRef()
      Provides the PageRef hosting the currently shown preview element. Returns the preview element itself if it is a PageRef, or the contextual PageRef if the preview element is a Dataset rendered on a detail page.
      Returns:
      The contextual PageRef, or null if none is available.
      Since:
      5.2.260802

    • getDisplayName

      @NotNull @NotNull String getDisplayName(IDProvider element)
      Provides the display name for the given store element.
      Parameters:
      element - The element to provide a name for.
      Returns:
      The element's display name.
      Since:
      5.0.103