| java.lang.Object
 com.icesoft.faces.async.render.GroupAsyncRenderer
All known Subclasses: com.icesoft.faces.async.render.OnDemandRenderer,
| GroupAsyncRenderer | | public class GroupAsyncRenderer implements AsyncRenderer(Code) | | The GroupAsyncRenderer is the foundation class for other types of renderers
that are designed to operate on a group of
Renderable s. It
implements the
AsyncRenderer interface and is mainly responsible for
smartly managing a group of Renderable instances.
Groups of Renderables are stored as WeakReferences in special sets that are
copied before each render pass so that Renderables can be safely added and
removed from the group while a render pass is in progress.
Although it is possible to create and use GroupRenderers directly, developers
are advised to use the
RenderManager to create and use named render
groups.
author:
ICEsoft Technologies, Inc.
See Also: RenderManager, OnDemandRenderer, IntervalRenderer, DelayRenderer |
| Method Summary | |
| public void | add(Renderable renderable)
Adds a Renderable, via a WeakReference, to the set of Renderables of this
group. | | public void | clear()
Removes all Renderables from the group. | | public boolean | contains(Renderable renderable)
| | public void | dispose()
Remove all Renderables from the group and removes the reference to the
RenderHub. | | public String | getName()
| | public boolean | isEmpty()
Used to determine if the Renderer has any Renderables left in its
collection. | | public void | remove(Renderable renderable)
Removes a Renderable, via a WeakReference, from the set of Renderables of
this group. | | public void | requestRender()
Request a render pass on all the Renderables in the group. | | public void | requestStop()
The method called by dispose to halt a render pass at the current
Renderable s. | | public void | setName(String name)
| | public void | setRenderManager(RenderManager renderManager)
|
| stopRequested | | protected boolean stopRequested(Code) | | |
| GroupAsyncRenderer | | public GroupAsyncRenderer()(Code) | | |
| add | | public void add(Renderable renderable)(Code) | | Adds a Renderable, via a WeakReference, to the set of Renderables of this
group. If the Renderable is already in this set, it is not added again.
Parameters:
renderable - the Renderable instance to add to the group. |
| clear | | public void clear()(Code) | | Removes all Renderables from the group.
|
| dispose | | public void dispose()(Code) | | 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.
|
| isEmpty | | public boolean isEmpty()(Code) | | Used to determine if the Renderer has any Renderables left in its
collection.
false if there are 1 or more Renderables left in the Renderer'scollection, true otherwise |
| remove | | public void remove(Renderable renderable)(Code) | | Removes a Renderable, via a WeakReference, from the set of Renderables of
this group.
Parameters:
renderable - the Renderable instance to remove |
| requestRender | | public void requestRender()(Code) | | Request a render pass on all the Renderables in the group. Render calls
that generate exceptions are passed back to the Renderable.renderException
throws:
IllegalStateException - If a reference to a RenderHub hasnot yet been set. |
| requestStop | | public void requestStop()(Code) | | The method called by dispose to halt a render pass at the current
Renderable s.
|
|
|