org.mmbase.bridge.jsp.taglib
Interface ListProvider

All Superinterfaces:
ContextProvider, QueryContainerOrListProvider, 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, QueryContainerOrListProvider

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.8 2003/12/18 11:52:42 michiel Exp $
Author:
Michiel Meeuwissen

Method Summary
 java.lang.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
 
Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier
getId
 

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 java.lang.Object getCurrent()
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


MMBase build 1.7.1.20041002