Package org.opencms.jsp

Class CmsDefaultElementMarker

java.lang.Object

org.opencms.jsp.CmsDefaultElementMarker

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsElementMarker

public class CmsDefaultElementMarker
extends Object
implements I_CmsElementMarker

Default I_CmsElementMarker that emits nothing.

Used when no edit-marker-handler is configured, so the container and display tags can always call the configured marker without a null check.

Since:

22.0.0

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsDefaultElementMarker()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
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.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
void	initConfiguration()	Initializes a configuration after all parameters have been added.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsDefaultElementMarker

public CmsDefaultElementMarker()

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

addEndMarker

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

Description copied from interface: I_CmsElementMarker

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

Specified by:

addEndMarker in interface I_CmsElementMarker

Parameters:

context - the page context

element - the element

See Also:

• I_CmsElementMarker.addEndMarker(jakarta.servlet.jsp.PageContext, org.opencms.xml.containerpage.CmsContainerElementBean)

addStartMarker

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

Description copied from interface: I_CmsElementMarker

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

Specified by:

addStartMarker in interface I_CmsElementMarker

Parameters:

context - the page context

element - the element

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

See Also:

• I_CmsElementMarker.addStartMarker(jakarta.servlet.jsp.PageContext, org.opencms.xml.containerpage.CmsContainerElementBean, org.opencms.xml.containerpage.I_CmsFormatterBean)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

Throws:

CmsConfigurationException - if something goes wrong

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()