info.magnolia.cms.taglibs
Class PageIterator

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      info.magnolia.cms.taglibs.PageIterator

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class PageIterator
extends javax.servlet.jsp.tagext.TagSupport

Iterates over a Content (page) collection.

Version:

$Revision: 41137 $ ($Author: gjoseph $)

Author:

Andreas Brenk, Fabrizio Giustina

See Also:

Serialized Form

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

PageIterator()

Method Summary

int	doAfterBody()
int	doEndTag()
int	doStartTag()
void	release()
void	setHiddenAttribute(String hiddenAttribute) If a page contains a boolean property with this name and it is set to true, the page is skipped by the iterator.

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

PageIterator

public PageIterator()

Method Detail

doAfterBody

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

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

doStartTag

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

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

setHiddenAttribute

public void setHiddenAttribute(String hiddenAttribute)

If a page contains a boolean property with this name and it is set to true, the page is skipped by the iterator. Defaults to "hidden".