Package org.opencms.gwt

Class CmsGwtActionElement

java.lang.Object
org.opencms.jsp.CmsJspBean
org.opencms.jsp.CmsJspActionElement
org.opencms.gwt.CmsGwtActionElement
Direct Known Subclasses:
CmsContainerpageActionElement, CmsContentEditorActionElement, CmsEditProviderActionElement, CmsGalleryActionElement, CmsPostUploadDialogActionElement, CmsPropertiesActionElement, CmsPublishActionElement, CmsSitemapActionElement, CmsUploadActionElement
public class CmsGwtActionElement extends CmsJspActionElement
Sitemap action used to generate the sitemap editor.

see jsp file /system/workplace/commons/sitemap.jsp.

Since:
8.0.0

  • Field Details

  • Constructor Details

    • CmsGwtActionElement

      public CmsGwtActionElement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Constructor.

      Parameters:
      context - the JSP page context object
      req - the JSP request
      res - the JSP response

  • Method Details

    • createNoCacheScript

      public static String createNoCacheScript(String moduleName, String moduleVersion)
      Returns the script tag for the "*.nocache.js".

      Parameters:
      moduleName - the module name to get the script tag for
      moduleVersion - the module version
      Returns:
      the "<script>" tag for the "*.nocache.js".

    • exportCommon

      public static String exportCommon(CmsObject cms, CmsCoreData coreData) throws Exception
      Returns the serialized data for the core provider wrapped into a script tag.

      Parameters:
      cms - the CMS context
      coreData - the core data to write into the page
      Returns:
      the data
      Throws:
      Exception - if something goes wrong

    • exportDictionary

      public static String exportDictionary(String name, Method method, Object data) throws com.google.gwt.user.client.rpc.SerializationException
      Serializes the result of the given method for RPC-prefetching.

      Parameters:
      name - the dictionary name
      method - the method
      data - the result to serialize
      Returns:
      the serialized data
      Throws:
      com.google.gwt.user.client.rpc.SerializationException - if something goes wrong

    • exportDictionary

      public static String exportDictionary(String name, String data)
      Exports a dictionary by the given name as the content attribute of a meta tag.

      Parameters:
      name - the dictionary name
      data - the data
      Returns:
      the meta tag

    • exportMeta

      public static String exportMeta(String name, String data)
      Generates the HTML for a meta tag with given name and content.

      Parameters:
      name - the name of the meta tag
      data - the content of the meta tag
      Returns:
      the HTML for the meta tag

    • getFontIconCssLink

      public static String getFontIconCssLink()
      Returns the OpenCms font icon CSS link.

      Returns:
      the CSS link

    • serialize

      public static String serialize(Method method, Object data) throws com.google.gwt.user.client.rpc.SerializationException
      Serializes the result of the given method for RPC-prefetching.

      Parameters:
      method - the method
      data - the result to serialize
      Returns:
      the serialized data
      Throws:
      com.google.gwt.user.client.rpc.SerializationException - if something goes wrong

    • wrapScript

      public static String wrapScript(String... s)
      Concatenates the given strings and surrounds them with script tags.

      Parameters:
      s - the array of strings to concatenate and wrap
      Returns:
      the concatenation of the input strings, wrapped in script tags

    • createNoCacheScript

      @Deprecated public String createNoCacheScript(String moduleName)
      Deprecated.
      Returns the script tag for the "*.nocache.js".

      Parameters:
      moduleName - the module name to get the script tag for
      Returns:
      the "<script>" tag for the "*.nocache.js".

    • export

      public String export() throws Exception
      Returns the serialized data for the core provider wrapped in a script tag.

      Returns:
      the data
      Throws:
      Exception - if something goes wrong

    • export

      public String export(boolean includeFontCss) throws Exception
      Returns the serialized data for the core provider wrapped into a script tag.

      Parameters:
      includeFontCss - true to include the OpenCms font CSS, not necessary in case VAADIN theme is loaded also
      Returns:
      the data
      Throws:
      Exception - if something goes wrong

    • exportAll

      public String exportAll() throws Exception
      Returns the serialized data for the core provider.

      Returns:
      the data
      Throws:
      Exception - if something goes wrong

    • getCoreData

      public CmsCoreData getCoreData()
      Returns the needed server data for client-side usage.

      Returns:
      the needed server data for client-side usage

    • getWorkplaceLocale

      public Locale getWorkplaceLocale()
      Returns the workplace locale for the current user.

      Returns:
      the workplace locale

    • exportModuleScriptTag

      protected String exportModuleScriptTag(String moduleName)
      Exports script tag to the main OpenCms GWT no-cache js script tag.

      Parameters:
      moduleName - the client module to start
      Returns:
      the HTML string