Class CmsJspXmlContentBean

    • Method Detail

      • contentload

        public I_CmsXmlContentContainer contentload​(java.lang.String collectorName,
                                                    java.lang.String collectorParam,
                                                    boolean editable)
                                             throws javax.servlet.jsp.JspException
        Loads a set of I_CmsXmlDocument, same as using the <cms:contentload collector="***" param="***" editable="***" /> tag.

        The locale for accessing the content is read form the current OpenCms users request context.

        Parameters:
        collectorName - the collector name to use
        collectorParam - the parameters for the collector
        editable - indicates if "direct edit" support is required (will insert additional HTML)
        Returns:
        an XML content container loaded with the selected content
        Throws:
        javax.servlet.jsp.JspException - in case something goes wrong
      • contentload

        public I_CmsXmlContentContainer contentload​(java.lang.String collectorName,
                                                    java.lang.String collectorParam,
                                                    java.util.Locale locale,
                                                    boolean editable)
                                             throws javax.servlet.jsp.JspException
        Loads a set of I_CmsXmlDocument, same as using the <cms:contentload collector="***" param="***" locale="***" editable="***" /> tag.

        Parameters:
        collectorName - the collector name to use
        collectorParam - the parameters for the collector
        locale - the locale to use to access the content
        editable - indicates if "direct edit" support is required (will insert additional HTML)
        Returns:
        an XML content container loaded with the selected content
        Throws:
        javax.servlet.jsp.JspException - in case something goes wrong
      • contentload

        public I_CmsXmlContentContainer contentload​(java.lang.String collectorName,
                                                    java.lang.String collectorParam,
                                                    java.lang.String pageIndex,
                                                    java.lang.String pageSize,
                                                    java.util.Locale locale,
                                                    boolean editable)
                                             throws javax.servlet.jsp.JspException
        Loads a set of I_CmsXmlDocument, same as using the <cms:contentload collector="***" param="***" locale="***" editable="***" /> tag.

        Parameters:
        collectorName - the collector name to use
        collectorParam - the collector param to use
        pageIndex - the display page index (may contain macros)
        pageSize - the display page size (may contain macros)
        locale - the locale to use to access the content
        editable - indicates if "direct edit" support is required (will insert additional HTML)
        Returns:
        an XML content container loaded with the selected content
        Throws:
        javax.servlet.jsp.JspException - in case something goes wrong
      • contentloop

        public I_CmsXmlContentContainer contentloop​(I_CmsXmlContentContainer container,
                                                    java.lang.String element)
        Enables looping over a list of element values in the given parent container, same as using the <cms:contentloop element="***" /> tag.

        Parameters:
        container - the XML content container to read the content from
        element - the element to loop over
        Returns:
        an XML content container to be used to loop over the selected element values in the parent container
      • contentshow

        public java.lang.String contentshow​(I_CmsXmlContentContainer container)
        Returns the currently looped content element String value from the given XML content container, same as using the <cms:contentshow /> tag.

        This is to be used with a container initialized by contentloop(I_CmsXmlContentContainer, String), in this case the element name is already set by the content loop container.

        The locale for accessing the content is read form the current OpenCms users request context.

        Parameters:
        container - the XML content container to read the content from
        Returns:
        the selected content element String value from the given XML content container
      • contentshow

        public java.lang.String contentshow​(I_CmsXmlContentContainer container,
                                            java.lang.String element)
        Returns the selected content element String value from the given XML content container, same as using the <cms:contentshow element="***" /> tag.

        The locale for accessing the content is read form the current OpenCms users request context.

        Parameters:
        container - the XML content container to read the content from
        element - the element to show
        Returns:
        the selected content element String value from the given XML content container
      • contentshow

        public java.lang.String contentshow​(I_CmsXmlContentContainer container,
                                            java.lang.String element,
                                            java.util.Locale locale)
        Returns the selected content element String value from the given XML content container, same as using the <cms:contentshow element="***" locale="***" /> tag.

        Parameters:
        container - the XML content container to read the content from
        element - the element to show
        locale - the locale to read the element from
        Returns:
        the selected content element String value from the given XML content container