|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BlockIterator
This interface defines the methods necessary to implement a BlockIterator
Field Summary | |
---|---|
static String |
BLOCK_ITERATOR_CONTEXT
|
Method Summary | |
---|---|
String |
getName()
Get the block iterator name (from the block iterator template directive) |
Object |
getTemplateModels()
Provide the template models which back this iterator. |
boolean |
hasNext()
Allows the developer to return true if there are more rows to be processed |
void |
invalidateTemplateModels()
Clear the current template models (which will cause the component to be repopulated using getTemplateModels() |
boolean |
loadNext()
Actually allows developer to increment forward in the data layer. |
Node |
next(ViewContext vc,
Node templateNode)
Asks the developer to process a node (given the current data layer context) |
void |
postIterate()
Gets called after iteration is complete. |
void |
preIterate()
Gets called prior to iteration. |
void |
setName(String name)
Set the block iterator name (from the block iterator template directive) |
void |
updateTemplateModels(Object templateModels)
Provide a method to immeditately force an update on the model(s) that back this iterator. |
Field Detail |
---|
static final String BLOCK_ITERATOR_CONTEXT
Method Detail |
---|
void setName(String name)
String getName()
void preIterate()
boolean hasNext()
boolean loadNext()
Node next(ViewContext vc, Node templateNode) throws RenderException
RenderException
Object getTemplateModels()
void postIterate()
void invalidateTemplateModels()
void updateTemplateModels(Object templateModels)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |