Package org.opencms.ade.detailpage

Class CmsDefaultDetailPageHandler

java.lang.Object

org.opencms.ade.detailpage.CmsDefaultDetailPageHandler

All Implemented Interfaces:

I_CmsDetailPageHandler, I_CmsConfigurationParameterHandler

public class CmsDefaultDetailPageHandler
extends Object
implements I_CmsDetailPageHandler

This class uses information from the detail page information stored in the sitemap to find/recognize the detail pages for a given resource.

Since:

8.0.0

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsDefaultDetailPageHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds the configuration parameter.
Collection<String>	getAllDetailPages(CmsObject cms, int resType)	Gets the all detail pages.
CmsParameterConfiguration	getConfiguration()	Gets the configuration.
String	getDetailPage(CmsADEManager manager, CmsObject cms, String contentRootPath, String originPath, String targetDetailPage)	Gets the detail page for a content element.
String	getDetailPage(CmsObject cms, String rootPath, String linkSource, String targetDetailPage)	Gets the detail page to use for a detail resource.
void	initConfiguration()	Inits the configuration.
void	initialize(CmsObject offlineCms, CmsObject onlineCms)	Initialize.
boolean	isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsDefaultDetailPageHandler

public CmsDefaultDetailPageHandler()

Constructor.

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Adds the configuration parameter.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the param name

paramValue - the param value

See Also:

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

getAllDetailPages

public Collection<String> getAllDetailPages(CmsObject cms,
 int resType)
                                     throws CmsException

Gets the all detail pages.

Specified by:

getAllDetailPages in interface I_CmsDetailPageHandler

Parameters:

cms - the cms

resType - the res type

Returns:

the all detail pages

Throws:

CmsException - the cms exception

See Also:

• I_CmsDetailPageHandler.getAllDetailPages(org.opencms.file.CmsObject, int)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Gets the configuration.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the configuration

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getDetailPage

public String getDetailPage(CmsADEManager manager,
 CmsObject cms,
 String contentRootPath,
 String originPath,
 String targetDetailPage)

Gets the detail page for a content element.

Parameters:

manager - the ADE manager instance.

cms - the CMS context

contentRootPath - the element's root path

originPath - the site path from which the detail content is being linked

targetDetailPage - the target detail page to use

Returns:

the detail page for the content element

getDetailPage

public String getDetailPage(CmsObject cms,
 String rootPath,
 String linkSource,
 String targetDetailPage)

Gets the detail page to use for a detail resource.

Specified by:

getDetailPage in interface I_CmsDetailPageHandler

Parameters:

cms - the cms

rootPath - the root path

linkSource - the link source

targetDetailPage - the target detail page

Returns:

the detail page

See Also:

• I_CmsDetailPageHandler.getDetailPage(org.opencms.file.CmsObject, java.lang.String, java.lang.String, java.lang.String)

initConfiguration

public void initConfiguration()

Inits the configuration.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject offlineCms,
 CmsObject onlineCms)

Initialize.

Specified by:

initialize in interface I_CmsDetailPageHandler

Parameters:

offlineCms - the offline cms

onlineCms - the online cms

See Also:

• I_CmsDetailPageHandler.initialize(org.opencms.file.CmsObject, org.opencms.file.CmsObject)

isValidDetailPage

public boolean isValidDetailPage(CmsObject cms,
 CmsResource page,
 CmsResource detailRes)

Checks whether the given detail page is valid for the given resource.

Specified by:

isValidDetailPage in interface I_CmsDetailPageHandler

Parameters:

cms - the CMS context

page - the detail page

detailRes - the detail resource

Returns:

true if the given detail page is valid