Package org.opencms.xml.content

Interface I_CmsXmlContentAugmentation.Context

Enclosing interface:
I_CmsXmlContentAugmentation
public static interface I_CmsXmlContentAugmentation.Context
Context provided to the content augmentation class.

Used to access the original content, the currently edited locale, the current CmsObject, etc., and to send the new content back to the editor at the end.

  • Method Details

    • getParameter

      String getParameter(String param)

    • callJsp

      void callJsp(String path) throws Exception
      Helper method for calling the JSP at the given path.

      The context will be made available as the request attribute 'context' in the called JSP.

      This method can not be used reentrantly (i.e. from a JSP which has already been called via callJsp).

      Parameters:
      path - the path of the JSP to call
      Throws:
      Exception - if something goes wrong

    • getADEConfig

      CmsADEConfigData getADEConfig()
      The ADE configuration that's currently being used.
      Returns:
      the ADE configuration

    • getCmsObject

      CmsObject getCmsObject()
      Gets the current CMS context.
      Returns:
      the current CMS context

    • getContent

      CmsXmlContent getContent()
      Gets a copy of the currently edited XML content.

      Modifying this object by itself does not do anything for the content editor, you have to send either the modified object or another modified copy back to the content editor via setResult().

      Returns:
      a copy of the currently edited XML content

    • getLocale

      Locale getLocale()
      Gets the currently edited locale of the content.
      Returns:
      the currently edited locale of the content

    • isAborted

      boolean isAborted()

    • progress

      void progress(String progressMessage)

    • setHtmlMessage

      void setHtmlMessage(String message)
      Sets the HTML to display to the user after the augmentation.
      Parameters:
      message -

    • setNextLocale

      void setNextLocale(Locale locale)
      Sets the locale to switch to.

      If not called, the current locale will be used if possible.

      Parameters:
      locale - the locale to switch to

    • setResult

      void setResult(CmsXmlContent result)
      Sends the augmented content back to the content editor.
      Parameters:
      result - the augmented content