Package org.opencms.jsp
Class CmsJspTagNavigation
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- javax.servlet.jsp.tagext.BodyTagSupport
-
- org.opencms.jsp.CmsJspScopedVarBodyTagSuport
-
- org.opencms.jsp.CmsJspTagNavigation
-
- All Implemented Interfaces:
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.- Since:
- 8.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsJspTagNavigation.Type
Constants fortype
attribute interpretation.
-
Field Summary
Fields Modifier and Type Field Description 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.util.Locale
m_locale
The locale for which the property should be read.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.
-
Constructor Summary
Constructors Constructor Description CmsJspTagNavigation()
Empty constructor, required for JSP tags.CmsJspTagNavigation(javax.servlet.jsp.PageContext context)
Constructor used for scriptlet code.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
setLocale(java.lang.String locale)
Sets the locale for which the property should be read.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.-
Methods inherited from class org.opencms.jsp.CmsJspScopedVarBodyTagSuport
getScope, getScopeAsInt, getScopeAsString, getScopeInt, getVar, isScopeVarSet, setScope, setVar, storeAttribute, storeAttribute
-
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doEndTag, doInitBody, getBodyContent, getPreviousOut, setBodyContent
-
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
-
-
-
-
Field Detail
-
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.
-
m_locale
protected java.util.Locale m_locale
The locale for which the property should be read.
-
-
Constructor Detail
-
CmsJspTagNavigation
public CmsJspTagNavigation()
Empty constructor, required for JSP tags.
-
CmsJspTagNavigation
public CmsJspTagNavigation(javax.servlet.jsp.PageContext context)
Constructor used for scriptlet code.- Parameters:
context
- the JSP page context
-
-
Method Detail
-
doStartTag
public int doStartTag() throws CmsIllegalArgumentException
- Specified by:
doStartTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
- Throws:
CmsIllegalArgumentException
- See Also:
Tag.doStartTag()
-
getEndLevel
public java.lang.String getEndLevel()
Returns the (optional) end level for the navigation.- Returns:
- the (optional) end level for the navigation
-
getParam
public java.lang.String getParam()
Returns the optional parameter for the navigation.- Returns:
- the optional parameter for the navigation
-
getResource
public java.lang.String getResource()
Returns the (optional) resource for the navigation.- Returns:
- the (optional) resource for the navigation
-
getStartLevel
public java.lang.String getStartLevel()
Returns the (optional) start level for the navigation.- Returns:
- 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
.- Returns:
- the selected navigation type
-
release
public void release()
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classCmsJspScopedVarBodyTagSuport
- See Also:
Tag.release()
-
setEndLevel
public void setEndLevel(java.lang.String endLevel)
Sets the (optional) end level for the navigation.- Parameters:
endLevel
- the (optional) end level for the navigation
-
setLocale
public void setLocale(java.lang.String locale)
Sets the locale for which the property should be read.- Parameters:
locale
- the locale for which the property should be read.
-
setParam
public void setParam(java.lang.String param)
Sets the optional parameter for the navigation.- Parameters:
param
- the optional parameter for the navigation to set
-
setResource
public void setResource(java.lang.String resource)
Sets the (optional) resource for the navigation.- Parameters:
resource
- the (optional) resource for the navigation
-
setStartLevel
public void setStartLevel(java.lang.String startLevel)
Sets the (optional) start level for the navigation.- Parameters:
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
.- Parameters:
type
- the navigation type to set
-
init
protected void init()
Initializes this formatter tag.
-
-