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

Class RichListRenderer.ListViewRenderer

java.lang.Object

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

All Implemented Interfaces:

Serializable, IRichListRenderer

Enclosing class:

RichListRenderer

public static class RichListRenderer.ListViewRenderer
extends Object
implements IRichListRenderer

Class to implement a List view for the RichList component

Author:

kevinr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	VIEWMODEID

Constructor Summary

Constructors

Constructor and Description
ListViewRenderer()

Method Summary

Modifier and Type	Method and Description
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, Object row) Callback executed by the RichList component once per row of data to be rendered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIEWMODEID

public static final String VIEWMODEID

See Also:

Constant Field Values

Constructor Detail

ListViewRenderer

public ListViewRenderer()

Method Detail

getViewModeID

public String getViewModeID()

Description copied from interface: IRichListRenderer

Return the unique view mode identifier that this renderer is responsible for.

Specified by:

getViewModeID in interface IRichListRenderer

Returns:

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

renderListBefore

public void renderListBefore(javax.faces.context.FacesContext context,
                             UIRichList richList,
                             UIColumn[] columns)
                      throws IOException

Description copied from interface: IRichListRenderer

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.

Specified by:

renderListBefore in interface IRichListRenderer

Parameters:

context - FacesContext

richList - The parent RichList component

columns - Array of columns to be shown

Throws:

IOException

renderListRow

public void renderListRow(javax.faces.context.FacesContext context,
                          UIRichList richList,
                          UIColumn[] columns,
                          Object row)
                   throws IOException

Description copied from interface: IRichListRenderer

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.

Specified by:

renderListRow in interface IRichListRenderer

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

public void renderListAfter(javax.faces.context.FacesContext context,
                            UIRichList richList,
                            UIColumn[] columns)
                     throws IOException

Description copied from interface: IRichListRenderer

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.

Specified by:

renderListAfter in interface IRichListRenderer

Parameters:

context - FacesContext

richList - The parent RichList component

columns - Array of columns to be shown

Throws:

IOException