org.mmbase.bridge.jsp.taglib
Interface ListProvider

All Superinterfaces:

ContextProvider, JspTag, LoopTag, Tag, TagIdentifier

All Known Subinterfaces:

TreeProvider

All Known Implementing Classes:

AbstractNodeListTag, AbstractTreeReferrerListTag, AliasListTag, FieldListTag, GrowTag, ListFunctionTag, ListNodesTag, ListRelationsTag, ListTag, NodeListFunctionTag, NodeListHelper, QueryNextBatchesTag, QueryPreviousBatchesTag, RelatedNodesTag, RelatedTag, ShrinkTag, StringListTag, TreeTag, UnRelatedNodesTag

public interface ListProvider
extends ContextProvider, LoopTag

Basic interface that parent should implement if they provide Lists. For example the several NodeListTag's provide a List.

Version:

$Id: ListProvider.java 35335 2009-05-21 08:14:41Z michiel $

Author:

Michiel Meeuwissen

Nested Class Summary

static class

ListProvider.ListProviderLoopTagStatus

Field Summary

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Method Summary

Object	getCurrent()
int	getIndex()
int	getIndexOffset()
boolean	isChanged()
void	remove() Removes the current item from the list.
void	setAdd(String c)
void	setRemove(String c)
void	setRetain(String c)
int	size()

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

getContextContainer, getPageContext

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

getId

Methods inherited from interface javax.servlet.jsp.jstl.core.LoopTag

getLoopStatus

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

doEndTag, doStartTag, getParent, release, setPageContext, setParent

Method Detail

size

int size()

Returns:

the size of the list

getIndex

int getIndex()

Returns:

the index of the current item in a list

getIndexOffset

int getIndexOffset()

Returns:

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

Since:

MMBase-1.7

getCurrent

Object getCurrent()

Specified by:

getCurrent in interface LoopTag

Returns:

the current item in a list

isChanged

boolean isChanged()

Returns:

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

remove

void remove()

Removes the current item from the list.

Since:

MMBase-1.7

setAdd

void setAdd(String c)
            throws JspTagException

Throws:

JspTagException

Since:

MMBase-1.9

setRetain

void setRetain(String c)
               throws JspTagException

Throws:

JspTagException

Since:

MMBase-1.9

setRemove

void setRemove(String c)
               throws JspTagException

Throws:

JspTagException

Since:

MMBase-1.9