org.opencms.jsp
Class CmsJspActionElement

java.lang.Object
  org.opencms.jsp.CmsJspBean
      org.opencms.jsp.CmsJspActionElement

Direct Known Subclasses:

CmsJspLoginBean, CmsJspStatusBean

public class CmsJspActionElement

extends CmsJspBean

Bean to be used in JSP scriptlet code that provides direct access to the functionality offered by the opencms taglib.

By instanciating a bean of this type and accessing the methods provided by the instance, all functionality of the OpenCms JSP taglib can be easily used from within JSP scriplet code.

Initialize this bean at the beginning of your JSP like this:

 <jsp:useBean id="cms" class="org.opencms.jsp.CmsJspActionElement">
 <% cms.init(pageContext, request, response); %>
 </jsp:useBean>
 

You can also access the current users CmsObject by using CmsJspBean.getCmsObject().

All exceptions that occur when calling any method of this class are catched and written to the log output only, so that a template still has a chance of working at least in some elements.

Since:

6.0.0

Version:

$Revision: 1.24 $

Author:

Alexander Kandzior

Field Summary

static CmsMessageContainer

NOT_INITIALIZED Error message in case bean was not properly initialized.

Constructor Summary

CmsJspActionElement()
Empty constructor, required for every JavaBean.

CmsJspActionElement(PageContext context, HttpServletRequest req, HttpServletResponse res)
Constructor, with parameters.

Method Summary

void	editable(boolean isEditable) Includes direct edit scriptlets, same as using the <cms:editable /> tag.
void	editable(boolean isEditable, String filename) Includes direct edit scriptlets, same as using the <cms:editable file="***" />tag.
String	getContent(String target) Returns the processed output of an OpenCms resource in a String.
String	getContent(String target, String element, Locale locale) Returns the processed output of an element within an OpenCms resource.
CmsMessages	getMessages(String bundleName, String language) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsMessages	getMessages(String bundleName, String language, String defaultLanguage) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsMessages	getMessages(String bundleName, String language, String country, String variant, String defaultLanguage) Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.
CmsJspNavBuilder	getNavigation() Returns an initialized CmsJspNavBuilder instance.
void	include(String target) Include a sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" /> tag.
void	include(String target, String element) Include a named sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag.
void	include(String target, String element, boolean editable) Include a named sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag.
void	include(String target, String element, boolean editable, Map parameterMap) Include a named sub-element with paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag with parameters in the tag body.
void	include(String target, String element, Map parameterMap) Include a named sub-element with paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag with parameters in the tag body.
void	includeSilent(String target, String element) Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).
void	includeSilent(String target, String element, boolean editable) Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).
void	includeSilent(String target, String element, boolean editable, Map parameterMap) Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).
void	includeSilent(String target, String element, Map parameterMap) Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).
String	info(String property) Returns an OpenCms or JVM system info property value, same as using the <cms:info property="***" /> tag.
String	label(String label) Returns an OpenCms workplace label.
String	link(String link) Calculate a link with the OpenCms link management, same as using the <cms:link>***</cms:link> tag.
Map	properties() Returns all properites of the current file.
Map	properties(String file) Returns all properites of the selected file.
String	property(String name) Returns a selected file property value, same as using the <cms:property name="***" /> tag or calling property(String, String, String, boolean).
String	property(String name, String file) Returns a selected file property value, same as using the <cms:property name="***" file="***" /> tag or calling property(String, String, String, boolean).
String	property(String name, String file, String defaultValue) Returns a selected file property value, same as using the <cms:property name="***" file="***" default="***" /> tag or calling property(String, String, String, boolean).
String	property(String name, String file, String defaultValue, boolean escapeHtml) Returns a selected file property value with optional HTML escaping, same as using the <cms:property name="***" file="***" default="***" /> tag.
boolean	template(String element) Checks if a template part should be used or not, same as using the <cms:template element="***" /> tag.
boolean	template(String elementlist, boolean checkall) Checks if a template part should be used or not, same as using the <cms:template ifexists="***" /> tag.
boolean	template(String element, String elementlist, boolean checkall) Checks if a template part should be used or not, same as using the <cms:template element="***" ifexists="***" /> tag.
String	toAbsolute(String target) Converts a relative URI in the OpenCms VFS to an absolute one based on the location of the currently processed OpenCms URI.
String	user(String property) Returns a selected user property, i.e.

Methods inherited from class org.opencms.jsp.CmsJspBean

getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, init, isNotInitialized, isSupressingExceptions, setSupressingExceptions

Methods inherited from class java.lang.Object

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

Field Detail

NOT_INITIALIZED

public static final CmsMessageContainer NOT_INITIALIZED

Error message in case bean was not properly initialized.

Constructor Detail

CmsJspActionElement

public CmsJspActionElement()

Empty constructor, required for every JavaBean.

CmsJspActionElement

public CmsJspActionElement(PageContext context,
                           HttpServletRequest req,
                           HttpServletResponse res)

Constructor, with parameters.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

Method Detail

editable

public void editable(boolean isEditable)
              throws JspException

Includes direct edit scriptlets, same as using the <cms:editable /> tag.

Parameters:

isEditable - include scriptlets only if true

Throws:

JspException - if something goes wrong

editable

public void editable(boolean isEditable,
                     String filename)
              throws JspException

Includes direct edit scriptlets, same as using the <cms:editable file="***" />tag.

Parameters:

isEditable - include scriptlets only if true

filename - file with scriptlets

Throws:

JspException - if something goes wrong

getContent

public String getContent(String target)

Returns the processed output of an OpenCms resource in a String.

Parameters:

target - the target to process

Returns:

the processed output of an OpenCms resource in a String

getContent

public String getContent(String target,
                         String element,
                         Locale locale)

Returns the processed output of an element within an OpenCms resource.

Parameters:

target - the target to process

element - name of the element

locale - locale of the element

Returns:

the processed output

getMessages

public CmsMessages getMessages(String bundleName,
                               String language)

Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.

Parameters:

bundleName - the name of the ResourceBundle to use

language - language indentificator for the locale of the bundle

Returns:

CmsMessages a message bundle initialized with the provided values

getMessages

public CmsMessages getMessages(String bundleName,
                               String language,
                               String defaultLanguage)

Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.

Parameters:

bundleName - the name of the ResourceBundle to use

language - language indentificator for the locale of the bundle

defaultLanguage - default for the language, will be used if language is null or empty String "", and defaultLanguage is not null

Returns:

CmsMessages a message bundle initialized with the provided values

getMessages

public CmsMessages getMessages(String bundleName,
                               String language,
                               String country,
                               String variant,
                               String defaultLanguage)

Generates an initialized instance of CmsMessages for convenient access to localized resource bundles.

Parameters:

bundleName - the name of the ResourceBundle to use

language - language indentificator for the locale of the bundle

country - 2 letter country code for the locale of the bundle

variant - a vendor or browser-specific variant code

defaultLanguage - default for the language, will be used if language is null or empty String "", and defaultLanguage is not null

Returns:

CmsMessages a message bundle initialized with the provided values

See Also:

ResourceBundle, CmsMessages

getNavigation

public CmsJspNavBuilder getNavigation()

Returns an initialized CmsJspNavBuilder instance.

Returns:

CmsJspNavBuilder an initialized CmsJspNavBuilder

See Also:

CmsJspNavBuilder

include

public void include(String target)
             throws JspException

Include a sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" /> tag.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

Throws:

JspException - in case there were problems including the target

See Also:

CmsJspTagInclude

include

public void include(String target,
                    String element)
             throws JspException

Include a named sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

Throws:

JspException - in case there were problems including the target

See Also:

CmsJspTagInclude

include

public void include(String target,
                    String element,
                    boolean editable)
             throws JspException

Include a named sub-element without paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

editable - flag to indicate if element is editable

Throws:

JspException - in case there were problems including the target

See Also:

CmsJspTagInclude

include

public void include(String target,
                    String element,
                    boolean editable,
                    Map parameterMap)
             throws JspException

Include a named sub-element with paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag with parameters in the tag body.

The parameter map should be a map where the keys are Strings (the parameter names) and the values are of type String[]. However, as a convenience feature, in case you provide just a String for the parameter value, it will automatically be translated to a String[1].

The handling of the element parameter depends on the included file type. Most often it is used as template selector.

Important: Exceptions that occur in the include process are NOT handled even if CmsJspBean.setSupressingExceptions(boolean) was set to true.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

editable - flag to indicate if element is editable

parameterMap - a map of the request parameters

Throws:

JspException - in case there were problems including the target

See Also:

CmsJspTagInclude

include

public void include(String target,
                    String element,
                    Map parameterMap)
             throws JspException

Include a named sub-element with paramters from the OpenCms VFS, same as using the <cms:include file="***" element="***" /> tag with parameters in the tag body.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

parameterMap - a map of the request parameters

Throws:

JspException - in case there were problems including the target

See Also:

CmsJspTagInclude

includeSilent

public void includeSilent(String target,
                          String element)

Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).

This is a convenience method that allows to include elements on a page without checking if they exist or not. If the target element does not exist, nothing is printed to the JSP output.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

includeSilent

public void includeSilent(String target,
                          String element,
                          boolean editable)

Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).

This is a convenience method that allows to include elements on a page without checking if they exist or not. If the target element does not exist, nothing is printed to the JSP output.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

editable - flag to indicate if element is editable

includeSilent

public void includeSilent(String target,
                          String element,
                          boolean editable,
                          Map parameterMap)

Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).

This is a convenience method that allows to include elements on a page without checking if they exist or not. If the target element does not exist, nothing is printed to the JSP output.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

editable - flag to indicate if element is editable

parameterMap - a map of the request parameters

includeSilent

