Uses of Interface
org.opencms.xml.containerpage.I_CmsFormatterBean

Packages that use I_CmsFormatterBean

Package	Description
org.opencms.ade.configuration	Contains the ade configuration classes.
org.opencms.ade.configuration.formatters	Classes for handling formatter configurations.
org.opencms.ade.containerpage	Contains the container page editor service classes.
org.opencms.gwt	Provides core support for GWT.
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
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.

Uses of I_CmsFormatterBean in org.opencms.ade.configuration

Methods in org.opencms.ade.configuration that return I_CmsFormatterBean

Modifier and Type	Method	Description
I_CmsFormatterBean	CmsADEConfigData.findFormatter(java.lang.String name)	Gets the 'best' formatter for the given name.
I_CmsFormatterBean	CmsADEConfigData.findFormatter(java.lang.String name, boolean noWarn)	Gets the 'best' formatter for the given name.
I_CmsFormatterBean	CmsADEConfigData.findFormatter(CmsUUID id)	Gets the 'best' formatter for the given ID.
I_CmsFormatterBean	CmsADEConfigData.findFormatter(CmsUUID id, boolean noWarn)	Gets the 'best' formatter for the given ID.

Methods in org.opencms.ade.configuration that return types with arguments of type I_CmsFormatterBean

Modifier and Type	Method	Description
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsADEConfigData.getActiveFormatters()	Gets the active external (non-schema) formatters for this sub-sitemap.
java.util.List<I_CmsFormatterBean>	CmsADEConfigData.getActiveFormattersWithContainerType(java.lang.String containerType)	Gets the active formatters for a given container type.
java.util.List<I_CmsFormatterBean>	CmsADEConfigData.getActiveFormattersWithDisplayType(java.lang.String displayType)	Gets the active formatters for a given display type.
java.util.List<I_CmsFormatterBean>	CmsADEConfigData.getDisplayFormatters(CmsObject cms)	Returns all available display formatters.
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsADEConfigData.getInactiveFormatters()	Gets the map of external (non-schema) formatters which are inactive in this sub-sitemap.
java.util.List<I_CmsFormatterBean>	CmsADEManager.getNestedFormatters(CmsObject cms, CmsADEConfigData config, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req)	Returns the nested formatters of the given resource.

Methods in org.opencms.ade.configuration with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsADEManager.getFormatterSettings(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean mainFormatter, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req)	Returns the settings configured for the given formatter which should be editable via ADE.

Uses of I_CmsFormatterBean in org.opencms.ade.configuration.formatters

Methods in org.opencms.ade.configuration.formatters that return I_CmsFormatterBean

Modifier and Type	Method	Description
I_CmsFormatterBean	CmsFormatterBeanParser.parse(CmsXmlContent content, java.lang.String location, java.lang.String id)	Reads the formatter bean from the given XML content.
protected I_CmsFormatterBean	CmsFormatterConfigurationCache.readFormatter(CmsUUID structureId)	Reads a formatter given its structure id and returns it, or null if the formatter couldn't be read.

Methods in org.opencms.ade.configuration.formatters that return types with arguments of type I_CmsFormatterBean

Modifier and Type	Method	Description
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.
java.util.Map<CmsUUID,I_CmsFormatterBean>	CmsFormatterIndex.getFormattersWithAdditionalKeys()	Gets the final map of active formatters, with their formatter keys replaced by the total set of keys under which they should be available.

Methods in org.opencms.ade.configuration.formatters with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
void	CmsFormatterIndex.addFormatter(I_CmsFormatterBean formatter)	Adds the given formatter.

Method parameters in org.opencms.ade.configuration.formatters with type arguments of type I_CmsFormatterBean

Modifier and Type	Method	Description
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.
void	CmsFormatterIndex.removeIf(java.util.function.Predicate<I_CmsFormatterBean> condition)	Removes all formatters matching the given predicate

Constructor parameters in org.opencms.ade.configuration.formatters with type arguments of type I_CmsFormatterBean

Constructor	Description
CmsFormatterConfigurationCacheState(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters)	Creates a new instance.

Uses of I_CmsFormatterBean in org.opencms.ade.containerpage

Methods in org.opencms.ade.containerpage that return I_CmsFormatterBean

Modifier and Type	Method	Description
static I_CmsFormatterBean	CmsElementUtil.getFormatterForContainer(CmsObject cms, CmsContainerElementBean element, CmsContainer container, CmsADEConfigData config, CmsADESessionCache cache)	Returns the formatter bean for the given element and container.

