CmsDefaultTemplateContextProvider

java.lang.Object
- org.opencms.loader.CmsDefaultTemplateContextProvider

所有已实现的接口:

I_CmsTemplateContextProvider
```
public class CmsDefaultTemplateContextProvider
extends java.lang.Object
implements I_CmsTemplateContextProvider
```
Example implementation of a template context provider for deciding between a desktop template and a mobile template.
The template JSP paths are read from a VFS file "/system/shared/templatecontexts.json"

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`A_HEIGHT` JSON attribute name.
`static java.lang.String`	`A_NICE_NAME` JSON attribute name.
`static java.lang.String`	`A_PATH` JSON attribute name.
`static java.lang.String`	`A_VARIANTS` JSON attribute name.
`static java.lang.String`	`A_WIDTH` JSON attribute name.
`static java.lang.String`	`PARAM_CONFIGURATION` The name for the configuration parameter which points to the template contexts configuration file.

构造器概要

构造器
构造器和说明

CmsDefaultTemplateContextProvider()
Default constructor.

构造器
构造器和说明
`CmsDefaultTemplateContextProvider()` Default constructor.

方法概要

方法
限定符和类型	方法和说明
`java.util.Map<java.lang.String,CmsTemplateContext>`	`getAllContexts()` Gets a map of all template contexts, with the template context names as keys.
`java.lang.String`	`getConfigurationPropertyPath()` Returns the absolute VFS path where the configuration property file is stored.
`java.lang.String`	`getEditorStyleSheet(CmsObject cms, java.lang.String editedResourcePath)` Returns the style sheet to be used for the editor.
`java.lang.String`	`getOverrideCookieName()` Gets the name of the cookie which should be used for overriding the template context.
`CmsTemplateContext`	`getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)` Determines the template context from the current CMS context, request, and resource.
`void`	`initialize(CmsObject cms, java.lang.String config)` Initializes the context provider using a CMS object.
`java.lang.String`	`readCommonProperty(CmsObject cms, java.lang.String propertyName, java.lang.String fallbackValue)` Gets the value which should be used instead of a property which was read from the template resource.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - A_HEIGHT
```
public static final java.lang.String A_HEIGHT
```
    JSON attribute name.
    
    另请参阅:
    常量字段值
  - A_NICE_NAME
```
public static final java.lang.String A_NICE_NAME
```
    JSON attribute name.
    
    另请参阅:
    常量字段值
  - A_PATH
```
public static final java.lang.String A_PATH
```
    JSON attribute name.
    
    另请参阅:
    常量字段值
  - A_VARIANTS
```
public static final java.lang.String A_VARIANTS
```
    JSON attribute name.
    
    另请参阅:
    常量字段值
  - A_WIDTH
```
public static final java.lang.String A_WIDTH
```
    JSON attribute name.
    
    另请参阅:
    常量字段值
  - PARAM_CONFIGURATION
```
public static final java.lang.String PARAM_CONFIGURATION
```
    The name for the configuration parameter which points to the template contexts configuration file.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsDefaultTemplateContextProvider
```
public CmsDefaultTemplateContextProvider()
```
    Default constructor.
- 方法详细资料
  - getAllContexts
```
public java.util.Map<java.lang.String,CmsTemplateContext> getAllContexts()
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Gets a map of all template contexts, with the template context names as keys.
    
    指定者:
    
    getAllContexts 在接口中 I_CmsTemplateContextProvider
    
    返回:
    the map of template context providers
    另请参阅:
    I_CmsTemplateContextProvider.getAllContexts()
  - getConfigurationPropertyPath
```
public java.lang.String getConfigurationPropertyPath()
```
    Returns the absolute VFS path where the configuration property file is stored.
    
    返回:
    the absolute VFS path where the configuration property file is stored
  - getEditorStyleSheet
```
public java.lang.String getEditorStyleSheet(CmsObject cms,
                                   java.lang.String editedResourcePath)
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Returns the style sheet to be used for the editor.
    
    指定者:
    
    getEditorStyleSheet 在接口中 I_CmsTemplateContextProvider
    
    参数:
    cms - the current CMS context
    editedResourcePath - the path of the edited resource
    
    返回:
    the path of the style sheet to be used for the resource
    另请参阅:
    I_CmsTemplateContextProvider.getEditorStyleSheet(org.opencms.file.CmsObject, java.lang.String)
  - getOverrideCookieName
```
public java.lang.String getOverrideCookieName()
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Gets the name of the cookie which should be used for overriding the template context.
    
    指定者:
    
    getOverrideCookieName 在接口中 I_CmsTemplateContextProvider
    
    返回:
    the name of the cookie used for overriding the template context
    另请参阅:
    I_CmsTemplateContextProvider.getOverrideCookieName()
  - getTemplateContext
```
public CmsTemplateContext getTemplateContext(CmsObject cms,
                                    javax.servlet.http.HttpServletRequest request,
                                    CmsResource resource)
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Determines the template context from the current CMS context, request, and resource.
    
    指定者:
    
    getTemplateContext 在接口中 I_CmsTemplateContextProvider
    
    参数:
    cms - the CMS context
    request - the current request
    resource - the resource being rendered
    
    返回:
    the current template context
    另请参阅:
    I_CmsTemplateContextProvider.getTemplateContext(org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, org.opencms.file.CmsResource)
  - initialize
```
public void initialize(CmsObject cms,
              java.lang.String config)
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Initializes the context provider using a CMS object.
    
    指定者:
    
    initialize 在接口中 I_CmsTemplateContextProvider
    
    参数:
    cms - the current CMS context
    config - the template context provider configuration
    另请参阅:
    I_CmsTemplateContextProvider.initialize(org.opencms.file.CmsObject, java.lang.String)
  - readCommonProperty
```
public java.lang.String readCommonProperty(CmsObject cms,
                                  java.lang.String propertyName,
                                  java.lang.String fallbackValue)
                                    throws CmsException
```
    从接口复制的说明: I_CmsTemplateContextProvider
    
    Gets the value which should be used instead of a property which was read from the template resource.
    This is needed because before template context providers, it was common to store template-specific configuration in a property on the template JSP. Since template context providers make the result ambiguous, this method is intended as a replacement.
    
    指定者:
    
    readCommonProperty 在接口中 I_CmsTemplateContextProvider
    
    参数:
    cms - the CMS context to use
    propertyName - the name of the property
    fallbackValue - the value to return if no value is found or an error occurs
    
    返回:
    the common property value
    
    抛出:
    
    CmsException - if something goes wrong
    另请参阅:
    I_CmsTemplateContextProvider.readCommonProperty(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

类 CmsDefaultTemplateContextProvider

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

A_HEIGHT

A_NICE_NAME

A_PATH

A_VARIANTS

A_WIDTH

PARAM_CONFIGURATION

构造器详细资料

CmsDefaultTemplateContextProvider

方法详细资料

getAllContexts

getConfigurationPropertyPath

getEditorStyleSheet

getOverrideCookieName

getTemplateContext

initialize

readCommonProperty