|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
org.opencms.jsp.CmsJspTagContentLoop
Used to loop through the element values of an XML content item.
Field Summary |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
CmsJspTagContentLoop()
Empty constructor, required for JSP tags. |
|
CmsJspTagContentLoop(I_CmsXmlContentContainer container,
java.lang.String element)
Constructor used when using contentloop from scriptlet code. |
Method Summary | |
int |
doAfterBody()
|
int |
doEndTag()
|
int |
doStartTag()
|
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 ). |
java.lang.String |
getElement()
Returns the name of the content node element to show. |
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. |
protected void |
init(I_CmsXmlContentContainer container)
Initializes this content loop tag. |
boolean |
isPreloader()
Returns true if this container is used as a content preloader. |
void |
release()
|
void |
setElement(java.lang.String element)
Sets the name of the content node element to show. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CmsJspTagContentLoop()
public CmsJspTagContentLoop(I_CmsXmlContentContainer container, java.lang.String element)
contentloop
from scriptlet code.
container
- the parent content container that provides the content element to loopelement
- the element to loop in the contentMethod Detail |
public int doAfterBody()
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
TagSupport.doAfterBody()
public int doEndTag()
doEndTag
in interface javax.servlet.jsp.tagext.Tag
Tag.doEndTag()
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
javax.servlet.jsp.JspException
Tag.doStartTag()
public java.lang.String getCollectorName()
I_CmsXmlContentContainer
getCollectorName
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorName()
public java.lang.String getCollectorParam()
I_CmsXmlContentContainer
getCollectorParam
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorParam()
public java.util.List getCollectorResult()
I_CmsXmlContentContainer
I_CmsXmlDocument
).
getCollectorResult
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorResult()
public java.lang.String getElement()
public java.lang.String getResourceName()
I_CmsXmlContentContainer
getResourceName
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getResourceName()
public I_CmsXmlDocument getXmlDocument()
I_CmsXmlContentContainer
getXmlDocument
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocument()
public java.lang.String getXmlDocumentElement()
I_CmsXmlContentContainer
getXmlDocumentElement
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocumentElement()
public java.util.Locale getXmlDocumentLocale()
I_CmsXmlContentContainer
getXmlDocumentLocale
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocumentLocale()
public boolean hasMoreContent()
I_CmsXmlContentContainer
Calling this method will insert "direct edit" HTML to the output page (if required).
hasMoreContent
in interface I_CmsXmlContentContainer
true
if more content is to be iteratedI_CmsXmlContentContainer.hasMoreContent()
public boolean isPreloader()
I_CmsXmlContentContainer
true
if this container is used as a content preloader.A content preloader is used to load content without looping through it.
isPreloader
in interface I_CmsXmlContentContainer
true
if this container is used as a content preloaderI_CmsXmlContentContainer.isPreloader()
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
Tag.release()
public void setElement(java.lang.String element)
element
- the name of the content node element to showprotected void init(I_CmsXmlContentContainer container)
container
- the parent content container that provides the content element to loop
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |