org.opencms.jsp
Interface I_CmsXmlContentContainer

All Known Subinterfaces:

I_CmsJspTagContentContainer

All Known Implementing Classes:

CmsJspTagContentLoad, CmsJspTagContentLoop

public interface I_CmsXmlContentContainer

Provides access to a I_CmsXmlDocument document that was previously loaded by a parent tag.

Since:

6.2.0

Version:

$Revision: 1.6 $

Method Summary

java.lang.String	getCollectorName() Returns the name of the currently used XML content collector.
java.lang.String	getCollectorParam() Returns the parameters of the currently used XML content collector.
java.util.List	getCollectorResult() Returns the list of all currently loaded XML content documents (instances of I_CmsXmlDocument).
java.lang.String	getResourceName() Returns the resource name in the VFS for the currently loaded XML content document.
I_CmsXmlDocument	getXmlDocument() Returns the currently loaded OpenCms XML content document.
java.lang.String	getXmlDocumentElement() Returns the currently selected element name in the loaded XML content document.
java.util.Locale	getXmlDocumentLocale() Returns the currently selected locale used for acessing the content in the loaded XML content document.
boolean	hasMoreContent() Content iteration method to be used by JSP scriptlet code.
boolean	isPreloader() Returns true if this container is used as a content preloader.

Method Detail

getCollectorName

java.lang.String getCollectorName()

Returns the name of the currently used XML content collector.

Returns:

the name of the currently used XML content collector

getCollectorParam

java.lang.String getCollectorParam()

Returns the parameters of the currently used XML content collector.

Returns:

the parameters of the currently used XML content collector

getCollectorResult

java.util.List getCollectorResult()

Returns the list of all currently loaded XML content documents (instances of I_CmsXmlDocument).

Returns:

the list of all currently loaded XML content documents

getResourceName

java.lang.String getResourceName()

Returns the resource name in the VFS for the currently loaded XML content document.

Returns:

the resource name in the VFS for the currently loaded XML content document

getXmlDocument

I_CmsXmlDocument getXmlDocument()

Returns the currently loaded OpenCms XML content document.

Returns:

the currently loaded OpenCms XML content document

getXmlDocumentElement

java.lang.String getXmlDocumentElement()

Returns the currently selected element name in the loaded XML content document.

Returns:

the currently selected element name in the loaded XML content document

getXmlDocumentLocale

java.util.Locale getXmlDocumentLocale()

Returns the currently selected locale used for acessing the content in the loaded XML content document.

Returns:

the currently selected locale used for acessing the content in the loaded XML content document

hasMoreContent

boolean hasMoreContent()
                       throws javax.servlet.jsp.JspException

Content 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 content is to be iterated

Throws:

javax.servlet.jsp.JspException - in case something goes wrong

isPreloader

boolean isPreloader()

Returns true if this container is used as a content preloader.

A content preloader is used to load content without looping through it.

Returns:

true if this container is used as a content preloader