|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
org.opencms.jsp.CmsJspTagProperty
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:
There are also some deprecated options for the "file" value that are still supported but should not longer be used:
Field Summary | |
static java.util.List |
ACTION_VALUES_LIST
Array list for fast lookup. |
static java.lang.String |
USE_ELEMENT_URI
Accessor constant: Use element uri. |
static java.lang.String |
USE_PARENT
Accessor constant: Use parent (same as USE_URI). |
static java.lang.String |
USE_SEARCH
Accessor constant: Use search (same as USE_SEARCH_URI). |
static java.lang.String |
USE_SEARCH_ELEMENT_URI
Accessor constant: Use search element uri. |
static java.lang.String |
USE_SEARCH_PARENT
Accessor constant: Search parent (same as USE_SEARCH_URI). |
static java.lang.String |
USE_SEARCH_THIS
Accessor constant: Use seach this (same as USE_SEARCH_ELEMENT_URI). |
static java.lang.String |
USE_SEARCH_URI
Accessor constant: Search uri. |
static java.lang.String |
USE_THIS
Accessor constant: Use this (same as USE_ELEMENT_URI). |
static java.lang.String |
USE_URI
Accessor constant: Use uri. |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
CmsJspTagProperty()
|
Method Summary | |
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.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. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String USE_ELEMENT_URI
public static final java.lang.String USE_PARENT
public static final java.lang.String USE_SEARCH
public static final java.lang.String USE_SEARCH_ELEMENT_URI
public static final java.lang.String USE_SEARCH_PARENT
public static final java.lang.String USE_SEARCH_THIS
public static final java.lang.String USE_SEARCH_URI
public static final java.lang.String USE_THIS
public static final java.lang.String USE_URI
public static final java.util.List ACTION_VALUES_LIST
Constructor Detail |
public CmsJspTagProperty()
Method Detail |
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
property
- the property to look upaction
- the search actiondefaultValue
- the default valueescape
- if the result html should be escaped or notreq
- the current request
null
if not found (and no
defaultValue provided)
CmsException
- if something goes wrongpublic int doStartTag() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- in case somethins goes wrongTag.doStartTag()
public java.lang.String getDefault()
public java.lang.String getEscapeHtml()
public java.lang.String getFile()
public java.lang.String getName()
public void release()
Tag.release()
public void setDefault(java.lang.String def)
This is used if a selected property is not found.
def
- the default valuepublic void setEscapeHtml(java.lang.String value)
value
- should be "true"
or "false"
(all values other then "true"
are
considered to be false)public void setFile(java.lang.String file)
file
- the file namepublic void setName(java.lang.String name)
name
- the property name to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |