| 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.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.
|
| Modifier and Type | Method and 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.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,
CmsResource res,
java.util.Locale locale,
javax.servlet.ServletRequest req)
Returns the nested formatters of the given resource.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Map<java.lang.String,CmsXmlContentProperty> |
CmsADEManager.getFormatterSettings(CmsObject cms,
I_CmsFormatterBean mainFormatter,
CmsResource res,
java.util.Locale locale,
javax.servlet.ServletRequest req)
Returns the settings configured for the given formatter.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
| Constructor and Description |
|---|
CmsFormatterConfigurationCacheState(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters)
Creates a new instance.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
CmsJspTagDisplay.displayAction(CmsContainerElementBean element,
I_CmsFormatterBean formatter,
boolean editable,
boolean canCreate,
boolean canDelete,
java.lang.String creationSiteMap,
java.lang.String postCreateHandler,
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.
|
static void |
CmsJspTagDisplay.displayAction(CmsResource elementResource,
I_CmsFormatterBean formatter,
java.util.Map<java.lang.String,java.lang.String> settings,
boolean editable,
boolean canCreate,
boolean canDelete,
java.lang.String creationSiteMap,
java.lang.String postCreateHandler,
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.
|
| Modifier and Type | Method and 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. |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsJspStandardContextBean.CmsContainerElementWrapper.initSettings(CmsObject cms,
I_CmsFormatterBean formatterBean,
java.util.Locale locale,
javax.servlet.ServletRequest request,
java.util.Map<java.lang.String,java.lang.String> settingPresets) |
| Modifier and Type | Method and 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.
|
| Modifier and Type | Class and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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,
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.util.Set<java.lang.String> types,
int width)
Checks whether the given formatter bean matches the container types, width and nested flag.
|
| Modifier and Type | Method and 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.
|
| Constructor and Description |
|---|
CmsSchemaFormatterBeanWrapper(CmsObject cms,
I_CmsFormatterBean wrappedBean,
I_CmsXmlContentHandler contentHandler,
CmsResource resource)
Creates a new wrapper instance.
|