org.mmbase.bridge.jsp.taglib
Interface ListProvider

All Superinterfaces:

ContextProvider, LoopTag, Tag, TagIdentifier

All Known Subinterfaces:

TreeProvider

All Known Implementing Classes:

AbstractNodeListTag, org.mmbase.bridge.jsp.taglib.tree.AbstractTreeReferrerListTag, AliasListTag, FieldListTag, ListFunctionTag, NodeListFunctionTag, NodeListHelper, StringListTag, TreeTag

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,v 1.13 2005/12/15 21:47:27 michiel Exp $

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.
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

public int size()

Returns:

the size of the list

getIndex

public int getIndex()

Returns:

the index of the current item in a list

getIndexOffset

public int getIndexOffset()

Returns:

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

Since:

MMBase-1.7

getCurrent

public Object getCurrent()

Specified by:

getCurrent in interface LoopTag

Returns:

the current item in a list

isChanged

public boolean isChanged()

Returns:

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

remove

public void remove()

Removes the current item from the list.

Since:

MMBase-1.7