org.opencms.xml.containerpage

类 CmsFormatterConfiguration

java.lang.Object

org.opencms.xml.containerpage.CmsFormatterConfiguration

public final class CmsFormatterConfiguration
extends java.lang.Object

Represents a formatter configuration.

A formatter configuration can be either defined in the XML schema XSD of a XML content, or in a special sitemap configuration file.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsFormatterConfiguration.FormatterComparator This class is used to sort lists of formatter beans in order of importance.
static class	CmsFormatterConfiguration.IsDetail Predicate which checks whether the given formatter is a detail formatter.
static class	CmsFormatterConfiguration.IsSchemaFormatter Predicate to check whether the formatter is from a schema.

字段概要

字段

限定符和类型	字段和说明
static CmsFormatterConfiguration	EMPTY_CONFIGURATION The empty formatter configuration.
static org.apache.commons.logging.Log	LOG The log instance for this class.

方法概要

方法

限定符和类型	方法和说明
static 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.
java.util.List<I_CmsFormatterBean>	getAllFormatters() Gets a list of all defined formatters.
java.util.List<I_CmsFormatterBean>	getAllMatchingFormatters(java.lang.String containerType, int containerWidth) Gets the formatters which are available for the given container type and width.
I_CmsFormatterBean	getDefaultFormatter(java.lang.String containerType, int containerWidth) Selects the best matching formatter for the provided type and width from this configuration.
I_CmsFormatterBean	getDefaultSchemaFormatter(java.lang.String containerType, int containerWidth) Selects the best matching schema formatter for the provided type and width from this configuration.
I_CmsFormatterBean	getDetailFormatter(java.lang.String type, int containerWidth) Gets the detail formatter to use for the given type and container width.
java.util.Collection<I_CmsFormatterBean>	getDetailFormatters() Gets all detail formatters.
java.util.Map<java.lang.String,I_CmsFormatterBean>	getFormatterSelection(java.lang.String containerType, int containerWidth) Returns the formatters available for selection for the given container type and width.
I_CmsFormatterBean	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.
boolean	hasFormatter(java.lang.String containerType, int containerWidth) Returns the provided true in case this configuration has a formatter for the given type / width parameters.
boolean	hasFormatters() Returns true in case there is at least one usable formatter configured in this configuration.
static void	initialize(CmsObject cms) Initialize the formatter configuration.
boolean	isSearchContent(CmsUUID formatterStructureId) Returns true in case this configuration contains a formatter with the provided structure id that has been configured for including the formatted content in the online search.

从类继承的方法 java.lang.Object

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

字段详细资料

EMPTY_CONFIGURATION

public static final CmsFormatterConfiguration EMPTY_CONFIGURATION

The empty formatter configuration.

LOG

public static final org.apache.commons.logging.Log LOG

The log instance for this class.

方法详细资料

create

public static 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.

参数:

cms - the current users OpenCms context, required to know which project to read the JSP from

formatters - the list of configured formatters

返回:

the formatter configuration for the current project based on the given list of formatters

initialize

public static void initialize(CmsObject cms)
                       throws CmsException

Initialize the formatter configuration.

参数:

cms - an initialized admin OpenCms user context

抛出:

CmsException - in case the initialization fails

getAllFormatters

public java.util.List<I_CmsFormatterBean> getAllFormatters()

Gets a list of all defined formatters.

返回:

the list of all formatters

getAllMatchingFormatters

public java.util.List<I_CmsFormatterBean> getAllMatchingFormatters(java.lang.String containerType,
                                                          int containerWidth)

Gets the formatters which are available for the given container type and width.

参数:

containerType - the container type

containerWidth - the container width

返回:

the list of available formatters

getDefaultFormatter

public I_CmsFormatterBean getDefaultFormatter(java.lang.String containerType,
                                     int containerWidth)

Selects the best matching formatter for the provided type and width from this configuration.

This method first tries to find the formatter for the provided container type. If this fails, it returns the width based formatter that matched the container width.

参数:

containerType - the container type

containerWidth - the container width

返回:

the matching formatter, or null if none was found

getDefaultSchemaFormatter

public I_CmsFormatterBean getDefaultSchemaFormatter(java.lang.String containerType,
                                           int containerWidth)

Selects the best matching schema formatter for the provided type and width from this configuration.

参数:

containerType - the container type

containerWidth - the container width

返回:

the matching formatter, or null if none was found

getDetailFormatter

public I_CmsFormatterBean getDetailFormatter(java.lang.String type,
                                    int containerWidth)

Gets the detail formatter to use for the given type and container width.

参数:

type - the container type

containerWidth - the container width

返回:

the detail formatter to use

getDetailFormatters

public java.util.Collection<I_CmsFormatterBean> getDetailFormatters()

Gets all detail formatters.

返回:

the detail formatters

getFormatterSelection

public java.util.Map<java.lang.String,I_CmsFormatterBean> getFormatterSelection(java.lang.String containerType,
                                                                       int containerWidth)

Returns the formatters available for selection for the given container type and width.

参数:

containerType - the container type

containerWidth - the container width

返回:

the list of available formatters

getPreviewFormatter

public I_CmsFormatterBean 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.

返回:

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

hasFormatter

public boolean hasFormatter(java.lang.String containerType,
                   int containerWidth)

Returns the provided true in case this configuration has a formatter for the given type / width parameters.

参数:

containerType - the container type

containerWidth - the container width

返回:

the provided true in case this configuration has a formatter for the given type / width parameters.

hasFormatters

public boolean hasFormatters()

Returns true in case there is at least one usable formatter configured in this configuration.

返回:

true in case there is at least one usable formatter configured in this configuration

isSearchContent

public boolean isSearchContent(CmsUUID formatterStructureId)

Returns true in case this configuration contains a formatter with the provided structure id that has been configured for including the formatted content in the online search.

参数:

formatterStructureId -

返回:

true in case this configuration contains a formatter with the provided structure id that has been configured for including the formatted content in the online search