| java.lang.Object
 com.icesoft.faces.async.render.RenderManager
| RenderManager | | public class RenderManager implements Disposable(Code) | | The RenderManager is the central class for developers wanting to do
server-initiated rendering. The recommended use is to have a single
RenderManager for your application, typically configured as a
application-scope, managed bean. Any class that needs to request server side
render calls can do so using the RenderManager.
Server-initiated renders can be requested directly via the
RenderManager.requestRender requestRender method or you get a named
GroupAsyncRenderer and add a Renderable implementation to request and
receive render calls as part of a group.
The RenderManager contains a reference to a single
RenderHub that
uses a special queue and thread pool to optimize render calls for reliability
and scalability.
|
| Field Summary | |
| final public static int | DELAY
| | final public static int | INTERVAL
| | final static int | MAX
| | final static int | MIN
| | final public static int | ON_DEMAND
|
| Constructor Summary | |
| public | RenderManager()
No argument constructor suitable for using as a managed bean. |
| DELAY | | final public static int DELAY(Code) | | |
| INTERVAL | | final public static int INTERVAL(Code) | | |
| ON_DEMAND | | final public static int ON_DEMAND(Code) | | |
| RenderManager | | public RenderManager()(Code) | | No argument constructor suitable for using as a managed bean.
|
| dispose | | public void dispose()(Code) | | This is typically called when the application is shutting down and we
need to dispose of all the RenderManager's resources. It iterates
through all of the named
GroupAsyncRenderer s, calling dispose on
each of them in turn. It then calls dispose on the
RenderHub .
Once the RenderManager has been disposed, it can no longer be used.
|
| getDelayRenderer | | public DelayRenderer getDelayRenderer(String name)(Code) | | The DelayRenderer is a
GroupAsyncRenderer that requests a
server-initiated render of all the Renderables in its collection. The
request to render is made once at a set point in the future.
Thsi method returns the appropriate GroupAsyncRenderer based on the name.
If the name is new, a new instance is created and stored in the
RenderManager's collection. If the named GroupAsyncRenderer already
exists, and it's of the proper type, then the existing instance is
returned.
Parameters:
name - the name of the GroupAsyncRenderer a new or existing GroupAsyncRenderer, based on the name |
| getIntervalRenderer | | public IntervalRenderer getIntervalRenderer(String name)(Code) | | The IntervalRenderer is a
GroupAsyncRenderer that requests a
server-initiated render of all the Renderables in its collection. The
request to render is made repeatedly at the set interval.
Thsi method returns the appropriate GroupAsyncRenderer based on the name.
If the name is new, a new instance is created and stored in the
RenderManager's collection. If the named GroupAsyncRenderer already
exists, and it's of the proper type, then the existing instance is
returned.
Parameters:
name - the name of the GroupAsyncRenderer a new or existing GroupAsyncRenderer, based on the name |
| getOnDemandRenderer | | public OnDemandRenderer getOnDemandRenderer(String name)(Code) | | The OnDemandRenderer is a
GroupAsyncRenderer that requests a
server-initiated render of all the Renderables in its collection. The
request is made immediately upon request.
Thsi method returns the appropriate GroupAsyncRenderer based on the name.
If the name is new, a new instance is created and stored in the
RenderManager's collection. If the named GroupAsyncRenderer already
exists, and it's of the proper type, then the existing instance is
returned.
Parameters:
name - the name of the GroupAsyncRenderer a new or existing GroupAsyncRenderer, based on the name |
| getRenderer | | public AsyncRenderer getRenderer(String rendererName)(Code) | | Returns the named instance of an AsyncRenderer if it already exists
otherwise it returns null.
Parameters:
rendererName - The name of the AsycRender to retrieve. An instance of an AsyncRenderer that is associated with theprovided name. |
| getScheduledService | | ScheduledThreadPoolExecutor getScheduledService()(Code) | | This method is used by
GroupAsyncRenderer s that need to request
render calls based on some sort of schedule. It uses a separate,
configurable thread pool and queue than the core rendering service.
the scheduled executor for this RenderManager |
| removeRenderer | | protected void removeRenderer(AsyncRenderer renderer)(Code) | | When an AsyncRenderer disposes itself, it also needs to remove itself
from the RenderManager's collection.
Parameters:
renderer - The Renderer to remove |
| requestRender | | public void requestRender(Renderable renderable)(Code) | | Submits the supplied Renderable instance to the RenderHub for
server-initiated render.
Parameters:
renderable - The Renderable instance to render. |
|
|