Package org.opencms.jsp.util

Class CmsDynamicFunctionBeanWrapper

java.lang.Object

org.opencms.jsp.util.CmsDynamicFunctionBeanWrapper

public class CmsDynamicFunctionBeanWrapper
extends Object

A wrapper class for using dynamic function beans inside JSPs via the EL.

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsObject	m_cms	The internal CMS object to use.
protected CmsDynamicFunctionBean	m_functionBean	The dynamic function bean which is being wrapped.

Constructor Summary

Constructors

Constructor	Description
CmsDynamicFunctionBeanWrapper(CmsObject cms, CmsDynamicFunctionBean functionBean)	Creates a new wrapper instance.

Method Summary

Modifier and Type	Method	Description
Object	getFormatFor()	Gets the lazy map for accessing the various function formats.
String	getJsp()	Gets the JSP file name of the wrapped dynamic function bean's main format.
Map<String,String>	getParam()	Gets the parameters of the wrapped dynamic function bean's main format.
Map<String,String>	getParameters()	Gets the parameters of the wrapped dynamic function bean's main format.

Methods inherited from class java.lang.Object

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

Field Details

m_cms

protected CmsObject m_cms

The internal CMS object to use.

m_functionBean

protected CmsDynamicFunctionBean m_functionBean

The dynamic function bean which is being wrapped.

Constructor Details

CmsDynamicFunctionBeanWrapper

public CmsDynamicFunctionBeanWrapper(CmsObject cms,
 CmsDynamicFunctionBean functionBean)

Creates a new wrapper instance.

Parameters:

cms - the CMS context to use

functionBean - the dynamic function bean to wrap

Method Details

getFormatFor

public Object getFormatFor()

Gets the lazy map for accessing the various function formats.

Returns:

a map which allows access to the various function formats

getJsp

public String getJsp()

Gets the JSP file name of the wrapped dynamic function bean's main format.

Returns:

a jsp file name

getParam

public Map<String,String> getParam()

Gets the parameters of the wrapped dynamic function bean's main format.

Returns:

the map of parameters

getParameters

public Map<String,String> getParameters()

Gets the parameters of the wrapped dynamic function bean's main format.

Returns:

the map of parameters