The OpenCms / JSP integration tag library

Loads a resource bundle to be used by its tag body.

Replaces the <fmt:bundle basename=""> tag which is not capable of using OpenCms resource bundles.

You can use <fmt:message key=""> tags inside the body of the <cms:bundle basename=""> tag as usual.

Example: <cms:link>/vfslink/to/my/index.html</cms:link>

This tag is used to enable the direct edit functionality.

It is placed in the header of a none-container-page template for most use cases.

An exeception is the use with attribute editEmpty, which is the last none-deprecated use case.

Via this tag, you can render an XML content with a given formatter from inside a (formatter) JSP.

In particular, the tag is useful for rendering list items from within a list formatter. The tag can be configured to work for contents of different type - thus it also for lists of mixed resources.

Optionally, you can display edit points at the output. They facilitate similar editing functionality as <cms:edit>.

In the body of the <cms:display> two other tags can be used

• <cms:displayFormatter>

  Via this tag you can specify which formatters are used for which content types by the <cms:display>-tag. The choice can also be performed via the displayFormatters attribute (see the attribute's description below).

  If nothing is specified, the formatter with the highest rank, from within the formatters that have "Use as display formatter" enabled, is chosen.

• <cms:param>

  This tag, contrary to it's default purpose, is used to pass element settings.

  To pass a setting, write:

  <cms:param name="settingName">settingValue</cms:param>

  The setting values specified here, overwrite the values that are possibly passed from the settings of the surrounding formatter (see the attribute passSettings.

Via this tag, you can render an XML content with a given formatter from inside a (formatter) JSP.

This tag is simpler than the <cms:display> tag in that it only allows you to specify a single formatter.

Optionally, you can display edit points at the output. They facilitate similar editing functionality as <cms:edit>.

In the body of the <cms:display> the following other tags can be used

• <cms:param>

  This tag, contrary to it's default purpose, is used to pass element settings.

  To pass a setting, write:

  <cms:param name="settingName">settingValue</cms:param>

  The setting values specified here, overwrite the values that are possibly passed from the settings of the surrounding formatter (see the attribute passSettings.

This tag can be used only inside <cms:display>. It specifies which formatter should be used to format a content of a special resource type, either using a formatter key, or the path of the formatter configuration file.

Note that alternatively, the attribute displayFormatters of the tag <cms:display> can be used to specify these formatters.

This tag provides support to generate search forms and result lists for a server-side handled Solr search. It takes an (XML or JSON) configuration file or a JSON configuration String and essentially exposes an object with the search results and also the necessary information to suitably build up your search form. It supports facets and highlighting.

If you do not specify a search index explicitly, the tag uses "Solr Offline" and "Solr Online", depending on the current project.

To get detailed information on the configuraiton options, just have a look at an XML content of type jsp-search-form or look up the JavaDoc of the JSON configuration parser org.opencms.jsp.search.config.parser.CmsJSONSearchConfigurationParser.

This tag provides support to generate search forms and result lists for a server-side handled Solr search. It takes an (XML or JSON) configuration file or a JSON configuration String and essentially exposes an object with the search results and also the necessary information to suitably build up your search form. It supports facets and highlighting.

If you do not specify a search index explicitly, the tag uses "Solr Offline" and "Solr Online", depending on the current project.

To get detailed information on the configuraiton options, just have a look at an XML content of type jsp-search-form or look up the JavaDoc of the JSON configuration parser org.opencms.jsp.search.config.parser.CmsJSONSearchConfigurationParser.

Extends the given list by adding the provided object.

The 1st parameter is the list, the 2nd the value to add.

Provides simple access to a org.opencms.jsp.util.CmsJspVfsAccessBean.

The argument object must in some way be suitable to extract a suitable instance of the org.opencms.file.CmsObject.

Hint: Easy access to the vfs access bean on a JSP is also provided via ${cms.vfs}.

Allows conversion of Long values to Dates. Can also handle Strings that represent a Long or a Date.

Example:

Returns a newly created, empty List object.

There is no way to create an empty list using standard JSTL methods, hence this function.

Encodes a String in a way similar to the JavaScript "encodeURIcomponent" function.

In order to avoid encoding hell, it's better to just use ${cms:encode(String)} on a JSP to transfer data that will be decoded using "decodeURIcomponent".

JavaScript "decodeURIcomponent" can decode Strings that have been encoded using this method, provided "UTF-8" has been used as encoding.

The 1st parameter is the String to encode, the 2nd the encoding to be used, e.g. "UTF-8".

Encodes a String in a way similar to the JavaScript "encodeURIcomponent" function, using "UTF-8" for character encoding.

JavaScript "decodeURIcomponent" can decode Strings that have been encoded using this method.

Decodes a String in a way similar to the JavaScript "decodeURIcomponent" function.

In order to avoid encoding hell, it's better to just use ${cms:decode(String)} on a JSP to transfer data that has been encoded using "encodeURIcomponent".

This method can decode Strings that have been encoded in JavaScript with "encodeURIcomponent", provided "UTF-8" is used as encoding.

The 1st parameter is the String to decode, the 2nd the encoding the string was encoded with, e.g. "UTF-8".

Decodes a String in a way similar to the JavaScript "decodeURIcomponent" function, using "UTF-8" for character encoding.

This method can decode Strings that have been encoded in JavaScript with "encodeURIcomponent".

Returns the current request URI.

DEPRECATED On a JSP, use ${cms.requestContext.uri}instead.

Uses the 1st String as key to look up from the map that is passed as the 2nd String, and returns either the element found or the default value from the 3rd String.

The map String must have the form key1:value1|key2:value2 etc.

Uses the 1st String as key to look up from the map that is passed as the 2nd String, and returns either the element found or the empty String.

The map String must have the form key1:value1|key2:value2 etc.

Changes the given filenames suffix from the current suffix to the provided suffix.

The 1st parameter is the filename, the 2nd the new suffix.

Compares two paths, ignoring leading and trailing slashes.

Returns true if the paths are equal (ignoring leading and trailing slashes).

Escapes a String so it may be used in JavaScript String definitions.

This method escapes line breaks (\r\n,\n) quotation marks (".') and slash as well as backspace characters (\,/).

Escapes a String so it may be used as a Perl5 regular expression.

This method replaces the following characters in a String: {}[]()\$^.*+/

Extracts the content of a <body> tag in a HTML page.

This method should be pretty robust and work even if the input HTML does not contains a valid body tag.

Shortens a resource name or path so that it is not longer than the provided maximum length.

In order to reduce the length of the resource name, only complete folder names are removed and replaced with ... successively, starting with the second folder. The first folder is removed only in case the result still does not fit if all subfolders have been removed.

Example: formatResourceName("/myfolder/subfolder/index.html", 21) returns /myfolder/.../index.html.

Returns a java.util.Locale calculated from the suffix of the given String, or null if no locale suffix is found.

The locale returned will include the optional country code if this was part of the suffix.

Returns the locale suffix from the given String, or null if no locale suffix is found.

Examples:

• rabbit_en_EN.html -> Locale[en_EN]
• rabbit_en_EN      -> Locale[en_EN]
• rabbit_en.html    -> Locale[en]
• rabbit_en         -> Locale[en]
• rabbit_en.        -> Locale[en]
• rabbit_enr        -> null
• rabbit_en.tar.gz  -> null

Converts the given path to a path relative to a base folder, but only if it actually is a sub-path of the latter, otherwise null is returned.

The 1st parameter is the path, the 2nd paramerter is the base folder.

Checks if the first path is a prefix of the second path..

This method is different compared to String#startsWith, because it considers /foo/bar to be a prefix path of /foo/bar/baz, but not of /foo/bar42.