org.opencms.jsp
Interface I_CmsJspTagContentContainer

All Known Implementing Classes:
CmsJspTagContentLoad, CmsJspTagContentLoop

public interface I_CmsJspTagContentContainer

Provides access to a XML content document that was loaded by a parent tag.

Since:
6.0.0
Version:
$Revision: 1.9 $

Method Summary
 String getCollectorName()
          Returns the name of the currently used XML content collector.
 String getCollectorParam()
          Returns the parameters of the currently used XML content collector.
 List getCollectorResult()
          Returns the list of all currently loaded XML content documents.
 String getResourceName()
          Returns the resource name in the VFS for the currently loaded XML content document.
 A_CmsXmlDocument getXmlDocument()
          Returns the currently loaded OpenCms XML content document.
 String getXmlDocumentElement()
          Returns the currently selected element name for the current content.
 Locale getXmlDocumentLocale()
          Returns the currently selected locale for the current content.
 

Method Detail

getCollectorName

String getCollectorName()
Returns the name of the currently used XML content collector.

Returns:
the name of the currently used XML content collector

getCollectorParam

String getCollectorParam()
Returns the parameters of the currently used XML content collector.

Returns:
the parameters of the currently used XML content collector

getCollectorResult

List getCollectorResult()
Returns the list of all currently loaded XML content documents.

Returns:
the list of all currently loaded XML content documents

getResourceName

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

A_CmsXmlDocument getXmlDocument()
Returns the currently loaded OpenCms XML content document.

Returns:
the currently loaded OpenCms XML content document

getXmlDocumentElement

String getXmlDocumentElement()
Returns the currently selected element name for the current content.

Returns:
the currently selected element name for the current content

getXmlDocumentLocale

Locale getXmlDocumentLocale()
Returns the currently selected locale for the current content.

Returns:
the currently selected locale for the current content