Package org.opencms.ade.configuration.formatters

Class CmsSettingConfiguration

  • public class CmsSettingConfiguration
extends java.lang.Object
    Contains the setting-related data for a formatter bean.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​CmsXmlContentProperty> getSettings​(com.google.common.collect.ImmutableList<CmsUUID> sharedSettingOverrides)
      Gets the setting map by looking up the configured settings' include names in either the shared settings files configured in the formatter configuration, or the override shared settings files whose ids are passed as parameter.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsSettingConfiguration

        public CmsSettingConfiguration​(java.util.List<CmsXmlContentProperty> listedSettings,
                               java.util.Map<CmsUUID,​java.util.Map<CmsSharedSettingKey,​CmsXmlContentProperty>> sharedSettingConfigsById,
                               java.util.List<CmsUUID> includeIds,
                               java.lang.String formatterKey,
                               java.lang.String displayType)
        Parameters:
        listedSettings - the setting entries configured in the formatter configuration
        sharedSettingConfigsById - the map of shared setting configurations, with their structure ids as keys
        includeIds - the list of structure ids of shared setting configurations referenced from the formatter configuration
        formatterKey - the key of the formatter using this setting configuration (may be null)
        displayType - the display type

    • Method Detail

      • getSettings

        public java.util.Map<java.lang.String,​CmsXmlContentProperty> getSettings​(com.google.common.collect.ImmutableList<CmsUUID> sharedSettingOverrides)
        Gets the setting map by looking up the configured settings' include names in either the shared settings files configured in the formatter configuration, or the override shared settings files whose ids are passed as parameter.

        Setting definitions from Override shared settings files have higher priority than those referenced in the formatter configuration, and later entries in both lists have higher prioritiy than earlier ones.

        Parameters:
        sharedSettingOverrides - the structure ids of Override shared setting configurations (highest priority last)
        Returns:
        the setting definition map