CmsJspElFunctions

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

```
public final class CmsJspElFunctions
extends java.lang.Object
```
Provides utility methods to be used as functions from a JSP with the EL.

从以下版本开始:

7.0.2

另请参阅:
CmsJspContentAccessBean

方法概要

方法
限定符和类型	方法和说明
`static CmsObject`	`convertCmsObject(java.lang.Object input)` Returns an OpenCms user context created from an Object.
`static java.util.Date`	`convertDate(java.lang.Object input)` Returns a Date created from an Object.
`static java.util.List<java.lang.Object>`	`convertList(java.util.List<java.lang.Object> input, java.lang.String attributeName)` Returns a list of attribute values specified by the attribute name of the items of the given list.
`static java.util.Locale`	`convertLocale(java.lang.Object input)` Returns a Locale created from an Object.
`static javax.servlet.ServletRequest`	`convertRequest(java.lang.Object input)` Tries to convert the given input object into a request.
`static CmsResource`	`convertResource(CmsObject cms, java.lang.Object input)` Returns a resource created from an Object.
`static CmsUUID`	`convertUUID(java.lang.Object input)` Returns a CmsUUID created from an Object.
`static java.lang.String`	`escape(java.lang.String source, java.lang.String encoding)` Encodes a String in a way that is compatible with the JavaScript escape function.
`static CmsObject`	`getCmsObject(java.lang.Object input)` Returns the current OpenCms user context from the given page context.
`static java.lang.Integer`	`getListSize(java.util.List<java.lang.Object> input)` Returns the size of the given list.
`static java.lang.String`	`getNavigationUri(java.lang.Object input)` Returns the current navigation URI.
`static java.lang.String`	`getRequestLink(java.lang.String url)` Returns the link without parameters from a String that is formatted for a GET request.
`static java.lang.String`	`getRequestParam(java.lang.String url, java.lang.String paramName)` Returns the value of a parameter from a String that is formatted for a GET request.
`static CmsJspVfsAccessBean`	`getVfsAccessBean(java.lang.Object input)` Returns a JSP / EL VFS access bean.
`static java.lang.String`	`lookup(java.lang.String key, java.lang.String map)` Looks up the given key from the map that is passed as a String, and returns either the element found or the empty String.
`static java.lang.String`	`lookup(java.lang.String key, java.lang.String map, java.lang.String defaultValue)` Looks up the given key from the map that is passed as a String, and returns either the element found or the default value.
`static java.lang.String`	`stripHtml(java.lang.Object input)` Strips all HTML markup from the given input.
`static java.lang.String`	`trimToSize(java.lang.String input, int length)` Returns a substring of the source, which is at most length characters long.
`static java.lang.String`	`unescape(java.lang.String source, java.lang.String encoding)` Decodes a String in a way that is compatible with the JavaScript unescape function.

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

- 方法详细资料
  - convertCmsObject
```
public static CmsObject convertCmsObject(java.lang.Object input)
```
    Returns an OpenCms user context created from an Object.
    - If the input is already a CmsObject, it is casted and returned unchanged.
    - If the input is a ServletRequest, the OpenCms user context is read from the request context.
    - If the input is a PageContext, the OpenCms user context is read from the request of the page context.
    - Otherwise the input is converted to a String which should be a user name, and creation of a OpenCms user context with this name is attempted. Please note that this will only work if the user name is either the "Guest" user or the "Export" user.
    - If no valid OpenCms user context could be created with all of the above, then a new user context for the "Guest" user is created.
    参数:
    input - the input to create an OpenCms user context from
    
    返回:
    an OpenCms user context created from an Object
  - convertDate
```
public static java.util.Date convertDate(java.lang.Object input)
```
    Returns a Date created from an Object.
    - The Object is first checked if it is a Date already, if so it is casted and returned unchanged.
    - If not, the input is checked if it is a Long, and if so the Date is created from the Long value.
    - If it's not a Date and not a Long, the Object is transformed to a String and then it's tried to parse a Long out of the String.
    - If this fails, it is tried to parse as a Date using the default date formatting.
    - If this also fails, a new Date is returned that has been initialized with 0.
    参数:
    input - the Object to create a Date from
    
    返回:
    a Date created from the given Object
  - convertList
```
public static java.util.List<java.lang.Object> convertList(java.util.List<java.lang.Object> input,
                                           java.lang.String attributeName)
```
    Returns a list of attribute values specified by the attribute name of the items of the given list.
    
    参数:
    input - the list of objects to obtain the attribute values from
    attributeName - the name of the attribute to obtain
    
    返回:
    a list of attributes specified by the attribute name of the items of the given list
  - convertLocale
```
public static java.util.Locale convertLocale(java.lang.Object input)
```
    Returns a Locale created from an Object.
    - The Object is first checked if it is a Locale already, if so it is casted and returned.
    - If not, the input is transformed to a String and then a Locale lookup with this String is done.
    - If the locale lookup fails, the OpenCms default locale is returned.
    参数:
    input - the Object to create a Locale from
    
    返回:
    a Locale created from the given Object
  - convertRequest
```
public static javax.servlet.ServletRequest convertRequest(java.lang.Object input)
```
    Tries to convert the given input object into a request.
    This is only possible if the input object is already a request or if it is a page context.
    If everything else, this method returns null.
    
    参数:
    input - the input object to convert to a request
    
    返回:
    a request object, or null
  - convertResource
