org.opencms.jsp

类 CmsJspTagContentLoad

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.opencms.jsp.CmsJspScopedVarBodyTagSuport

org.opencms.jsp.CmsJspTagResourceLoad

org.opencms.jsp.CmsJspTagContentLoad

所有已实现的接口:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, I_CmsResourceContainer, I_CmsXmlContentContainer

public class CmsJspTagContentLoad
extends CmsJspTagResourceLoad
implements I_CmsXmlContentContainer

Implementation of the <cms:contentload/> tag, used to access and display XML content item information from the VFS.

Since version 7.0.2 it is also possible to store the results of the content load in the JSP context using a CmsJspContentLoadBean. Using this bean the loaded XML content objects can be accessed directly using the JSP EL and the JSTL. To use this feature, you need to add the var (and optionally the scope) parameter to the content load tag. For example, if a parameter like var="myVarName" is provided, then the result of the content load is stored in the JSP context variable myVarName with an instance of a CmsJspContentLoadBean.

从以下版本开始:

6.0.0

另请参阅:

序列化表格

字段概要

从类继承的字段 org.opencms.jsp.CmsJspTagResourceLoad

m_cms, m_collector, m_collectorName, m_collectorParam, m_collectorResult, m_contentInfoBean, m_controller, m_pageIndex, m_pageNavLength, m_pageSize, m_param, m_preload, m_property, m_resource, m_resourceName

从类继承的字段 javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

从类继承的字段 javax.servlet.jsp.tagext.TagSupport

id, pageContext

从接口继承的字段 javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

从接口继承的字段 javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

从接口继承的字段 javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器

构造器和说明
CmsJspTagContentLoad() Empty constructor, required for JSP tags.
CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.util.Locale locale, boolean editable) Constructor used when using contentload from scriptlet code.
CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.lang.String pageIndex, java.lang.String pageSize, java.util.Locale locale, boolean editable) Constructor used when using contentload from scriptlet code.
CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.lang.String pageIndex, java.lang.String pageSize, java.util.Locale locale, CmsDirectEditMode editMode) Constructor used when using contentload from scriptlet code.

方法概要

方法

限定符和类型	方法和说明
protected void	doLoadNextFile() Load the next file name from the initialized list of file names.
int	doStartTag()
java.lang.String	getEditable() Returns the editable flag.
java.lang.String	getLocale() Returns the locale.
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	hasMoreResources() Resource iteration method to be used by JSP scriptlet code.
protected void	init(I_CmsXmlContentContainer container) Initializes this content load tag.
boolean	isEditEmpty() Returns the edit empty attribute.
void	release()
void	setEditable(java.lang.String mode) Sets the editable mode.
void	setEditEmpty(boolean editEmpty) Sets the edit empty attribute.
void	setLocale(java.lang.String locale) Sets the locale.

从类继承的方法 org.opencms.jsp.CmsJspTagResourceLoad

doAfterBody, doEndTag, doLoadNextResource, getCollector, getCollectorName, getCollectorParam, getCollectorResult, getContentInfoBean, getNextResource, getPageIndex, getPageNavLength, getPageSize, getParam, getPreload, getProperty, getResource, getResourceName, getResourceName, hasMoreContent, init, isPreloader, limitCollectorResult, setCollector, setPageIndex, setPageNavLength, setPageSize, setParam, setPreload, setProperty

从类继承的方法 org.opencms.jsp.CmsJspScopedVarBodyTagSuport

getScope, getScopeAsInt, getScopeAsString, getScopeInt, getVar, isScopeVarSet, setScope, setVar, storeAttribute, storeAttribute

从类继承的方法 javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

从类继承的方法 javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.jsp.I_CmsResourceContainer

getCollectorName, getCollectorParam, getCollectorResult, getResource, getResourceName, hasMoreContent, isPreloader

从接口继承的方法 javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

构造器详细资料

CmsJspTagContentLoad

public CmsJspTagContentLoad()

Empty constructor, required for JSP tags.

CmsJspTagContentLoad

public CmsJspTagContentLoad(I_CmsXmlContentContainer container,
                    javax.servlet.jsp.PageContext context,
                    java.lang.String collectorName,
                    java.lang.String collectorParam,
                    java.util.Locale locale,
                    boolean editable)
                     throws javax.servlet.jsp.JspException

