Package org.opencms.ade.configuration

Class CmsFormatterUtils

  • public class CmsFormatterUtils
extends java.lang.Object
    Helper class for formatter-related functionality.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Set<java.lang.String> getAllFormatterKeys​(CmsADEConfigData configData, CmsContainerElementBean element)
      Gets the set of all formatter keys from the settings.
      static java.lang.String getFormatterKey​(java.lang.String containerName, java.util.Map<java.lang.String,​java.lang.String> settings)
      Gets the formatter key for the given container name from an element's settings.
      static java.lang.String getFormatterKey​(java.lang.String containerName, CmsContainerElementBean element)
      Gets the formatter key for the given container name from an element's settings.
      static java.lang.String removeFormatterKey​(java.lang.String containerName, java.util.Map<java.lang.String,​java.lang.String> settings)
      Gets the formatter key for the given container name from an element's settings.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getAllFormatterKeys

        public static java.util.Set<java.lang.String> getAllFormatterKeys​(CmsADEConfigData configData,
                                                                  CmsContainerElementBean element)
        Gets the set of all formatter keys from the settings.
        Parameters:
        configData - the sitemap configuration
        element - the container element
        Returns:
        the set of all formatter keys

      • getFormatterKey

        public static java.lang.String getFormatterKey​(java.lang.String containerName,
                                               CmsContainerElementBean element)
        Gets the formatter key for the given container name from an element's settings.
        Parameters:
        containerName - the container name
        element - the element from which to get the formatter key
        Returns:
        the formatter key

      • getFormatterKey

        public static java.lang.String getFormatterKey​(java.lang.String containerName,
                                               java.util.Map<java.lang.String,​java.lang.String> settings)
        Gets the formatter key for the given container name from an element's settings.
        Parameters:
        containerName - the container name
        settings - the settings from which to get the formatter key
        Returns:
        the formatter key

      • removeFormatterKey

        public static java.lang.String removeFormatterKey​(java.lang.String containerName,
                                                  java.util.Map<java.lang.String,​java.lang.String> settings)
        Gets the formatter key for the given container name from an element's settings.
        Parameters:
        containerName - the container name
        settings - the settings from which to remove the formatter key
        Returns:
        the formatter key