```
public static CmsResource convertResource(CmsObject cms,
                          java.lang.Object input)
                                   throws CmsException
```
    Returns a resource created from an Object.
    - If the input is already a CmsResource, it is casted to the resource and returned unchanged.
    - If the input is a String, the given OpenCms context is used to read a resource with this name from the VFS.
    - If the input is a CmsUUID, the given OpenCms context is used to read a resource with this UUID from the VFS.
    - Otherwise the input is converted to a String, and then the given OpenCms context is used to read a resource with this name from the VFS.
    参数:
    cms - the current OpenCms user context
    input - the input to create a resource from
    
    返回:
    a resource created from the given Object
    
    抛出:
    
    CmsException - in case of errors accessing the OpenCms VFS for reading the resource
  - convertUUID
```
public static CmsUUID convertUUID(java.lang.Object input)
```
    Returns a CmsUUID created from an Object.
    - The Object is first checked if it is a CmsUUID already, if so it is casted and returned.
    - If not, the input is transformed to a byte[] and a new CmsUUID is created with this byte[].
    - Otherwise the input is casted to a String and a new CmsUUID is created with this String.
    参数:
    input - the Object to create a CmsUUID from
    
    返回:
    a CmsUUID created from the given Object
  - escape
```
public static java.lang.String escape(java.lang.String source,
                      java.lang.String encoding)
```
    Encodes a String in a way that is compatible with the JavaScript escape function.
    
    参数:
    source - The text to be encoded
    encoding - the encoding type
    
    返回:
    The JavaScript escaped string
  - getCmsObject
```
public static CmsObject getCmsObject(java.lang.Object input)
```
    Returns the current OpenCms user context from the given page context.
    
    参数:
    input - the input to create a CmsObject from
    
    返回:
    the current OpenCms user context from the given page context
  - getListSize
```
public static java.lang.Integer getListSize(java.util.List<java.lang.Object> input)
```
    Returns the size of the given list.
    
    参数:
    input - the list of objects to obtain the size from
    
    返回:
    the size of the given list
  - getNavigationUri
```
public static java.lang.String getNavigationUri(java.lang.Object input)
```
    Returns the current navigation URI.
    Which can be the request URI or the VFS resource URI.
    In case a sitemap is used, the navigation URI will be the request URI, if not the VFS resource URI is returned.
    
    参数:
    input - the request convertible object to get the navigation URI from
    
    返回:
    the current navigation URI
  - getRequestLink
```
public static java.lang.String getRequestLink(java.lang.String url)
```
    Returns the link without parameters from a String that is formatted for a GET request.
    
    参数:
    url - the URL to remove the parameters from
    
    返回:
    the link without parameters
  - getRequestParam
```
public static java.lang.String getRequestParam(java.lang.String url,
                               java.lang.String paramName)
```
    Returns the value of a parameter from a String that is formatted for a GET request.
    
    参数:
    url - the URL to get the parameter value from
    paramName - the request parameter name
    
    返回:
    the value of the parameter
  - getVfsAccessBean
```
public static CmsJspVfsAccessBean getVfsAccessBean(java.lang.Object input)
```
    Returns a JSP / EL VFS access bean.
    
    参数:
    input - the Object to create a CmsObject from
    
    返回:
    a JSP / EL VFS access bean
  - lookup
```
public static java.lang.String lookup(java.lang.String key,
                      java.lang.String map)
```
    Looks up the given key from the map that is passed as a String, and returns either the element found or the empty String.
    The map String must have the form "key1:value1|key2:value2" etc.
    
    参数:
    key - the key to look up
    map - the map represented as a String
    
    返回:
    the element found in the map with the given key, or the empty String
  - lookup
```
public static java.lang.String lookup(java.lang.String key,
                      java.lang.String map,
                      java.lang.String defaultValue)
```
    Looks up the given key from the map that is passed as a String, and returns either the element found or the default value.
    The map String must have the form "key1:value1|key2:value2" etc.
    
    参数:
    key - the key to look up
    map - the map represented as a String
    defaultValue - the default value
    
    返回:
    the element found in the map with the given key, or the default value
  - stripHtml
```
public static java.lang.String stripHtml(java.lang.Object input)
```
    Strips all HTML markup from the given input.
    - In case the input is an instance of CmsJspContentAccessValueWrapper, an optimized method is used for the HTML stripping.
    - Otherwise the input is converted to a String and this String is stripped.
    参数:
    input - the input to Strip from HTML
    
    返回:
    the given input with all HTML stripped.
  - trimToSize
```
public static java.lang.String trimToSize(java.lang.String input,
                          int length)
```
    Returns a substring of the source, which is at most length characters long.
    If a char is cut, " ..." is appended to the result.
    
    参数:
    input - the string to trim
    length - the maximum length of the string to be returned
    
    返回:
    a substring of the source, which is at most length characters long
    另请参阅:
    CmsStringUtil.trimToSize(String, int, String)
  - unescape
```
public static java.lang.String unescape(java.lang.String source,
                        java.lang.String encoding)
```
    Decodes a String in a way that is compatible with the JavaScript unescape function.
    
    参数:
    source - The String to be decoded
    encoding - the encoding type
    
    返回:
    The JavaScript unescaped String

类 CmsJspElFunctions

方法概要

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

方法详细资料

convertCmsObject

convertDate

convertList

convertLocale

convertRequest

convertResource

convertUUID

escape

getCmsObject

getListSize

getNavigationUri

getRequestLink

getRequestParam

getVfsAccessBean

lookup

lookup

stripHtml

trimToSize

unescape