public void includeSilent(String target,
                          String element,
                          Map parameterMap)

Includes a named sub-element supressing all Exceptions that occur during the include, otherwise the same as using include(String, String, Map).

This is a convenience method that allows to include elements on a page without checking if they exist or not. If the target element does not exist, nothing is printed to the JSP output.

Parameters:

target - the target uri of the file in the OpenCms VFS (can be relative or absolute)

element - the element (template selector) to display from the target

parameterMap - a map of the request parameters

info

public String info(String property)

Returns an OpenCms or JVM system info property value, same as using the <cms:info property="***" /> tag.

See the description of the class CmsJspTagInfo for a detailed list of available options for the property value.

Parameters:

property - the property to look up

Returns:

String the value of the system property

See Also:

CmsJspTagInfo

label

public String label(String label)

Returns an OpenCms workplace label.

You should consider using a standard java.util.ResourceBundle instead of the OpenCms workplace language files.

Parameters:

label - the label to look up

Returns:

label the value of the label

See Also:

CmsJspTagLabel

link

public String link(String link)

Calculate a link with the OpenCms link management, same as using the <cms:link>***</cms:link> tag.

This is important to get the right link for exported resources, e.g. for images in the online project.

Parameters:

link - the uri in the OpenCms to link to

Returns:

the translated link

See Also:

CmsJspTagLink

properties

public Map properties()

Returns all properites of the current file.

Returns:

Map all properties of the current file

properties

public Map properties(String file)

Returns all properites of the selected file.

Please see the description of the class CmsJspTagProperty for valid options of the file parameter.

Parameters:

file - the file (or folder) to look at for the properties

Returns:

Map all properties of the current file (and optional of the folders containing the file)

See Also:

CmsJspTagProperty

property

public String property(String name)

Returns a selected file property value, same as using the <cms:property name="***" /> tag or calling property(String, String, String, boolean).

Parameters:

name - the name of the property to look for

Returns:

the value of the property found, or null if the property could not be found

See Also:

property(String, String, String, boolean), CmsJspTagProperty

property

public String property(String name,
                       String file)

Returns a selected file property value, same as using the <cms:property name="***" file="***" /> tag or calling property(String, String, String, boolean).

Parameters:

name - the name of the property to look for

file - the file (or folder) to look at for the property

Returns:

the value of the property found, or null if the property could not be found

See Also:

property(String, String, String, boolean), CmsJspTagProperty

property

public String property(String name,
                       String file,
                       String defaultValue)

Returns a selected file property value, same as using the <cms:property name="***" file="***" default="***" /> tag or calling property(String, String, String, boolean).

Parameters:

name - the name of the property to look for

file - the file (or folder) to look at for the property

defaultValue - a default value in case the property was not found

Returns:

the value of the property found, or the value of defaultValue if the property could not be found

See Also:

property(String, String, String, boolean), CmsJspTagProperty

property

public String property(String name,
                       String file,
                       String defaultValue,
                       boolean escapeHtml)

Returns a selected file property value with optional HTML escaping, same as using the <cms:property name="***" file="***" default="***" /> tag.

Please see the description of the class CmsJspTagProperty for valid options of the file parameter.

Parameters:

name - the name of the property to look for

file - the file (or folder) to look at for the property

defaultValue - a default value in case the property was not found

escapeHtml - if true, special HTML characters in the return value are escaped with their number representations (e.g. & becomes &)

Returns:

the value of the property found, or the value of defaultValue if the property could not be found

See Also:

CmsJspTagProperty

template

public boolean template(String element)

Checks if a template part should be used or not, same as using the <cms:template element="***" /> tag.

Parameters:

element - the template element to check

Returns:

true if the element is active, false otherwise

See Also:

CmsJspTagUser

template

public boolean template(String elementlist,
                        boolean checkall)

Checks if a template part should be used or not, same as using the <cms:template ifexists="***" /> tag.

Parameters:

elementlist - the list of elements to check

checkall - true if all elements in the list should be checked

Returns:

true if the elements available, false otherwise

See Also:

CmsJspTagUser

template

public boolean template(String element,
                        String elementlist,
                        boolean checkall)

Checks if a template part should be used or not, same as using the <cms:template element="***" ifexists="***" /> tag.

Parameters:

element - the template element to check

elementlist - the list of elements to check

checkall - true if all elements in the list should be checked

Returns:

true if the element is active, false otherwise

See Also:

CmsJspTagUser

toAbsolute

public String toAbsolute(String target)

Converts a relative URI in the OpenCms VFS to an absolute one based on the location of the currently processed OpenCms URI.

Parameters:

target - the relative URI to convert

Returns:

the target URI converted to an absolute one

user

public String user(String property)

Returns a selected user property, i.e. information about the currently logged in user, same as using the <cms:user property="***" /> tag.

Parameters:

property - the user property to display, please see the tag documentation for valid options

Returns:

the value of the selected user property

See Also:

CmsJspTagUser