org.opencms.jsp.util

Class CmsJspResourceLoadBean

java.lang.Object

org.opencms.jsp.util.CmsJspResourceLoadBean

public class CmsJspResourceLoadBean
extends java.lang.Object

Allows JSP access to the results of a <cms:resourceload ... > operation using the JSTL and EL.

Since:

8.0

See Also:

CmsJspTagResourceLoad, CmsJspResourceAccessBean

Field Summary

Fields

Modifier and Type	Field and Description
protected CmsObject	m_cms The OpenCms context of the current user.
protected java.util.List<CmsResource>	m_resources The list of results of the resource loader.

Constructor Summary

Constructors

Constructor and Description
CmsJspResourceLoadBean() No argument constructor, required for a JavaBean.
CmsJspResourceLoadBean(CmsObject cms, java.util.List<CmsResource> resources) Creates a new context bean using the OpenCms context of the current user.

Method Summary

Modifier and Type	Method and Description
CmsObject	getCmsObject() Returns the OpenCms user context this bean was initialized with.
java.util.List<CmsResource>	getResources() Returns a list of CmsResource instances.
void	init(CmsObject cms, java.util.List<CmsResource> resources) Initialize this instance.

Methods inherited from class java.lang.Object

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

Field Detail

m_cms

protected CmsObject m_cms

The OpenCms context of the current user.

m_resources

protected java.util.List<CmsResource> m_resources

The list of results of the resource loader.

Constructor Detail

CmsJspResourceLoadBean

public CmsJspResourceLoadBean()

No argument constructor, required for a JavaBean.

You must call init(CmsObject, List) and provide the required values when you use this constructor.

See Also:

init(CmsObject, List)

CmsJspResourceLoadBean

public CmsJspResourceLoadBean(CmsObject cms,
                              java.util.List<CmsResource> resources)

Creates a new context bean using the OpenCms context of the current user.

The current request context locale is used.

Parameters:

cms - the OpenCms context of the current user

resources - the resources to access, must contain objects of type CmsResource

Method Detail

getCmsObject

public CmsObject getCmsObject()

Returns the OpenCms user context this bean was initialized with.

Returns:

the OpenCms user context this bean was initialized with

getResources

public java.util.List<CmsResource> getResources()

Returns a list of CmsResource instances.

Returns:

a list of CmsResource instances

init

public void init(CmsObject cms,
                 java.util.List<CmsResource> resources)

Initialize this instance.

Parameters:

cms - the OpenCms context of the current user

resources - the resources to access, must contain objects of type CmsResource