Package org.opencms.jsp
The implementation of the OpenCms JSP tag library, with some additional utility classes to
help in JSP scriplet code and navigation building.
Most of the classes in this package implement the <cms:>
taglib.
To access the exact same functionality using scriptlets, obtain an instance
of a
from the current JSP.
Using the action element you can also access the current users OpenCms context
in a CmsJspActionElement
, by using CmsObject
.CmsJspBean.getCmsObject()
To aid in template navigation building, have a look at the
which provides a large selection of methods
to easily create dynamic navigations.CmsJspNavBuilder
- Since:
- 6.0.0
- See Also:
CmsObject
,CmsResourceTypeJsp
,CmsJspLoader
-
Interface Summary Interface Description I_CmsJspJsonContext Interface implemented by JSON tags.I_CmsJspTagParamParent Interface for tag handlers implementing valid parent tags for <c:param>.I_CmsResourceContainer Provides access to a
object that was previously loaded by a parent tag.CmsResource
I_CmsXmlContentContainer Provides access to a
document that was previously loaded by a parent tag.I_CmsXmlDocument
-
Class Summary Class Description A_CmsJspJsonTag Abstract superclass that handles the common behavior of the jsonarray/jsonobject/jsonvalue tags.CmsContentInfoBean A container to store information about a collector's result.CmsContentLoadCollectorInfo Bean containing the data needed to call a collector.CmsJspActionElement Bean to be used in JSP scriptlet code that provides direct access to the functionality offered by the OpenCms taglib.CmsJspBean Superclass for OpenCms JSP beans that provides convient access to OpenCms core and VFS functionality.CmsJspImageScalerTagSupport Abstract parent for all JSP tags dealing with image scaling, defines some common image scaler properties and corresponding getters/setters that may be used by extending classes.CmsJspLoginBean Provides convenient wrappers useful to create user login pages.CmsJspLoginPersistingBean Login bean which sets a cookie that can be used byCmsPersistentLoginAuthorizationHandler
to automatically log the user back in when his session has expired.CmsJspNavBuilder Bean to provide a convenient way to build navigation structures based on the
.CmsJspNavElement
CmsJspNavBuilder.NavContext Navigation builder context.CmsJspNavElement Bean to collect navigation information from a resource in the OpenCms VFS.CmsJspResourceWrapper Wrapper subclass of CmsResource with some convenience methods.CmsJspScopedVarBodyTagSuport Parent for body tags that require support for setting scoped variables to the JSP page context.CmsJspTagAddParams This tag is used to dynamically add request parameters which are available during the execution of its body.CmsJspTagAddParams.ParamState Keeps track of the runtime state of a single execution of this tag.CmsJspTagBundle Provides tag access to OpenCms resource bundles.CmsJspTagContainer Provides access to the page container elements.CmsJspTagContentAccess Used to access XML content item information from the current open<cms:contentload>
tag using JSP page context and the JSP EL.CmsJspTagContentCheck Used to check the availablity of an XML content item for conditional display.CmsJspTagContentInfo Used to access and display XML content item information from the VFS.CmsJspTagContentLoad Implementation of the<cms:contentload/>
tag, used to access and display XML content item information from the VFS.CmsJspTagContentLoop Used to loop through the element values of an XML content item.CmsJspTagContentShow Used to access and display XML content item information from the VFS.CmsJspTagDecorate Implements the<cms:decorate></cms:decorate>
tag to decorate HTML content with configurated decoration maps.CmsJspTagDevice This class provides a<cms:device type="...">
-Tag with the attributetype
to specify the device.CmsJspTagDisplay The 'display' tag can be used to display a single resource using a formatter.CmsJspTagDisplayFormatter The tag 'displayFormatter' can be used to add a formatter resource type pairing to the surrounding 'display' tag.CmsJspTagEdit This tag is used to attach an edit provider to a snippet of HTML.CmsJspTagEditable Implementation of the<cms:editable/>
tag.CmsJspTagElementSetting Provides access to the settings of an ADE container element.CmsJspTagEnableAde Implementation of the<enable-ade/>
tag.CmsJspTagEnableListAdd Generates a special HTML element which enables the 'create list element' dialog for a set of types when used in a formatter.CmsJspTagExport Allows to have certain JSP code on a JSP not processed by OpenCms, which can be useful in case you want to create a JSP page using the OpenCms static export.CmsJspTagFormatter Implementation of the<cms:formatter var="..." val="..." />
tag, used to access and display XML content item information in a formatter.CmsJspTagHeadIncludes This tag includes required CSS or JavaScript resources that are to be places in the HTML head.CmsJspTagImage Creates HTML code for <img src> tags that use the OpenCms image scaling capabilities.CmsJspTagInclude Implementation of the<cms:include/>
tag, used to include another OpenCms managed resource in a JSP.CmsJspTagIncludeTEI This is a TagExtraInfo evaluation class that checks the attibutes of the<cms:include />
tag.CmsJspTagInfo Provides access to OpenCms and System related information.CmsJspTagJQuery Deprecated. jQuery should be provided by standard includes directly in the template.CmsJspTagJsonArray Tag for defining a JSON array.CmsJspTagJsonObject Tag for defining a JSON object.CmsJspTagJsonValue Adds a JSON value to the surrounding context and/or stores it as a variable in the page context.CmsJspTagLabel Provides access to the labels stored in the language files of the OpenCms workplace.CmsJspTagLink Implements the<cms:link>[filename]</cms:link>
tag to add OpenCms managed links to a JSP page, required for link management and the static export to work properly.CmsJspTagLink.Parameters Parameters for the link tag.CmsJspTagMap Builds a java.util.Map isntance with string keys and values from nested param tags, then stores it in a page context variable whose name is supplied by the user.CmsJspTagNavigation Implementation of the<cms:navigation var="..." />
tag, used to access OpenCms VFS navigation information on a JSP with the EL.CmsJspTagNoCache A tag to prevent caching by the browser.CmsJspTagParam A handler for <param> that accepts attributes as Strings and evaluates them as expressions at runtime.CmsJspTagParse Implements the<cms:parse></cms:parse>
tag to allow parsing of nested HTML with theA_CmsConfiguredHtmlParser
} implementation specified by the "parserClass" attribute.CmsJspTagPdf JSP tag to generate a link to a PDF produced from a given XML content.CmsJspTagPdfThumbnail JSP tag to generate a link to a PDF produced from a given XML content.CmsJspTagProperty Provides access to the properties of a resource in the OpenCms VFS .CmsJspTagProperty.CmsPropertyAction Tells for which resource properties should be looked up (with or without searching), depending on theCmsJspTagProperty.FileUse
.CmsJspTagResourceAccess Used to access resource information from the current open<cms:resourceload>
tag using JSP page context and the JSP EL.CmsJspTagResourceLoad Implementation of the<cms:resourceload/>
tag, used to access and display resource information from the VFS.CmsJspTagScaleImage This tag allows using the OpenCms native image scaling mechanism within JSP.CmsJspTagSearch This tag is used to easily create a search form for a Solr search within a JSP.CmsJspTagSecureParams This tag is used to enable parameter escaping for a single Flex Request.CmsJspTagSetBundle Set bundle tag using OpenCms' bundle loader mechanism.CmsJspTagSimpleDisplay The 'simpledisplay' tag can be used to display a single resource using a formatter.CmsJspTagSimpleSearch This tag is used to easily create a search form for a Solr search within a JSP.CmsJspTagTemplate Used to select various template elements form a JSP template that is included in another file.CmsJspTagUgc Jsp tag to initialize an editing session for user generated content.CmsJspTagUser Provides access to the data of the currently logged in user.CmsJspTagUserTracking Implementation of the<cms:usertracking/>
tag.CmsJspXmlContentBean Provides access to XML content tag functions from scriptlet code.Messages Convenience class to access the localized messages of this OpenCms package. -
Enum Summary Enum Description CmsJspNavBuilder.Visibility The visibility mode.CmsJspTagLink.Type Link type.CmsJspTagNavigation.Type Constants fortype
attribute interpretation.