CmsTemplateContextManager

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

public class CmsTemplateContextManager
extends java.lang.Object

Manager class for template context providers.

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ATTR_TEMPLATE_BEAN` A bean containing information about the selected template.
`static java.lang.String`	`ATTR_TEMPLATE_CONTEXT` The request attribute in which the template context is stored.
`static java.lang.String`	`ATTR_TEMPLATE_NAME` Attribute name which contains the template name for non-dynamically selected templates.
`static java.lang.String`	`ATTR_TEMPLATE_RESOURCE` Attribute name for the template resource.
`static java.lang.String`	`DYNAMIC_TEMPLATE_PREFIX` The prefix used in the template property to activate dynamic template selection.

构造器概要

构造器
构造器和说明

CmsTemplateContextManager(CmsObject cms)
Creates a new instance.

构造器
构造器和说明
`CmsTemplateContextManager(CmsObject cms)` Creates a new instance.

方法概要

方法
限定符和类型	方法和说明
`protected CmsXmlContentProperty`	`createTemplateContextsPropertyDefinition(I_CmsTemplateContextProvider contextProvider, java.util.Locale locale)` Creates the setting definition for the templateContexts setting.
`CmsTemplateContextInfo`	`getContextInfoBean(CmsObject cms, javax.servlet.http.HttpServletRequest request)` Creates a bean with information about the current template context, for use in the client-side code.
`CmsTemplateContext`	`getTemplateContext(java.lang.String providerName, CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)` Gets the template context to use.
`I_CmsTemplateContextProvider`	`getTemplateContextProvider(CmsObject cms, java.lang.String path)` Gets the template context provider for a given path.
`I_CmsTemplateContextProvider`	`getTemplateContextProvider(java.lang.String providerName)` Retrieves an instance of a template context provider given its name (optionally prefixed by the 'dynamic:' prefix).
`static boolean`	`hasPropertyPrefix(java.lang.String propertyValue)` Checks if the property value starts with the prefix which marks a dynamic template provider.
`static boolean`	`isProvider(java.lang.String templatePath)` Checks if a template property value refers to a template context provider.
`java.lang.String`	`readPropertyFromTemplate(CmsObject cms, CmsResource res, java.lang.String propertyName, java.lang.String fallbackValue)` Utility method which either reads a property from the template used for a specific resource, or from the template context provider used for the resource if available.
`static java.lang.String`	`removePropertyPrefix(java.lang.String propertyValue)` Removes the prefix which marks a property value as a dynamic template provider.
`protected java.util.Map<java.lang.String,CmsDefaultSet<java.lang.String>>`	`safeGetAllowedContextMap()` Helper method for getting the forbidden contexts from the resource manager without a try-catch block.
`boolean`	`shouldShowType(CmsTemplateContext context, java.lang.String typeName)` Helper method to check whether a given type should not be shown in a context.

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

- 字段详细资料
  - ATTR_TEMPLATE_BEAN
```
public static final java.lang.String ATTR_TEMPLATE_BEAN
```
    A bean containing information about the selected template.
    
    另请参阅:
    常量字段值
  - ATTR_TEMPLATE_CONTEXT
```
public static final java.lang.String ATTR_TEMPLATE_CONTEXT
```
    The request attribute in which the template context is stored.
    
    另请参阅:
    常量字段值
  - ATTR_TEMPLATE_NAME
```
public static final java.lang.String ATTR_TEMPLATE_NAME
```
    Attribute name which contains the template name for non-dynamically selected templates.
    
    另请参阅:
    常量字段值
  - ATTR_TEMPLATE_RESOURCE
```
public static final java.lang.String ATTR_TEMPLATE_RESOURCE
```
    Attribute name for the template resource.
    
    另请参阅:
    常量字段值
  - DYNAMIC_TEMPLATE_PREFIX
```
public static final java.lang.String DYNAMIC_TEMPLATE_PREFIX
```
    The prefix used in the template property to activate dynamic template selection.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsTemplateContextManager
```
public CmsTemplateContextManager(CmsObject cms)
```
    Creates a new instance.
    
    参数:
    cms - the CMS context to use
- 方法详细资料
  - hasPropertyPrefix
```
public static boolean hasPropertyPrefix(java.lang.String propertyValue)
```
    Checks if the property value starts with the prefix which marks a dynamic template provider.
    
    参数:
    propertyValue - the property value to check
    
    返回:
    true if the value has the format of a dynamic template provider
  - isProvider
```
public static boolean isProvider(java.lang.String templatePath)
```
    Checks if a template property value refers to a template context provider.
    
    参数:
    templatePath - the template property value
    
    返回:
    true if this value refers to a template context provider
  - removePropertyPrefix
```
public static java.lang.String removePropertyPrefix(java.lang.String propertyValue)
```
    Removes the prefix which marks a property value as a dynamic template provider.
    
    参数:
    propertyValue - the value from which to remove the prefix
    
    返回:
    the string with the prefix removed
  - getContextInfoBean
```
public CmsTemplateContextInfo getContextInfoBean(CmsObject cms,
                                        javax.servlet.http.HttpServletRequest request)
```
    Creates a bean with information about the current template context, for use in the client-side code.
    
    参数:
    cms - the current CMS context
    request - the current request
    
    返回:
    the bean with the template context information
  - getTemplateContext
```
public CmsTemplateContext getTemplateContext(java.lang.String providerName,
                                    CmsObject cms,
                                    javax.servlet.http.HttpServletRequest request,
                                    CmsResource resource)
```
    Gets the template context to use.
    
    参数:
    providerName - the name of the template context provider
    cms - the current CMS context
    request - the current request
    resource - the current resource
    
    返回:
    the current template context
  - getTemplateContextProvider
```
public I_CmsTemplateContextProvider getTemplateContextProvider(CmsObject cms,
                                                      java.lang.String path)
                                                        throws CmsException
```
    Gets the template context provider for a given path.
    
    参数:
    cms - the current CMS context
    path - the path for which the template context provider should be determined
    
    返回:
    the template context provider for the given path
    
    抛出:
    
    CmsException - if something goes wrong
  - getTemplateContextProvider
```
public I_CmsTemplateContextProvider getTemplateContextProvider(java.lang.String providerName)
```
    Retrieves an instance of a template context provider given its name (optionally prefixed by the 'dynamic:' prefix).
    
    参数:
    providerName - the name of the provider
    
    返回:
    an instance of the provider class
  - readPropertyFromTemplate
```
public java.lang.String readPropertyFromTemplate(CmsObject cms,
                                        CmsResource res,
                                        java.lang.String propertyName,
                                        java.lang.String fallbackValue)
```
    Utility method which either reads a property from the template used for a specific resource, or from the template context provider used for the resource if available.
    
    参数:
    cms - the CMS context to use
    res - the resource from whose template or template context provider the property should be read
    propertyName - the property name
    fallbackValue - the fallback value
    
    返回:
    the property value
  - shouldShowType
```
public boolean shouldShowType(CmsTemplateContext context,
                     java.lang.String typeName)
```
    Helper method to check whether a given type should not be shown in a context.
    
    参数:
    context - the template context
    typeName - the type name
    
    返回:
    true if the context does not prohibit showing the type
  - createTemplateContextsPropertyDefinition
```
protected CmsXmlContentProperty createTemplateContextsPropertyDefinition(I_CmsTemplateContextProvider contextProvider,
                                                             java.util.Locale locale)
```
    Creates the setting definition for the templateContexts setting.
    
    参数:
    contextProvider - the context provider
    locale - the current locale
    
    返回:
    the setting definition
  - safeGetAllowedContextMap
```
protected java.util.Map<java.lang.String,CmsDefaultSet<java.lang.String>> safeGetAllowedContextMap()
```
    Helper method for getting the forbidden contexts from the resource manager without a try-catch block.
    
    返回:
    the forbidden context map

类 CmsTemplateContextManager

字段概要

构造器概要

方法概要

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

字段详细资料

ATTR_TEMPLATE_BEAN

ATTR_TEMPLATE_CONTEXT

ATTR_TEMPLATE_NAME

ATTR_TEMPLATE_RESOURCE

DYNAMIC_TEMPLATE_PREFIX

构造器详细资料

CmsTemplateContextManager

方法详细资料

hasPropertyPrefix

isProvider

removePropertyPrefix

getContextInfoBean

getTemplateContext

getTemplateContextProvider

getTemplateContextProvider

readPropertyFromTemplate

shouldShowType

createTemplateContextsPropertyDefinition

safeGetAllowedContextMap