org.opencms.jsp

类 CmsJspTagContentLoop

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.opencms.jsp.CmsJspTagContentLoop

所有已实现的接口:

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

public class CmsJspTagContentLoop
extends javax.servlet.jsp.tagext.TagSupport
implements I_CmsXmlContentContainer

Used to loop through the element values of an XML content item.

从以下版本开始:

6.0.0

另请参阅:

序列化表格

字段概要

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

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器

构造器和说明
CmsJspTagContentLoop() Empty constructor, required for JSP tags.
CmsJspTagContentLoop(I_CmsXmlContentContainer container, java.lang.String element) Constructor used when using contentloop from scriptlet code.

方法概要

方法

限定符和类型	方法和说明
int	doAfterBody()
int	doEndTag()
int	doStartTag()
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).
java.lang.String	getElement() Returns the name of the content node element to show.
CmsResource	getResource() Returns the currently loaded resource.
java.lang.String	getResourceName() Returns the resource name in the VFS for the currently loaded resource.
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() 已过时。
boolean	hasMoreResources() Resource iteration method to be used by JSP scriptlet code.
protected void	init(I_CmsXmlContentContainer container) Initializes this content loop tag.
boolean	isPreloader() Returns true if this container is used as a resource preloader.
void	release()
void	setElement(java.lang.String element) Sets the name of the content node element to show.

从类继承的方法 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

构造器详细资料

CmsJspTagContentLoop

public CmsJspTagContentLoop()

Empty constructor, required for JSP tags.

CmsJspTagContentLoop

public CmsJspTagContentLoop(I_CmsXmlContentContainer container,
                    java.lang.String element)

Constructor used when using contentloop from scriptlet code.

参数:

container - the parent content container that provides the content element to loop

element - the element to loop in the content

方法详细资料

doAfterBody

public int doAfterBody()

指定者:

doAfterBody 在接口中 javax.servlet.jsp.tagext.IterationTag

覆盖:

doAfterBody 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

TagSupport.doAfterBody()

doEndTag

public int doEndTag()

指定者:

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

覆盖:

doEndTag 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

Tag.doEndTag()

doStartTag

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

指定者:

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

覆盖:

doStartTag 在类中 javax.servlet.jsp.tagext.TagSupport

抛出:

javax.servlet.jsp.JspException

另请参阅:

Tag.doStartTag()

getCollectorName

public java.lang.String getCollectorName()

从接口复制的说明: I_CmsResourceContainer

Returns the name of the currently used resource collector.

指定者:

getCollectorName 在接口中 I_CmsResourceContainer

返回:

the name of the currently used resource collector

另请参阅:

I_CmsResourceContainer.getCollectorName()

getCollectorParam

public java.lang.String getCollectorParam()

从接口复制的说明: I_CmsResourceContainer

Returns the parameters of the currently used resource collector.

指定者:

getCollectorParam 在接口中 I_CmsResourceContainer

返回:

the parameters of the currently used resource collector

另请参阅:

I_CmsResourceContainer.getCollectorParam()

getCollectorResult

public java.util.List<CmsResource> getCollectorResult()

从接口复制的说明: I_CmsResourceContainer

Returns the list of all currently loaded resources (instances of CmsResource).

指定者:

getCollectorResult 在接口中 I_CmsResourceContainer

返回:

the list of all currently loaded resources

另请参阅:

I_CmsResourceContainer.getCollectorResult()

getElement

public java.lang.String getElement()

Returns the name of the content node element to show.

返回:

the name of the content node element to show

getResource

public CmsResource getResource()

从接口复制的说明: I_CmsResourceContainer

Returns the currently loaded resource.

指定者:

getResource 在接口中 I_CmsResourceContainer

返回:

the currently loaded resource

另请参阅:

I_CmsResourceContainer.getResource()

getResourceName

public java.lang.String getResourceName()

从接口复制的说明: I_CmsResourceContainer

Returns the resource name in the VFS for the currently loaded resource.

指定者:

getResourceName 在接口中 I_CmsResourceContainer

返回:

the resource name in the VFS for the currently loaded resource

另请参阅:

I_CmsResourceContainer.getResourceName()

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()

hasMoreContent

@Deprecated
public boolean hasMoreContent()

已过时。

从接口复制的说明: 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).

指定者:

hasMoreContent 在接口中 I_CmsResourceContainer

返回:

true if more resources are to be iterated

另请参阅:

I_CmsResourceContainer.hasMoreContent()

hasMoreResources

public boolean hasMoreResources()

从接口复制的说明: 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

返回:

true if more resources are to be iterated

另请参阅:

I_CmsResourceContainer.hasMoreResources()

isPreloader

public boolean isPreloader()

从接口复制的说明: I_CmsResourceContainer

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

A resource preloader is used to load resources without looping through it.

指定者:

isPreloader 在接口中 I_CmsResourceContainer

返回:

true if this container is used as a resource preloader

另请参阅:

I_CmsResourceContainer.isPreloader()

release

public void release()

指定者:

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

覆盖:

release 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

Tag.release()

setElement

public void setElement(java.lang.String element)

Sets the name of the content node element to show.

参数:

element - the name of the content node element to show

init

protected void init(I_CmsXmlContentContainer container)

Initializes this content loop tag.

参数:

container - the parent content container that provides the content element to loop