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

Interface IRichListRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ForumsBean.TopicBubbleViewRenderer, RichListRenderer.DetailsViewRenderer, RichListRenderer.IconViewRenderer, RichListRenderer.ListViewRenderer

public interface IRichListRenderer
extends Serializable

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

Author:

kevinr

Method Summary

Modifier and Type	Method and Description
String	getViewModeID() Return the unique view mode identifier that this renderer is responsible for.
void	renderListAfter(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(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(FacesContext context, UIRichList richList, UIColumn[] columns, Object row) Callback executed by the RichList component once per row of data to be rendered.

Method Detail

renderListBefore

void renderListBefore(FacesContext context,
                      UIRichList richList,
                      UIColumn[] columns)
               throws 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:

IOException

renderListRow

void renderListRow(FacesContext context,
                   UIRichList richList,
                   UIColumn[] columns,
                   Object row)
            throws 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:

IOException

renderListAfter

void renderListAfter(FacesContext context,
                     UIRichList richList,
                     UIColumn[] columns)
              throws 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:

IOException

getViewModeID

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"