org.sakaiproject.tool.gradebook.jsf.iterator
Class IteratorComponent

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended byorg.sakaiproject.tool.gradebook.jsf.iterator.IteratorComponent
All Implemented Interfaces:
NamingContainer, StateHolder
Direct Known Subclasses:
DhtmlPopupComponent

public class IteratorComponent
extends UIComponentBase
implements NamingContainer

A simple looping component which encodes all its children for every record in the input collection. ...


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
IteratorComponent()
           
 
Method Summary
 void decode(FacesContext context)
           
 void encodeBegin(FacesContext context)
           
 void encodeChildren(FacesContext context)
           
 void encodeEnd(FacesContext context)
           
protected  void encodeRecursive(FacesContext context, UIComponent component)
           
 String getFamily()
           
protected  Object getFieldOrBinding(Object field, String bindingName)
           
 boolean getRendersChildren()
           
 Object getValue()
           
 String getVar()
           
protected  void renderRowChildren(FacesContext context)
          Subclasses can decorate the children as they see fit.
 void restoreState(FacesContext context, Object state)
           
 Object saveState(FacesContext context)
           
 void setRowIndexVar(String rowIndexVar)
           
 void setValue(Object value)
           
 void setValueBinding(String name, ValueBinding binding)
           
 void setVar(String var)
           
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

IteratorComponent

public IteratorComponent()
Method Detail

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException
Throws:
IOException

renderRowChildren

protected void renderRowChildren(FacesContext context)
                          throws IOException
Subclasses can decorate the children as they see fit.

Throws:
IOException

encodeRecursive

protected void encodeRecursive(FacesContext context,
                               UIComponent component)
                        throws IOException
Throws:
IOException

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException
Throws:
IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException
Throws:
IOException

decode

public void decode(FacesContext context)

getRendersChildren

public boolean getRendersChildren()

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding)

getFieldOrBinding

protected Object getFieldOrBinding(Object field,
                                   String bindingName)

getValue

public Object getValue()

setValue

public void setValue(Object value)

getVar

public String getVar()

setVar

public void setVar(String var)

setRowIndexVar

public void setRowIndexVar(String rowIndexVar)

saveState

public Object saveState(FacesContext context)
Specified by:
saveState in interface StateHolder

restoreState

public void restoreState(FacesContext context,
                         Object state)
Specified by:
restoreState in interface StateHolder

getFamily

public String getFamily()