com.icesoft.faces.async.render
Interface AsyncRenderer

All Known Implementing Classes:

GroupAsyncRenderer

public interface AsyncRenderer

Method Summary

void	dispose() Called by the RenderManager when the the application is shutting down to allow the AsyncRenderer to clean up any resources (threads, collections, etc).
java.lang.String	getName() Get the current name of this AsyncRenderer.
void	requestRender() The method called by the application when it wants to requrest a render pass for the one or more Renderables handled by this AsyncRenderer.
void	requestStop() The method called by dispose to halt a render pass at the current Renderables.
void	setName(java.lang.String name) Set the current name of this AsyncRenderer.
void	setRenderManager(RenderManager renderManager) Used by the RenderManager to provide a reference to itself for this AsyncRenderer.

Method Detail

getName

public java.lang.String getName()

Get the current name of this AsyncRenderer. Names are used by the RenderManager to manage the various Renderers so that they can be easily accessed from different parts of the application.

Returns:

The current name of the AsyncRenderer.

setName

public void setName(java.lang.String name)

Set the current name of this AsyncRenderer. Names are used by the RenderManager to manage the various Renderers so that they can be easily accessed from different parts of the application.

Parameters:

name - The desired name of the renderer.

setRenderManager

public void setRenderManager(RenderManager renderManager)

Used by the RenderManager to provide a reference to itself for this AsyncRenderer.

Parameters:

renderManager - The RenderManager to use for this AsyncRenderer

dispose

public void dispose()

Called by the RenderManager when the the application is shutting down to allow the AsyncRenderer to clean up any resources (threads, collections, etc).

requestRender

public void requestRender()

The method called by the application when it wants to requrest a render pass for the one or more Renderables handled by this AsyncRenderer.

requestStop

public void requestStop()

The method called by dispose to halt a render pass at the current Renderables.