Package org.opencms.gwt

Class CmsTemplateFinder

java.lang.Object

org.opencms.gwt.CmsTemplateFinder

public class CmsTemplateFinder
extends Object

Utility class for getting information about available templates.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsObject	m_cms	The cms context.
static final String	MACRO_TEMPLATEPATH	Macro which is used in template.provider property to be substituted with the template path.

Constructor Summary

Constructors

Constructor	Description
CmsTemplateFinder(CmsObject cms)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected CmsObject	getCmsObject()	Gets the CMS context to use.
Map<String,CmsClientTemplateBean>	getTemplates()	Returns the available templates.

Methods inherited from class java.lang.Object

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

Field Details

MACRO_TEMPLATEPATH

public static final String MACRO_TEMPLATEPATH

Macro which is used in template.provider property to be substituted with the template path.

See Also:

• Constant Field Values

m_cms

protected CmsObject m_cms

The cms context.

Constructor Details

CmsTemplateFinder

public CmsTemplateFinder(CmsObject cms)

Creates a new instance.

Parameters:

cms - the cms context to use

Method Details

getTemplates

public Map<String,CmsClientTemplateBean> getTemplates()
                                               throws CmsException

Returns the available templates.

Returns:

the available templates

Throws:

CmsException - if something goes wrong

getCmsObject

protected CmsObject getCmsObject()

Gets the CMS context to use.

Returns:

the CMS context to use