接口 org.opencms.xml.containerpage.I_CmsFormatterBean
的使用

使用I_CmsFormatterBean的程序包

程序包	说明
org.opencms.ade.configuration
org.opencms.ade.configuration.formatters
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.

org.opencms.ade.configuration中I_CmsFormatterBean的使用

返回变量类型为I_CmsFormatterBean的类型的org.opencms.ade.configuration中的方法

限定符和类型	方法和说明
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsADEConfigData.getActiveFormatters() Gets the active external (non-schema) formatters for this sub-sitemap.
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsADEConfigData.getInactiveFormatters() Gets the map of external (non-schema) formatters which are inactive in this sub-sitemap.

类型变量类型为I_CmsFormatterBean的org.opencms.ade.configuration中的方法参数

限定符和类型	方法和说明
void	CmsADEConfigData.applyAllFormatterChanges(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters, CmsFormatterConfigurationCacheState formatterCacheState) Applies the formatter change sets of this and all parent configurations to a map of external (non-schema) formatters.

org.opencms.ade.configuration.formatters中I_CmsFormatterBean的使用

返回变量类型为I_CmsFormatterBean的类型的org.opencms.ade.configuration.formatters中的方法

限定符和类型	方法和说明
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsFormatterConfigurationCacheState.getAutoEnabledFormatters() Gets the map of formatters which are automatically enabled.
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsFormatterConfigurationCacheState.getFormatters() Gets the map of all formatters.
java.util.Collection<I_CmsFormatterBean>	CmsFormatterConfigurationCacheState.getFormattersForType(java.lang.String resourceType, boolean filterAutoEnabled) Gets the formatters for a specific resource types, and optionally only returns those which are automatically enabled.

类型变量类型为I_CmsFormatterBean的org.opencms.ade.configuration.formatters中的方法参数

限定符和类型	方法和说明
void	CmsFormatterChangeSet.applyToFormatters(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters, CmsFormatterConfigurationCacheState externalFormatters) Applies this change set to a list of external (non schema-based) formatters.
CmsFormatterConfigurationCacheState	CmsFormatterConfigurationCacheState.createUpdatedCopy(java.util.Map<CmsUUID,I_CmsFormatterBean> updateFormatters) Creates a new copy of this state in which some entries are removed or replaced.

类型变量类型为I_CmsFormatterBean的org.opencms.ade.configuration.formatters中的构造器参数

构造器和说明
CmsFormatterConfigurationCacheState(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters) Creates a new instance.

org.opencms.widgets中I_CmsFormatterBean的使用

参数类型为I_CmsFormatterBean的org.opencms.widgets中的方法

限定符和类型	方法和说明
int	A_CmsFormatterWidget.FormatterSelectComparator.compare(I_CmsFormatterBean first, I_CmsFormatterBean second)
static CmsSelectWidgetOption	A_CmsFormatterWidget.getWidgetOptionForFormatter(CmsObject cms, I_CmsFormatterBean formatter) Creates a widget option corresponding to a formatter bean for an external formatter.

org.opencms.xml.containerpage中I_CmsFormatterBean的使用

实现I_CmsFormatterBean的org.opencms.xml.containerpage中的类

限定符和类型	类和说明
class	CmsFormatterBean A bean containing formatter configuration data as strings.
class	CmsSchemaFormatterBeanWrapper Wrapper class for formatter beans which delegates all methods to the wrapped formatter bean except those for which we need to ask the content handler for additional data like element settings or head includes.

返回I_CmsFormatterBean的org.opencms.xml.containerpage中的方法

限定符和类型	方法和说明
I_CmsFormatterBean	CmsFormatterConfiguration.getDefaultFormatter(java.lang.String containerType, int containerWidth) Selects the best matching formatter for the provided type and width from this configuration.
I_CmsFormatterBean	CmsFormatterConfiguration.getDefaultSchemaFormatter(java.lang.String containerType, int containerWidth) Selects the best matching schema formatter for the provided type and width from this configuration.
I_CmsFormatterBean	CmsFormatterConfiguration.getDetailFormatter(java.lang.String type, int containerWidth) Gets the detail formatter to use for the given type and container width.
I_CmsFormatterBean	CmsFormatterConfiguration.getPreviewFormatter() Returns the formatter from this configuration that is to be used for the preview in the ADE gallery GUI, or null if there is no preview formatter configured.

返回变量类型为I_CmsFormatterBean的类型的org.opencms.xml.containerpage中的方法

限定符和类型	方法和说明
java.util.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getAllFormatters() Gets a list of all defined formatters.
java.util.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getAllMatchingFormatters(java.lang.String containerType, int containerWidth) Gets the formatters which are available for the given container type and width.
java.util.Collection<I_CmsFormatterBean>	CmsFormatterConfiguration.getDetailFormatters() Gets all detail formatters.
java.util.Map<java.lang.String,I_CmsFormatterBean>	CmsFormatterConfiguration.getFormatterSelection(java.lang.String containerType, int containerWidth) Returns the formatters available for selection for the given container type and width.

参数类型为I_CmsFormatterBean的org.opencms.xml.containerpage中的方法

限定符和类型	方法和说明
boolean	CmsFormatterConfiguration.IsDetail.apply(I_CmsFormatterBean formatter)
boolean	CmsFormatterConfiguration.IsSchemaFormatter.apply(I_CmsFormatterBean formatter)
int	CmsFormatterConfiguration.FormatterComparator.compare(I_CmsFormatterBean first, I_CmsFormatterBean second)

类型变量类型为I_CmsFormatterBean的org.opencms.xml.containerpage中的方法参数

限定符和类型	方法和说明
static CmsFormatterConfiguration	CmsFormatterConfiguration.create(CmsObject cms, java.util.List<I_CmsFormatterBean> formatters) Returns the formatter configuration for the current project based on the given list of formatters.

参数类型为I_CmsFormatterBean的org.opencms.xml.containerpage中的构造器

构造器和说明
CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource) Creates a new wrapper instance.