org.mmbase.bridge.jsp.taglib
Class StringListTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.mmbase.bridge.jsp.taglib.ContextReferrerTag
              org.mmbase.bridge.jsp.taglib.CloudReferrerTag
                  org.mmbase.bridge.jsp.taglib.NodeReferrerTag
                      org.mmbase.bridge.jsp.taglib.StringListTag

All Implemented Interfaces:

BodyTag, ContextProvider, IterationTag, ListProvider, LoopTag, Serializable, Tag, TagIdentifier, Writer

Direct Known Subclasses:

AliasListTag, QueryNextBatchesTag, QueryPreviousBatchesTag

public class StringListTag

extends NodeReferrerTag

implements ListProvider, Writer

This class makes a tag which can list strings.

Since:

MMBase-1.7

Version:

$Id: StringListTag.java,v 1.29 2006/07/05 20:39:15 michiel Exp $

Author:

Michiel Meeuwissen

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.mmbase.bridge.jsp.taglib.ListProvider

ListProvider.ListProviderLoopTagStatus

Field Summary

protected Attribute	add
protected Attribute	comparator
protected int	currentItemIndex
protected Iterator	iterator
protected Attribute	max
protected Attribute	remove
protected Attribute	retain
protected List	returnList

Fields inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag

parentNodeId

Fields inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

contextId, EVAL_BODY, helper, id, pageContextTag, referid, writerid

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Constructor Summary

StringListTag()

Method Summary

int	doAfterBody()
int	doEndTag()
int	doStartTag()
ContextContainer	getContextContainer()
Object	getCurrent()
int	getIndex()
int	getIndexOffset()
protected List	getList() Creates the actual list of strings.
LoopTagStatus	getLoopStatus()
protected int	getMaxNumber()
boolean	isChanged()
void	release() Release all allocated resources.
void	remove() Removes the current item from the list.
void	setAdd(String a)
void	setComparator(String c)
void	setMax(String m)
protected void	setNext()
void	setRemove(String r)
void	setRetain(String r)
int	size()
protected void	truncateList() For use with referid

Methods inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag

fillStandardParameters, findNodeProvider, findNodeProvider, getLocale, getNode, setElement, setNode

Methods inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag

findCloudProvider, findCloudProvider, getCloudContext, getCloudVar, getNode, getNodeOrNull, setCloud

Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

findLoopOrQuery, findParentTag, findParentTag, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getDefaultLocale, getEscapedValue, getId, getObject, getObjectConditional, getPageContext, getPageContextTag, getReferid, getString, getTaglibVersion, getTimeZone, getWriterValue, haveBody, setContext, setEscape, setId, setJspvar, setListdelimiter, setPageContext, setReferid, setVartype, setWrite, setWriter

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mmbase.bridge.jsp.taglib.ContextProvider

getPageContext

Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier

getId

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Methods inherited from interface org.mmbase.bridge.jsp.taglib.Writer

getWriterValue, haveBody, setEscape, setJspvar, setVartype, setWrite

Field Detail

returnList

protected List returnList

iterator

protected Iterator iterator

currentItemIndex

protected int currentItemIndex

max

protected Attribute max

comparator

protected Attribute comparator

add

protected Attribute add

retain

protected Attribute retain

remove

protected Attribute remove

Constructor Detail

StringListTag

public StringListTag()

Method Detail

size

public int size()

Specified by:

size in interface ListProvider

Returns:

the size of the list

getIndex

public int getIndex()

Specified by:

getIndex in interface ListProvider

Returns:

the index of the current item in a list

getIndexOffset

public int getIndexOffset()

Specified by:

getIndexOffset in interface ListProvider

Returns:

The offset of the index (normally this will return 1)

isChanged

public boolean isChanged()

Specified by:

isChanged in interface ListProvider

Returns:

a boolean indicating wether the field on which was sorted is changed.

getCurrent

public Object getCurrent()

Specified by:

getCurrent in interface ListProvider

Returns:

the current item in a list

remove

public void remove()

Description copied from interface: ListProvider

Removes the current item from the list.

Specified by:

remove in interface ListProvider

setMax

public void setMax(String m)
            throws JspTagException

Throws:

JspTagException

setAdd

public void setAdd(String a)
            throws JspTagException

Throws:

JspTagException

setRetain

public void setRetain(String r)
               throws JspTagException

Throws:

JspTagException

setRemove

public void setRemove(String r)
               throws JspTagException

Throws:

JspTagException

getMaxNumber

protected int getMaxNumber()
                    throws JspTagException

Throws:

JspTagException

setComparator

public void setComparator(String c)
                   throws JspTagException

Throws:

JspTagException

getContextContainer

public ContextContainer getContextContainer()

Specified by:

getContextContainer in interface ContextProvider

getList

protected List getList()
                throws JspTagException

Creates the actual list of strings.

Throws:

JspTagException

truncateList

protected void truncateList()
                     throws JspTagException

For use with referid

Throws:

JspTagException

doStartTag

public int doStartTag()
               throws JspTagException

Specified by:

doStartTag in interface Tag

Throws:

JspTagException

doAfterBody

public int doAfterBody()
                throws JspException

Specified by:

doAfterBody in interface IterationTag

Throws:

JspException

doEndTag

public int doEndTag()
             throws JspTagException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class ContextReferrerTag

Throws:

JspTagException

release

public void release()

Description copied from class: ContextReferrerTag

Release all allocated resources.

Specified by:

release in interface Tag

Overrides:

release in class ContextReferrerTag

setNext

protected void setNext()
                throws JspTagException

Throws:

JspTagException

getLoopStatus

public LoopTagStatus getLoopStatus()

Specified by:

getLoopStatus in interface LoopTag