CmsJspTagProperty

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> opencms >> flex >> [ jsp overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.opencms.flex.jsp.CmsJspTagProperty

SOURCE |

Download com.opencms.flex.jsp.CmsJspTagProperty

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opencms.flex.jsp
Class CmsJspTagProperty

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.opencms.flex.jsp.CmsJspTagProperty

All Implemented Interfaces:: javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, 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.
{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

Version:: $Revision: 1.9.2.1 $

Field Summary

private static int DEBUG


static java.util.List m_actionValue
          array list for fast lookup

static java.lang.String[] m_actionValues
          static array of the possible "file" properties

private java.lang.String m_defaultValue


private boolean m_escapeHtml


private java.lang.String m_propertyFile


private java.lang.String m_propertyName


static java.lang.String USE_ELEMENT_URI


static java.lang.String USE_PARENT


static java.lang.String USE_SEARCH


static java.lang.String USE_SEARCH_ELEMENT_URI


static java.lang.String USE_SEARCH_PARENT


static java.lang.String USE_SEARCH_THIS


static java.lang.String USE_SEARCH_URI


static java.lang.String USE_THIS


static java.lang.String 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()
          Default processing of the start tag, returning SKIP_BODY.

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()
          Release state.

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

m_propertyName

private java.lang.String m_propertyName

m_propertyFile

private java.lang.String m_propertyFile

m_defaultValue

private java.lang.String m_defaultValue

m_escapeHtml

private boolean m_escapeHtml

USE_URI

public static final java.lang.String USE_URI

See Also:: Constant Field Values

USE_PARENT

public static final java.lang.String USE_PARENT

See Also:: Constant Field Values

USE_SEARCH

public static final java.lang.String USE_SEARCH

See Also:: Constant Field Values

USE_SEARCH_URI

public static final java.lang.String USE_SEARCH_URI

See Also:: Constant Field Values

USE_SEARCH_PARENT

public static final java.lang.String USE_SEARCH_PARENT

See Also:: Constant Field Values

USE_ELEMENT_URI

public static final java.lang.String USE_ELEMENT_URI

See Also:: Constant Field Values

USE_THIS

public static final java.lang.String USE_THIS

See Also:: Constant Field Values

USE_SEARCH_ELEMENT_URI

public static final java.lang.String USE_SEARCH_ELEMENT_URI

See Also:: Constant Field Values

USE_SEARCH_THIS

public static final java.lang.String USE_SEARCH_THIS

See Also:: Constant Field Values

DEBUG

private static final int DEBUG

See Also:: Constant Field Values

m_actionValues

public static final java.lang.String[] m_actionValues

static array of the possible "file" properties

m_actionValue

public static final java.util.List m_actionValue

array list for fast lookup

Constructor Detail