Methods in org.opencms.ade.containerpage with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
static java.util.function.Function<java.lang.String,java.lang.String>	CmsElementUtil.createStringTemplateSource(I_CmsFormatterBean formatter, com.google.common.base.Supplier<CmsXmlContent> contentSupplier)	Helper method to create a string template source for a given formatter and content.
java.util.Map<java.lang.String,java.lang.String>	CmsSettingTranslator.translateSettings(I_CmsFormatterBean formatter, java.util.Map<java.lang.String,java.lang.String> settings)	Translates the settings for the given formatter in the context of the current sitemap.

Uses of I_CmsFormatterBean in org.opencms.gwt

Methods in org.opencms.gwt with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
static java.util.Map<java.lang.String,java.lang.String>	CmsDefaultResourceStatusProvider.getFormatterInfo(CmsObject cms, I_CmsFormatterBean bean)	Gets the additional information related to the formatter.

Uses of I_CmsFormatterBean in org.opencms.jsp

Methods in org.opencms.jsp that return I_CmsFormatterBean

Modifier and Type	Method	Description
static I_CmsFormatterBean	CmsJspTagContainer.ensureValidFormatterSettings(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth)	Ensures the appropriate formatter configuration ID is set in the element settings.
static I_CmsFormatterBean	CmsJspTagContainer.getFormatterConfigurationForElement(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth)	Returns the formatter configuration for the given element.

Methods in org.opencms.jsp with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
static void	CmsJspTagDisplay.displayAction(CmsResource elementResource, I_CmsFormatterBean formatter, java.util.Map<java.lang.String,java.lang.String> settings, boolean cacheable, boolean editable, boolean canCreate, boolean canDelete, java.lang.String creationSiteMap, java.lang.String postCreateHandler, java.lang.String uploadFolder, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)	Includes the formatter rendering the given element.
static void	CmsJspTagDisplay.displayAction(CmsContainerElementBean element, I_CmsFormatterBean formatter, boolean cacheable, boolean editable, boolean canCreate, boolean canDelete, java.lang.String creationSiteMap, java.lang.String postCreateHandler, java.lang.String uploadFolder, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)	Includes the formatter rendering the given element.
static void	CmsJspTagDisplay.displayAction(CmsContainerElementBean element, I_CmsFormatterBean formatter, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)	Includes the formatter rendering the given element.
protected static java.util.List<java.lang.String>	CmsJspTagHeadIncludes.getHeadIncludes(I_CmsFormatterBean formatter, java.lang.String type)	Gets the head includes for the given formatter bean.
protected static java.lang.String	CmsJspTagHeadIncludes.getInlineData(I_CmsFormatterBean formatter, java.lang.String type)	Gets the inline CSS/Javascrip for the given formatter bean.
static java.lang.String	CmsJspTagDisplay.getSettingKeyForMatchingFormatterPrefix(CmsADEConfigData config, I_CmsFormatterBean formatter, java.lang.String settingKey)	If the setting key starts with the key or id of the given formatter, returns the remaining suffix, else null.

Uses of I_CmsFormatterBean in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return I_CmsFormatterBean

Modifier and Type	Method	Description
protected I_CmsFormatterBean	CmsJspStandardContextBean.getElementFormatter(CmsContainerElementBean element)	Returns the formatter configuration to the given element.
protected I_CmsFormatterBean	CmsMacroFormatterResolver.getFormatterForMacro(java.lang.String macro)	Returns the formatter bean for the given macro string, or null if none available.

Methods in org.opencms.jsp.util with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
static CmsMacroResolver	CmsFormatterInfoWrapper.getMacroResolverForFormatter(CmsObject cms, I_CmsFormatterBean formatter)	Prepares the macro resolver to use for formatter info / setting info beans.
void	CmsJspStandardContextBean.CmsContainerElementWrapper.initSettings(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean formatterBean, java.util.Locale locale, javax.servlet.ServletRequest request, java.util.Map<java.lang.String,java.lang.String> settingPresets)

Method parameters in org.opencms.jsp.util with type arguments of type I_CmsFormatterBean

Modifier and Type	Method	Description
protected java.util.List<CmsFormatterInfoWrapper>	CmsJspStandardContextBean.wrapFormatters(java.util.Collection<? extends I_CmsFormatterBean> formatters)	Wraps a list of formatter beans for use in JSPs.

Constructors in org.opencms.jsp.util with parameters of type I_CmsFormatterBean

Constructor	Description
CmsFormatterInfoWrapper(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean formatter)	Creates a new instance.

Uses of I_CmsFormatterBean in org.opencms.widgets

Methods in org.opencms.widgets with parameters of type I_CmsFormatterBean

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

Uses of I_CmsFormatterBean in org.opencms.xml.containerpage

Classes in org.opencms.xml.containerpage that implement I_CmsFormatterBean

Modifier and Type	Class	Description
class	CmsFlexFormatterBean	Formatter configuration for flex formatters.
class	CmsFormatterBean	A bean containing formatter configuration data as strings.
class	CmsFunctionFormatterBean	A bean containing formatter configuration data as strings.
class	CmsMacroFormatterBean	Formatter configuration for macro formatters.
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.

Methods in org.opencms.xml.containerpage that return I_CmsFormatterBean

Modifier and Type	Method	Description
I_CmsFormatterBean	CmsFormatterConfiguration.getDefaultFormatter(java.lang.String containerTypes, int containerWidth)	Selects the best matching formatter for the provided type and width from this configuration.
I_CmsFormatterBean	CmsFormatterConfiguration.getDefaultSchemaFormatter(java.lang.String containerTypes, int containerWidth)	Selects the best matching schema formatter for the provided type and width from this configuration.
I_CmsFormatterBean	CmsFormatterConfiguration.getDetailFormatter(java.lang.String types, int containerWidth)	Gets the detail formatter to use for the given type and container width.
I_CmsFormatterBean	CmsFormatterConfiguration.getDisplayFormatter()	Returns the display formatter for this type.
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	CmsADESessionCache.getRecentFormatter(java.lang.String resType, CmsContainer container, CmsADEConfigData config)	Returns the least recently used matching formatter for the given resource type.

Methods in org.opencms.xml.containerpage that return types with arguments of type I_CmsFormatterBean

Modifier and Type	Method	Description
java.util.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getAllFormatters()	Gets a list of all defined formatters.
java.util.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getAllMatchingFormatters(java.lang.String containerTypes, 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.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getDisplayFormatters()	Returns the available display formatters.
java.util.Map<java.lang.String,I_CmsFormatterBean>	CmsFormatterConfiguration.getFormatterSelection(java.lang.String containerTypes, int containerWidth)	Returns the formatters available for selection for the given container type and width.
java.util.Map<java.lang.String,I_CmsFormatterBean>	CmsFormatterConfiguration.getFormatterSelectionByKeyOrId(java.lang.String containerTypes, int containerWidth)
java.util.List<I_CmsFormatterBean>	CmsFormatterConfiguration.getFormattersForKey(java.lang.String key)	Gets the list of formatters for the given key or id (also supports schema_formatter ids).
java.util.Optional<I_CmsFormatterBean>	CmsFormatterBean.withKeys(java.util.Collection<java.lang.String> keys)
java.util.Optional<I_CmsFormatterBean>	CmsSchemaFormatterBeanWrapper.withKeys(java.util.Collection<java.lang.String> keys)
java.util.Optional<I_CmsFormatterBean>	I_CmsFormatterBean.withKeys(java.util.Collection<java.lang.String> keys)	If possible, returns a formatter bean that is basically a copy of this one, but has the keys supplied as a parameter.

Methods in org.opencms.xml.containerpage with parameters of type I_CmsFormatterBean

Modifier and Type	Method	Description
boolean	CmsFormatterConfiguration.IsDetail.apply(I_CmsFormatterBean formatter)
boolean	CmsFormatterConfiguration.IsDisplay.apply(I_CmsFormatterBean formatter)
boolean	CmsFormatterConfiguration.IsSchemaFormatter.apply(I_CmsFormatterBean formatter)
int	CmsFormatterConfiguration.FormatterComparator.compare(I_CmsFormatterBean first, I_CmsFormatterBean second)
void	CmsContainerElementBean.initSettings(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean formatterBean, java.util.Locale locale, javax.servlet.ServletRequest request, java.util.Map<java.lang.String,java.lang.String> presets)	Initializes the element settings.
static boolean	CmsFormatterConfiguration.matchFormatter(I_CmsFormatterBean formatter, java.lang.String types, int width)	Checks whether the given formatter bean matches the container types, width and nested flag.
static boolean	CmsFormatterConfiguration.matchFormatter(I_CmsFormatterBean formatter, java.util.Set<java.lang.String> types, int width)	Checks whether the given formatter bean matches the container types, width and nested flag.

Method parameters in org.opencms.xml.containerpage with type arguments of type I_CmsFormatterBean

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

Constructors in org.opencms.xml.containerpage with parameters of type I_CmsFormatterBean

Constructor	Description
CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource)	Creates a new wrapper instance.