CmsJspTagInfo

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - org.opencms.jsp.CmsJspTagInfo

所有已实现的接口:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class CmsJspTagInfo
extends javax.servlet.jsp.tagext.TagSupport
```
Provides access to OpenCms and System related information.
This tag supports the following special "property" values:
- opencms.version returns the current OpenCms version, e.g. 8.0.0.
- opencms.url returns the current request URL, e.g. http://localhost:8080/opencms/opencms/index.jsp.
- opencms.uri returns the current request URI, e.g. /opencms/opencms/index.jsp.
- opencms.webapp returns the name of the OpenCms web application, e.g. opencms.
- opencms.webbasepath returns the name of system path to the OpenCms web application, e.g. C:\Java\Tomcat\webapps\opencms\.
- opencms.request.uri returns the name of the currently requested URI in the OpenCms VFS, e.g. /index.jsp.
- opencms.request.element.uri returns the name of the currently processed element, which might be a sub-element like a template part, in the OpenCms VFS, e.g. /system/modules/org.opencms.welcome/jsptemplates/welcome.jsp.
- opencms.request.folder returns the name of the parent folder of the currently requested URI in the OpenCms VFS, e.g. /.
- opencms.request.encoding returns the content encoding that has been set for the currently requested resource, e.g. ISO-8859-1.
- opencms.title (since 8.0.0) returns the title of the document that should be used for the HTML title tag. This is useful for container detail pages, in which case it will return the Title of the detail, not the container page. Otherwise it just returns the value of the Title property.
- opencms.description (since 9.0.1)
- opencms.keywords (since 9.0.1)
All other property values that are passes to the tag as routed to a standard System.getProperty(value) call, so you can also get information about the Java VM environment, using values like java.vm.version or os.name.
If the given property value does not match a key from the special OpenCms values and also not the system values, a (String) message is returned with a formatted error message.
从以下版本开始:

6.0.0

另请参阅:
序列化表格

字段概要
- 从类继承的字段 javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- 从接口继承的字段 javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- 从接口继承的字段 javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器
构造器和说明

CmsJspTagInfo()

构造器
构造器和说明
`CmsJspTagInfo()`

方法概要

方法
限定符和类型	方法和说明
`int`	`doStartTag()`
`static java.lang.String`	`getDescriptionInfo(CmsFlexController controller, javax.servlet.http.HttpServletRequest req)` Returns the description of a page delivered from OpenCms, usually used for the `description` metatag of a HTML page.
`static java.lang.String`	`getKeywordsInfo(CmsFlexController controller, javax.servlet.http.HttpServletRequest req)` Returns the keywords of a page delivered from OpenCms, usually used for the `keywords` metatag of a HTML page.
`java.lang.String`	`getProperty()` Returns the selected info property.
`static java.lang.String`	`getTitleInfo(CmsFlexController controller, javax.servlet.http.HttpServletRequest req)` Returns the title of a page delivered from OpenCms, usually used for the `<title>` tag of a HTML page.
`static java.lang.String`	`infoTagAction(java.lang.String property, javax.servlet.http.HttpServletRequest req)` Returns the selected info property value based on the provided parameters.
`void`	`release()`
`void`	`setProperty(java.lang.String name)` Sets the info property name.

从类继承的方法 javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

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

- 构造器详细资料
  - CmsJspTagInfo
```
public CmsJspTagInfo()
```
- 方法详细资料
  - getDescriptionInfo
```
public static java.lang.String getDescriptionInfo(CmsFlexController controller,
                                  javax.servlet.http.HttpServletRequest req)
```
    Returns the description of a page delivered from OpenCms, usually used for the description metatag of a HTML page.
    If no description information has been found, the empty String "" is returned.
    
    参数:
    controller - the current OpenCms request controller
    req - the current request
    
    返回:
    the description of a page delivered from OpenCms
  - getKeywordsInfo
```
public static java.lang.String getKeywordsInfo(CmsFlexController controller,
                               javax.servlet.http.HttpServletRequest req)
```
    Returns the keywords of a page delivered from OpenCms, usually used for the keywords metatag of a HTML page.
    If no description information has been found, the empty String "" is returned.
    
    参数:
    controller - the current OpenCms request controller
    req - the current request
    
    返回:
    the description of a page delivered from OpenCms
  - getTitleInfo
```
public static java.lang.String getTitleInfo(CmsFlexController controller,
                            javax.servlet.http.HttpServletRequest req)
```
    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.
    
    参数:
    controller - the current OpenCms request controller
    req - the current request
    
    返回:
    the title of a page delivered from OpenCms
  - infoTagAction
```
public static java.lang.String infoTagAction(java.lang.String property,
                             javax.servlet.http.HttpServletRequest req)
```
    Returns the selected info property value based on the provided parameters.
    
    参数:
    property - the info property to look up
    req - the currents request
    
    返回:
    the looked up property value
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    指定者:
    
    doStartTag 在接口中 javax.servlet.jsp.tagext.Tag
    
    覆盖:
    
    doStartTag 在类中 javax.servlet.jsp.tagext.TagSupport
    
    抛出:
    
    javax.servlet.jsp.JspException
    另请参阅:
    Tag.doStartTag()
  - getProperty
```
public java.lang.String getProperty()
```
    Returns the selected info property.
    
    返回:
    the selected info property
  - release
```
public void release()
```
    指定者:
    
    release 在接口中 javax.servlet.jsp.tagext.Tag
    
    覆盖:
    
    release 在类中 javax.servlet.jsp.tagext.TagSupport
    
    另请参阅:
    Tag.release()
  - setProperty
```
public void setProperty(java.lang.String name)
```
    Sets the info property name.
    
    参数:
    name - the info property name to set

类 CmsJspTagInfo

字段概要

从类继承的字段 javax.servlet.jsp.tagext.TagSupport

从接口继承的字段 javax.servlet.jsp.tagext.IterationTag

从接口继承的字段 javax.servlet.jsp.tagext.Tag

构造器概要

方法概要

从类继承的方法 javax.servlet.jsp.tagext.TagSupport

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

构造器详细资料

CmsJspTagInfo

方法详细资料

getDescriptionInfo

getKeywordsInfo

getTitleInfo

infoTagAction

doStartTag

getProperty

release

setProperty