Package org.opencms.ade.configuration.formatters

Class CmsSettingConfiguration

java.lang.Object

org.opencms.ade.configuration.formatters.CmsSettingConfiguration

public class CmsSettingConfiguration
extends Object

Contains the setting-related data for a formatter bean.

Constructor Summary

Constructors

Constructor	Description
CmsSettingConfiguration()	Creates an empty configuration.
CmsSettingConfiguration(List<CmsXmlContentProperty> listedSettings, Map<CmsUUID,Map<CmsSharedSettingKey,CmsXmlContentProperty>> sharedSettingConfigsById, List<CmsUUID> includeIds, String formatterKey, String displayType)

Method Summary

Modifier and Type	Method	Description
Map<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 Details

CmsSettingConfiguration

public CmsSettingConfiguration()

Creates an empty configuration.

CmsSettingConfiguration

public CmsSettingConfiguration(List<CmsXmlContentProperty> listedSettings,
 Map<CmsUUID,Map<CmsSharedSettingKey,CmsXmlContentProperty>> sharedSettingConfigsById,
 List<CmsUUID> includeIds,
 String formatterKey,
 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 Details

getSettings

public Map<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