com.icesoft.faces.async.render
Class DelayRenderer

java.lang.Object
  com.icesoft.faces.async.render.GroupAsyncRenderer
      com.icesoft.faces.async.render.OnDemandRenderer
          com.icesoft.faces.async.render.DelayRenderer

All Implemented Interfaces:

AsyncRenderer, java.lang.Runnable

public class DelayRenderer

extends OnDemandRenderer

implements java.lang.Runnable

The DelayRenderer is type of GroupAsyncRenderer that is used to request a single render pass on a group of Renderables. The render pass is executed after a specified time delay. DelayRenderers can be created and used directly but it is recommended to use the RenderManager to create and managed named render groups.

Author:

ICEsoft Technologies, Inc.

See Also:

RenderManager, GroupAsyncRenderer

Field Summary

Fields inherited from class com.icesoft.faces.async.render.GroupAsyncRenderer

group, name, renderManager, stopRequested

Constructor Summary

DelayRenderer()

Method Summary

void	dispose() Remove all Renderables from the group and removes the reference to the RenderHub.
long	getDelay()
void	requestRender() Schedules a render pass on the group of Renderables using the delay value specified using this.setDelay.
void	run()
void	setDelay(long delay)

Methods inherited from class com.icesoft.faces.async.render.GroupAsyncRenderer

add, clear, getName, remove, requestStop, setName, setRenderManager

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayRenderer

public DelayRenderer()

Method Detail

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

requestRender

public void requestRender()

Schedules a render pass on the group of Renderables using the delay value specified using this.setDelay. If a delay value was not explicitly set, then the default delay value (60000 ms) is used.

Specified by:

requestRender in interface AsyncRenderer

Overrides:

requestRender in class GroupAsyncRenderer

run

public void run()

Specified by:

run in interface java.lang.Runnable

dispose

public void dispose()

Description copied from class: GroupAsyncRenderer

Remove all Renderables from the group and removes the reference to the RenderHub. Once disposed, a GroupAsyncRenderer cannot be re-used. This method is typically used by the RenderManager to cleanly dispose of all managed Renderers when the application is shutting down.

Specified by:

dispose in interface AsyncRenderer

Overrides:

dispose in class GroupAsyncRenderer