org.opencms.jsp

类 CmsJspTagNavigation

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.opencms.jsp.CmsJspScopedVarBodyTagSuport

org.opencms.jsp.CmsJspTagNavigation

所有已实现的接口:

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

public class CmsJspTagNavigation
extends CmsJspScopedVarBodyTagSuport

Implementation of the <cms:navigation var="..." /> tag, used to access OpenCms VFS navigation information on a JSP with the EL.

从以下版本开始:

8.0

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsJspTagNavigation.Type Constants for type attribute interpretation.

字段概要

字段

限定符和类型	字段和说明
protected CmsObject	m_cms The CmsObject for the current user.
protected java.lang.String	m_endLevel The optional end level for the navigation.
protected java.lang.String	m_param The optional parameter for the navigation.
protected java.lang.String	m_resource The optional resource for the navigation.
protected java.lang.String	m_startLevel The optional start level for the navigation.
protected CmsJspTagNavigation.Type	m_type The navigation type.

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

bodyContent

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

id, pageContext

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器

构造器和说明
CmsJspTagNavigation() Empty constructor, required for JSP tags.
CmsJspTagNavigation(javax.servlet.jsp.PageContext context) Constructor used for scriptlet code.

方法概要

方法

限定符和类型	方法和说明
int	doStartTag()
java.lang.String	getEndLevel() Returns the (optional) end level for the navigation.
java.lang.String	getParam() Returns the optional parameter for the navigation.
java.lang.String	getResource() Returns the (optional) resource for the navigation.
java.lang.String	getStartLevel() Returns the (optional) start level for the navigation.
java.lang.String	getType() Returns the selected navigation type.
protected void	init() Initializes this formatter tag.
void	release()
void	setEndLevel(java.lang.String endLevel) Sets the (optional) end level for the navigation.
void	setParam(java.lang.String param) Sets the optional parameter for the navigation.
void	setResource(java.lang.String resource) Sets the (optional) resource for the navigation.
void	setStartLevel(java.lang.String startLevel) Sets the (optional) start level for the navigation.
void	setType(java.lang.String type) Sets the selected navigation type.

从类继承的方法 org.opencms.jsp.CmsJspScopedVarBodyTagSuport

getScope, getScopeAsInt, getScopeAsString, getScopeInt, getVar, isScopeVarSet, setScope, setVar, storeAttribute, storeAttribute

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

doAfterBody, doEndTag, doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

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

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

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

从接口继承的方法 javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

字段详细资料

m_cms

protected transient CmsObject m_cms

The CmsObject for the current user.

m_endLevel

protected java.lang.String m_endLevel

The optional end level for the navigation.

m_param

protected java.lang.String m_param

The optional parameter for the navigation.

m_resource

protected java.lang.String m_resource

The optional resource for the navigation.

m_startLevel

protected java.lang.String m_startLevel

The optional start level for the navigation.

m_type

protected CmsJspTagNavigation.Type m_type

The navigation type.

构造器详细资料

CmsJspTagNavigation

public CmsJspTagNavigation()

Empty constructor, required for JSP tags.

CmsJspTagNavigation

public CmsJspTagNavigation(javax.servlet.jsp.PageContext context)

Constructor used for scriptlet code.

参数:

context - the JSP page context

方法详细资料

doStartTag

public int doStartTag()
               throws CmsIllegalArgumentException

指定者:

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

覆盖:

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

抛出:

CmsIllegalArgumentException

另请参阅:

Tag.doStartTag()

getEndLevel

public java.lang.String getEndLevel()

Returns the (optional) end level for the navigation.

返回:

the (optional) end level for the navigation

getParam

public java.lang.String getParam()

Returns the optional parameter for the navigation.

返回:

the optional parameter for the navigation

getResource

public java.lang.String getResource()

Returns the (optional) resource for the navigation.

返回:

the (optional) resource for the navigation

getStartLevel

public java.lang.String getStartLevel()

Returns the (optional) start level for the navigation.

返回:

the (optional) start level for the navigation

getType

public java.lang.String getType()

Returns the selected navigation type.

This must match one of the elements in CmsJspTagNavigation.Type.

返回:

the selected navigation type

release

public void release()

指定者:

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

覆盖:

release 在类中 CmsJspScopedVarBodyTagSuport

另请参阅:

Tag.release()

setEndLevel

public void setEndLevel(java.lang.String endLevel)

Sets the (optional) end level for the navigation.

参数:

endLevel - the (optional) end level for the navigation

setParam

public void setParam(java.lang.String param)

Sets the optional parameter for the navigation.

参数:

param - the optional parameter for the navigation to set

setResource

public void setResource(java.lang.String resource)

Sets the (optional) resource for the navigation.

参数:

resource - the (optional) resource for the navigation

setStartLevel

public void setStartLevel(java.lang.String startLevel)

Sets the (optional) start level for the navigation.

参数:

startLevel - the (optional) start level for the navigation

setType

public void setType(java.lang.String type)

Sets the selected navigation type.

This must match one of the elements in CmsJspTagNavigation.Type.

参数:

type - the navigation type to set

init

protected void init()

Initializes this formatter tag.