CmsJspStandardContextBean

java.lang.Object
- org.opencms.jsp.util.CmsJspStandardContextBean

```
public final class CmsJspStandardContextBean
extends java.lang.Object
```
Allows convenient access to the most important OpenCms functions on a JSP page, indented to be used from a JSP with the JSTL or EL.
This bean is available by default in the context of an OpenCms managed JSP.

从以下版本开始:

8.0

嵌套类概要

嵌套类
限定符和类型类和说明

static class CmsJspStandardContextBean.TemplateBean
Bean containing a template name and URI.

嵌套类
限定符和类型	类和说明
`static class`	`CmsJspStandardContextBean.TemplateBean` Bean containing a template name and URI.

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ATTRIBUTE_CMS_OBJECT` The attribute name of the cms object.
`static java.lang.String`	`ATTRIBUTE_NAME` The attribute name of the standard JSP context bean.
`protected static org.apache.commons.logging.Log`	`LOG` The logger instance for this class.
`protected CmsObject`	`m_cms` OpenCms user context.

方法概要

方法
限定符和类型	方法和说明
`CmsJspStandardContextBean`	`createCopy()` Returns a copy of this JSP context bean.
`java.lang.String`	`elementCachingHash()` Returns a caching hash specific to the element, it's properties and the current container width.
`CmsContainerBean`	`getContainer()` Returns the container the currently rendered element is part of.
`CmsResource`	`getDetailContent()` Returns the current detail content, or `null` if no detail content is requested.
`CmsUUID`	`getDetailContentId()` Returns the structure id of the current detail content, or `null` if no detail content is requested.
`java.lang.String`	`getDetailContentSitePath()` Returns the detail content site path.
`CmsContainerPageBean`	`getDetailOnlyPage()` Returns the detail only page.
`CmsContainerElementBean`	`getElement()` Returns the currently rendered element.
`java.lang.Object`	`getFunction()` Returns a map which allows access to dynamic function beans using the JSP EL.
`java.util.Map<java.lang.String,java.lang.String>`	`getFunctionDetail()` Returns a lazy map which computes the detail page link as a value when given the name of a (named) dynamic function as a key.
`java.util.Map<CmsJspContentAccessBean,CmsDynamicFunctionFormatWrapper>`	`getFunctionFormatFromContent()` Returns a lazy map which creates a wrapper object for a dynamic function format when given an XML content as a key.
`static CmsJspStandardContextBean`	`getInstance(javax.servlet.ServletRequest req)` Creates a new instance of the standard JSP context bean.
`boolean`	`getIsEditMode()` Checks if the current request should be direct edit enabled.
`boolean`	`getIsOnlineProject()` Returns if the current project is the online project.
`java.util.Locale`	`getLocale()` Returns the current locale.
`CmsContainerPageBean`	`getPage()` Returns the currently displayed container page.
`java.util.Map<java.lang.String,java.lang.String>`	`getPreviewFormatter()` JSP EL accessor method for retrieving the preview formatters.
`CmsRequestContext`	`getRequestContext()` Returns the request context.
`java.lang.String`	`getSubSitePath()` Returns the subsite path for the currently requested URI.
`CmsJspStandardContextBean.TemplateBean`	`getTemplate()` Gets a bean containing information about the current template.
`java.lang.String`	`getTitle()` Returns the title of a page delivered from OpenCms, usually used for the `<title>` tag of a HTML page.
`CmsJspVfsAccessBean`	`getVfs()` Returns an initialized VFS access bean.
`java.util.Locale`	`getWorkplaceLocale()` Returns the workplace locale from the current user's settings.
`boolean`	`isDetailPageAvailable()` Checks whether a detail page is available for the container element.
`boolean`	`isDetailRequest()` Returns `true` if this is a request to a detail resource, `false` otherwise.
`boolean`	`isEdited()` Returns the flag to indicate if in drag and drop mode.
`protected CmsDynamicFunctionBean`	`readDynamicFunctionBean(java.lang.String configuredName)` Reads a dynamic function bean, given its name in the module configuration.
`void`	`setContainer(CmsContainerBean container)` Sets the container the currently rendered element is part of.
`void`	`setDetailOnlyPage(CmsContainerPageBean detailOnlyPage)` Sets the detail only page.
`void`	`setEdited(boolean edited)` Sets the flag to indicate if in drag and drop mode.
`void`	`setElement(CmsContainerElementBean element)` Sets the currently rendered element.
`void`	`setPage(CmsContainerPageBean page)` Sets the currently displayed container page.
`void`	`updateCmsObject(CmsObject cms)` Updates the internally stored OpenCms user context.
`void`	`updateRequestData(CmsFlexRequest cmsFlexRequest)` Updates the standard context bean from the request.

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

- 字段详细资料
  - ATTRIBUTE_CMS_OBJECT
```
public static final java.lang.String ATTRIBUTE_CMS_OBJECT
```
    The attribute name of the cms object.
    
    另请参阅:
    常量字段值
  - ATTRIBUTE_NAME
```
public static final java.lang.String ATTRIBUTE_NAME
```
    The attribute name of the standard JSP context bean.
    
    另请参阅:
    常量字段值
  - LOG
```
protected static final org.apache.commons.logging.Log LOG
```
    The logger instance for this class.
  - m_cms
```
protected CmsObject m_cms
```
    OpenCms user context.
- 方法详细资料
  - getInstance
```
public static CmsJspStandardContextBean getInstance(javax.servlet.ServletRequest req)
```
    Creates a new instance of the standard JSP context bean.
    To prevent multiple creations of the bean during a request, the OpenCms request context attributes are used to cache the created VFS access utility bean.
    
    参数:
    req - the current servlet request
    
    返回:
    a new instance of the standard JSP context bean
  - createCopy
```
public CmsJspStandardContextBean createCopy()
```
    Returns a copy of this JSP context bean.
    
    返回:
    a copy of this JSP context bean
  - elementCachingHash
```
public java.lang.String elementCachingHash()
```
    Returns a caching hash specific to the element, it's properties and the current container width.
    
    返回:
    the caching hash
  - getContainer
```
public CmsContainerBean getContainer()
```
    Returns the container the currently rendered element is part of.
    
    返回:
    the currently the currently rendered element is part of
  - getDetailContent
```
public CmsResource getDetailContent()
```
    Returns the current detail content, or null if no detail content is requested.
    
    返回:
    the current detail content, or null if no detail content is requested.
  - getDetailContentId
```
public CmsUUID getDetailContentId()
```
    Returns the structure id of the current detail content, or null if no detail content is requested.
    
    返回:
    the structure id of the current detail content, or null if no detail content is requested.
  - getDetailContentSitePath
```
public java.lang.String getDetailContentSitePath()
```
    Returns the detail content site path. Returns null if not available.
    
    返回:
    the detail content site path
  - getDetailOnlyPage
```
public CmsContainerPageBean getDetailOnlyPage()
```
    Returns the detail only page.
    
    返回:
    the detail only page
  - getElement
```
public CmsContainerElementBean getElement()
```
    Returns the currently rendered element.
    
    返回:
    the currently rendered element
  - getFunction
```
public java.lang.Object getFunction()
```
    Returns a map which allows access to dynamic function beans using the JSP EL.
    When given a key, the returned map will look up the corresponding dynamic function in the module configuration.
    
    返回:
    a map which allows access to dynamic function beans
  - getFunctionDetail
```
public java.util.Map<java.lang.String,java.lang.String> getFunctionDetail()
```
    Returns a lazy map which computes the detail page link as a value when given the name of a (named) dynamic function as a key.
    
    返回:
    a lazy map for computing function detail page links
  - getFunctionFormatFromContent
```
public java.util.Map<CmsJspContentAccessBean,CmsDynamicFunctionFormatWrapper> getFunctionFormatFromContent()
```
    Returns a lazy map which creates a wrapper object for a dynamic function format when given an XML content as a key.
    
    返回:
    a lazy map for accessing function formats for a content
  - getIsEditMode
```
public boolean getIsEditMode()
```
    Checks if the current request should be direct edit enabled. Online-, history-requests, previews and temporary files will not be editable.
    
    返回:
    true if the current request should be direct edit enabled
  - getIsOnlineProject
```
public boolean getIsOnlineProject()
```
    Returns if the current project is the online project.
    
    返回:
    true if the current project is the online project
  - getLocale
```
public java.util.Locale getLocale()
```
    Returns the current locale.
    
    返回:
    the current locale
  - getPage
```
public CmsContainerPageBean getPage()
```
    Returns the currently displayed container page.
    
    返回:
    the currently displayed container page
  - getPreviewFormatter
```
public java.util.Map<java.lang.String,java.lang.String> getPreviewFormatter()
```
    JSP EL accessor method for retrieving the preview formatters.
    
    返回:
    a lazy map for accessing preview formatters
  - getRequestContext
```
public CmsRequestContext getRequestContext()
```
    Returns the request context.
    
    返回:
    the request context
  - getSubSitePath
```
public java.lang.String getSubSitePath()
```
    Returns the subsite path for the currently requested URI.
    
    返回:
    the subsite path
  - getTemplate
```
public CmsJspStandardContextBean.TemplateBean getTemplate()
```
    Gets a bean containing information about the current template.
    
    返回:
    the template information bean
  - getTitle
```
public java.lang.String getTitle()
```
    Returns the title of a page delivered from OpenCms, usually used for the <title> tag of a HTML page.
    If no title information has been found, the empty String "" is returned.
    
    返回:
    the title of the current page
  - getVfs
```
public CmsJspVfsAccessBean getVfs()
```
    Returns an initialized VFS access bean.
    
    返回:
    an initialized VFS access bean
  - getWorkplaceLocale
```
public java.util.Locale getWorkplaceLocale()
```
    Returns the workplace locale from the current user's settings.
    
    返回:
    returns the workplace locale from the current user's settings
  - isDetailPageAvailable
```
public boolean isDetailPageAvailable()
```
    Checks whether a detail page is available for the container element.
    
    返回:
    true if there is a detail page for the container element
  - isDetailRequest
```
public boolean isDetailRequest()
```
    Returns true if this is a request to a detail resource, false otherwise.
    Same as to check if getDetailContent() is null.
    
    返回:
    true if this is a request to a detail resource, false otherwise
  - isEdited
```
public boolean isEdited()
```
    Returns the flag to indicate if in drag and drop mode.
    
    返回:
    true if in drag and drop mode
  - setContainer
```
public void setContainer(CmsContainerBean container)
```
    Sets the container the currently rendered element is part of.
    
    参数:
    container - the container the currently rendered element is part of
  - setDetailOnlyPage
```
public void setDetailOnlyPage(CmsContainerPageBean detailOnlyPage)
```
    Sets the detail only page.
    
    参数:
    detailOnlyPage - the detail only page to set
  - setEdited
```
public void setEdited(boolean edited)
```
    Sets the flag to indicate if in drag and drop mode.
    
    参数:
    edited - true if in drag and drop mode
  - setElement
```
public void setElement(CmsContainerElementBean element)
```
    Sets the currently rendered element.
    
    参数:
    element - the currently rendered element to set
  - setPage
```
public void setPage(CmsContainerPageBean page)
```
    Sets the currently displayed container page.
    
    参数:
    page - the currently displayed container page to set
  - updateCmsObject
```
public void updateCmsObject(CmsObject cms)
```
    Updates the internally stored OpenCms user context.
    
    参数:
    cms - the new OpenCms user context
  - updateRequestData
```
public void updateRequestData(CmsFlexRequest cmsFlexRequest)
```
    Updates the standard context bean from the request.
    
    参数:
    cmsFlexRequest - the request from which to update the data
  - readDynamicFunctionBean
```
protected CmsDynamicFunctionBean readDynamicFunctionBean(java.lang.String configuredName)
                                                  throws CmsException
```
    Reads a dynamic function bean, given its name in the module configuration.
    
    参数:
    configuredName - the name of the dynamic function in the module configuration
    
    返回:
    the dynamic function bean for the dynamic function configured under that name
    
    抛出:
    
    CmsException - if something goes wrong

类 CmsJspStandardContextBean

嵌套类概要

字段概要

方法概要

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

字段详细资料

ATTRIBUTE_CMS_OBJECT

ATTRIBUTE_NAME

LOG

m_cms

方法详细资料

getInstance

createCopy

elementCachingHash

getContainer

getDetailContent

getDetailContentId

getDetailContentSitePath

getDetailOnlyPage

getElement

getFunction

getFunctionDetail

getFunctionFormatFromContent

getIsEditMode

getIsOnlineProject

getLocale

getPage

getPreviewFormatter

getRequestContext

getSubSitePath

getTemplate

getTitle

getVfs

getWorkplaceLocale

isDetailPageAvailable

isDetailRequest

isEdited

setContainer

setDetailOnlyPage

setEdited

setElement

setPage

updateCmsObject

updateRequestData

readDynamicFunctionBean