org.opencms.jsp

类 CmsJspTagProperty

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.opencms.jsp.CmsJspTagProperty

所有已实现的接口:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CmsJspTagProperty
extends javax.servlet.jsp.tagext.TagSupport

Provides access to the properties of a resource in the OpenCms VFS .

Of particular importance is the setting of the file attribute, which can take the following values.

This attribute allows you to specify where to search for the property.
The following values are supported:

uri (default)

Look up the property on the file with the uri requested by the user.

search.uri or search

Look up the property by also checking all parent folders for the property, starting with the file with uri requested by the user and going "upward" if the property was not found there.

element.uri

Look up the property on the currently processed sub - element. This is useful in templates or other pages that consist of many elements.

search.element.uri

Look up the property by also checking all parent folders for the property, starting with the file with the currently processed sub - element and going "upward" if the property was not found there.

sitemap

reads from the current sitemap entry

search.sitemap

Look up the property by also checking all parent sitemap entries for the property, starting with the current sitemap entry and going "upward" if the property was not found there.

container

reads from the current container element

{some-file-uri}

Look up the property on that exact file uri in the OpenCms VFS, fallback if no other valid option is selected for the file attribute.

There are also some deprecated options for the "file" value that are still supported but should not longer be used:

parent

same as uri

search-parent

same as search.uri

this

same as element.uri

search-this

same as search.element.uri

从以下版本开始:

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

构造器概要

构造器

构造器和说明
CmsJspTagProperty()

方法概要

方法

限定符和类型	方法和说明
int	doEndTag()
int	doStartTag()
java.lang.String	getDefault() Returns the default value.
java.lang.String	getEscapeHtml() The value of the escape html flag.
java.lang.String	getFile() Returns the file name.
java.lang.String	getName() Returns the property name.
static java.util.Map<java.lang.String,java.lang.String>	propertiesTagAction(java.lang.String action, javax.servlet.ServletRequest req) Internal action method.
static java.lang.String	propertyTagAction(java.lang.String property, java.lang.String action, java.lang.String defaultValue, boolean escape, javax.servlet.ServletRequest req) Internal action method.
void	release()
void	setDefault(java.lang.String def) Sets the default value.
void	setEscapeHtml(java.lang.String value) Set the escape html flag.
void	setFile(java.lang.String file) Sets the file name.
void	setName(java.lang.String name) Sets the property name.

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

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CmsJspTagProperty

public CmsJspTagProperty()

方法详细资料

propertiesTagAction

public static java.util.Map<java.lang.String,java.lang.String> propertiesTagAction(java.lang.String action,
                                                                   javax.servlet.ServletRequest req)
                                                                            throws CmsException

Internal action method.

参数:

action - the search action

req - the current request

返回:

String the value of the property or null if not found (and no defaultValue provided)

抛出:

CmsException - if something goes wrong

propertyTagAction

public static java.lang.String propertyTagAction(java.lang.String property,
                                 java.lang.String action,
                                 java.lang.String defaultValue,
                                 boolean escape,
                                 javax.servlet.ServletRequest req)
                                          throws CmsException

Internal action method.

参数:

property - the property to look up

action - the search action

defaultValue - the default value

escape - if the result html should be escaped or not

req - the current request

返回:

the value of the property or null if not found (and no defaultValue was provided)

抛出:

CmsException - if something goes wrong

doEndTag

public int doEndTag()

指定者:

doEndTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doEndTag 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

TagSupport.doEndTag()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

指定者:

doStartTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doStartTag 在类中 javax.servlet.jsp.tagext.TagSupport

返回:

SKIP_BODY

抛出:

javax.servlet.jsp.JspException

另请参阅:

Tag.doStartTag()

getDefault

public java.lang.String getDefault()

Returns the default value.

返回:

the default value

getEscapeHtml

public java.lang.String getEscapeHtml()

The value of the escape html flag.

返回:

the value of the escape html flag

getFile

public java.lang.String getFile()

Returns the file name.

返回:

the file name

getName

public java.lang.String getName()

Returns the property name.

返回:

String the property name

release

public void release()

指定者:

release 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

release 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

Tag.release()

setDefault

public void setDefault(java.lang.String def)

Sets the default value.

This is used if a selected property is not found.

参数:

def - the default value

setEscapeHtml

public void setEscapeHtml(java.lang.String value)

Set the escape html flag.

参数:

value - should be "true" or "false" (all values other then "true" are considered to be false)

setFile

public void setFile(java.lang.String file)

Sets the file name.

参数:

file - the file name

setName

public void setName(java.lang.String name)

Sets the property name.

参数:

name - the property name to set