Package org.opencms.jsp
Interface I_CmsResourceContainer
-
- All Known Subinterfaces:
I_CmsXmlContentContainer
- All Known Implementing Classes:
CmsJspTagContentLoad
,CmsJspTagContentLoop
,CmsJspTagResourceLoad
public interface I_CmsResourceContainer
Provides access to a
object that was previously loaded by a parent tag.CmsResource
- Since:
- 8.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCollectorName()
Returns the name of the currently used resource collector.java.lang.String
getCollectorParam()
Returns the parameters of the currently used resource collector.java.util.List<CmsResource>
getCollectorResult()
Returns the list of all currently loaded resources (instances of
).CmsResource
CmsResource
getResource()
Returns the currently loaded resource.java.lang.String
getResourceName()
Returns the resource name in the VFS for the currently loaded resource.boolean
hasMoreContent()
Deprecated.boolean
hasMoreResources()
Resource iteration method to be used by JSP scriptlet code.boolean
isPreloader()
Returnstrue
if this container is used as a resource preloader.
-
-
-
Method Detail
-
getCollectorName
java.lang.String getCollectorName()
Returns the name of the currently used resource collector.- Returns:
- the name of the currently used resource collector
-
getCollectorParam
java.lang.String getCollectorParam()
Returns the parameters of the currently used resource collector.- Returns:
- the parameters of the currently used resource collector
-
getCollectorResult
java.util.List<CmsResource> getCollectorResult()
Returns the list of all currently loaded resources (instances of
).CmsResource
- Returns:
- the list of all currently loaded resources
-
getResource
CmsResource getResource()
Returns the currently loaded resource.- Returns:
- the currently loaded resource
-
getResourceName
java.lang.String getResourceName()
Returns the resource name in the VFS for the currently loaded resource.- Returns:
- the resource name in the VFS for the currently loaded resource
-
hasMoreResources
boolean hasMoreResources() throws javax.servlet.jsp.JspException
Resource iteration method to be used by JSP scriptlet code.Calling this method will insert "direct edit" HTML to the output page (if required).
- Returns:
true
if more resources are to be iterated- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong
-
hasMoreContent
@Deprecated boolean hasMoreContent() throws javax.servlet.jsp.JspException
Deprecated.Resource iteration method to be used by JSP scriptlet code.Calling this method will insert "direct edit" HTML to the output page (if required).
- Returns:
true
if more resources are to be iterated- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong
-
isPreloader
boolean isPreloader()
Returnstrue
if this container is used as a resource preloader.A resource preloader is used to load resources without looping through it.
- Returns:
true
if this container is used as a resource preloader
-
-