Constructor used when using contentload from scriptlet code.

参数:

container - the parent content container (could be a preloader)

context - the JSP page context

collectorName - the collector name to use

collectorParam - the collector param to use

locale - the locale to use

editable - indicates if "direct edit" support is wanted

抛出:

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

CmsJspTagContentLoad

public CmsJspTagContentLoad(I_CmsXmlContentContainer container,
                    javax.servlet.jsp.PageContext context,
                    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

Constructor used when using contentload from scriptlet code.

参数:

container - the parent content container (could be a preloader)

context - the JSP page context

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

editable - indicates if "direct edit" support is wanted

抛出:

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

CmsJspTagContentLoad

public CmsJspTagContentLoad(I_CmsXmlContentContainer container,
                    javax.servlet.jsp.PageContext context,
                    java.lang.String collectorName,
                    java.lang.String collectorParam,
                    java.lang.String pageIndex,
                    java.lang.String pageSize,
                    java.util.Locale locale,
                    CmsDirectEditMode editMode)
                     throws javax.servlet.jsp.JspException

Constructor used when using contentload from scriptlet code.

参数:

container - the parent content container (could be a preloader)

context - the JSP page context

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

editMode - indicates which "direct edit" mode is wanted

抛出:

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

方法详细资料

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException,
                      CmsIllegalArgumentException

指定者:

doStartTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doStartTag 在类中 CmsJspTagResourceLoad

抛出:

javax.servlet.jsp.JspException

CmsIllegalArgumentException

另请参阅:

Tag.doStartTag()

getEditable

public java.lang.String getEditable()

Returns the editable flag.

返回:

the editable flag

getLocale

public java.lang.String getLocale()

Returns the locale.

返回:

the locale

getXmlDocument

public I_CmsXmlDocument getXmlDocument()

从接口复制的说明: I_CmsXmlContentContainer

Returns the currently loaded OpenCms XML content document.

指定者:

getXmlDocument 在接口中 I_CmsXmlContentContainer

返回:

the currently loaded OpenCms XML content document

另请参阅:

I_CmsXmlContentContainer.getXmlDocument()

getXmlDocumentElement

public java.lang.String getXmlDocumentElement()

从接口复制的说明: I_CmsXmlContentContainer

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

指定者:

getXmlDocumentElement 在接口中 I_CmsXmlContentContainer

返回:

the currently selected element name in the loaded XML content document

另请参阅:

I_CmsXmlContentContainer.getXmlDocumentElement()

getXmlDocumentLocale

public java.util.Locale getXmlDocumentLocale()

从接口复制的说明: I_CmsXmlContentContainer

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

指定者:

getXmlDocumentLocale 在接口中 I_CmsXmlContentContainer

返回:

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

另请参阅:

I_CmsXmlContentContainer.getXmlDocumentLocale()

hasMoreResources

public boolean hasMoreResources()
                         throws javax.servlet.jsp.JspException

从接口复制的说明: I_CmsResourceContainer

Resource iteration method to be used by JSP scriptlet code.

Calling this method will insert "direct edit" HTML to the output page (if required).

指定者:

hasMoreResources 在接口中 I_CmsResourceContainer

覆盖:

hasMoreResources 在类中 CmsJspTagResourceLoad

返回:

true if more resources are to be iterated

抛出:

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

另请参阅:

I_CmsResourceContainer.hasMoreResources()

isEditEmpty

public boolean isEditEmpty()

Returns the edit empty attribute.

返回:

the edit empty attribute

release

public void release()

指定者:

release 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

release 在类中 CmsJspTagResourceLoad

另请参阅:

Tag.release()

setEditable

public void setEditable(java.lang.String mode)

Sets the editable mode.

参数:

mode - the mode to set

setEditEmpty

public void setEditEmpty(boolean editEmpty)

Sets the edit empty attribute.

参数:

editEmpty - the edit empty attribute to set

setLocale

public void setLocale(java.lang.String locale)

Sets the locale.

参数:

locale - the locale to set

doLoadNextFile

protected void doLoadNextFile()
                       throws CmsException

Load the next file name from the initialized list of file names.

抛出:

CmsException - if something goes wrong

init

protected void init(I_CmsXmlContentContainer container)
             throws javax.servlet.jsp.JspException

Initializes this content load tag.

参数:

container - the parent container (could be a preloader)

抛出:

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