Package org.opencms.jsp

Interface I_CmsElementMarker

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsDefaultElementMarker

public interface I_CmsElementMarker
extends I_CmsConfigurationParameterHandler

Plug-in interface for emitting a marker into the page output around each element while the container and display tags render a page.

The markers are written at the same positions as the ADE edit markers; an implementation may use them for purposes such as building a content summary of the rendered page. The implementation is optional and configured through the system configuration (the edit-marker-handler element). When none is configured the no-op CmsDefaultElementMarker is used, so nothing is emitted and normal rendering is unaffected. The configured instance is created once at startup and reached through OpenCms.getElementMarker().

Implementations are parameter handlers, so they can be configured with nested <param> elements that are read from and written back to the configuration.

Since:

22.0.0

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
void	addEndMarker(jakarta.servlet.jsp.PageContext context, CmsContainerElementBean element)	Adds the end marker for an element to the page output.
void	addStartMarker(jakarta.servlet.jsp.PageContext context, CmsContainerElementBean element, I_CmsFormatterBean formatter)	Adds the start marker for an element to the page output.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

addEndMarker

void addEndMarker(jakarta.servlet.jsp.PageContext context,
 CmsContainerElementBean element)

Adds the end marker for an element to the page output.

Parameters:

context - the page context

element - the element

addStartMarker

void addStartMarker(jakarta.servlet.jsp.PageContext context,
 CmsContainerElementBean element,
 I_CmsFormatterBean formatter)

Adds the start marker for an element to the page output.

Parameters:

context - the page context

element - the element

formatter - the formatter the element is rendered with, or null