org.alfresco.web.ui.common.renderer.data
Interface IRichListRenderer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AVMListRenderer.DetailsViewRenderer, ForumsBean.TopicBubbleViewRenderer, RichListRenderer.DetailsViewRenderer, RichListRenderer.IconViewRenderer, RichListRenderer.ListViewRenderer

public interface IRichListRenderer
extends java.io.Serializable

Contract for implementations capable of rendering the columns for a Rich List component.


Method Summary
 java.lang.String getViewModeID()
          Return the unique view mode identifier that this renderer is responsible for.
 void renderListAfter(javax.faces.context.FacesContext context, UIRichList richList, UIColumn[] columns)
          Callback executed by the RichList component to render any adornments after the main list rows are rendered.
 void renderListBefore(javax.faces.context.FacesContext context, UIRichList richList, UIColumn[] columns)
          Callback executed by the RichList component to render any adornments before the main list rows are rendered.
 void renderListRow(javax.faces.context.FacesContext context, UIRichList richList, UIColumn[] columns, java.lang.Object row)
          Callback executed by the RichList component once per row of data to be rendered.
 

Method Detail

renderListBefore

void renderListBefore(javax.faces.context.FacesContext context,
                      UIRichList richList,
                      UIColumn[] columns)
                      throws java.io.IOException
Callback executed by the RichList component to render any adornments before the main list rows are rendered. This is generally used to output header items.

Parameters:
context - FacesContext
richList - The parent RichList component
columns - Array of columns to be shown
Throws:
java.io.IOException

renderListRow

void renderListRow(javax.faces.context.FacesContext context,
                   UIRichList richList,
                   UIColumn[] columns,
                   java.lang.Object row)
                   throws java.io.IOException
Callback executed by the RichList component once per row of data to be rendered. The bean used as the current row data is provided, but generally rendering of the column data will be performed by recursively encoding Column child components.

Parameters:
context - FacesContext
richList - The parent RichList component
columns - Array of columns to be shown
row - The data bean for the current row
Throws:
java.io.IOException

renderListAfter

void renderListAfter(javax.faces.context.FacesContext context,
                     UIRichList richList,
                     UIColumn[] columns)
                     throws java.io.IOException
Callback executed by the RichList component to render any adornments after the main list rows are rendered. This is generally used to output footer items.

Parameters:
context - FacesContext
richList - The parent RichList component
columns - Array of columns to be shown
Throws:
java.io.IOException

getViewModeID

java.lang.String getViewModeID()
Return the unique view mode identifier that this renderer is responsible for.

Returns:
Unique view mode identifier for this renderer e.g. "icons" or "details"


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.