KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > icesoft > faces > async > render > AsyncRenderer


1 /*
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * "The contents of this file are subject to the Mozilla Public License
5  * Version 1.1 (the "License"); you may not use this file except in
6  * compliance with the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
11  * License for the specific language governing rights and limitations under
12  * the License.
13  *
14  * The Original Code is ICEfaces 1.5 open source software code, released
15  * November 5, 2006. The Initial Developer of the Original Code is ICEsoft
16  * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
17  * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved.
18  *
19  * Contributor(s): _____________________.
20  *
21  * Alternatively, the contents of this file may be used under the terms of
22  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
23  * License), in which case the provisions of the LGPL License are
24  * applicable instead of those above. If you wish to allow use of your
25  * version of this file only under the terms of the LGPL License and not to
26  * allow others to use your version of this file under the MPL, indicate
27  * your decision by deleting the provisions above and replace them with
28  * the notice and other provisions required by the LGPL License. If you do
29  * not delete the provisions above, a recipient may use your version of
30  * this file under either the MPL or the LGPL License."
31  *
32  */
33
34 package com.icesoft.faces.async.render;
35
36 public interface AsyncRenderer extends Disposable {
37
38     /**
39      * Get the current name of this AsyncRenderer. Names are used by the {@link
40      * RenderManager} to manage the various Renderers so that they can be easily
41      * accessed from different parts of the application.
42      *
43      * @return The current name of the AsyncRenderer.
44      */
45     public String JavaDoc getName();
46
47     /**
48      * Set the current name of this AsyncRenderer. Names are used by the {@link
49      * RenderManager} to manage the various Renderers so that they can be easily
50      * accessed from different parts of the application.
51      *
52      * @param name The desired name of the renderer.
53      */
54     public void setName(String JavaDoc name);
55
56     /**
57      * Used by the {@link RenderManager} to set the {@link RenderHub} for this
58      * AsyncRenderer.
59      *
60      * @param renderHub The RenderHub to use for this AsyncRenderer
61      */
62 // public void setRenderHub(RenderHub renderHub);
63
64     /**
65      * Used by the {@link RenderManager} to provide a reference to itself for
66      * this AsyncRenderer.
67      *
68      * @param renderManager The RenderManager to use for this AsyncRenderer
69      */
70     public void setRenderManager(RenderManager renderManager);
71
72     /**
73      * Called by the RenderManager when the the application is shutting down to
74      * allow the AsyncRenderer to clean up any resources (threads, collections,
75      * etc).
76      */
77     public void dispose();
78
79     /**
80      * The method called by the application when it wants to requrest a render
81      * pass for the one or more {@link Renderable}s handled by this
82      * AsyncRenderer.
83      */
84     public void requestRender();
85
86     /**
87      * The method called by dispose to halt a render pass at the current {@link
88      * Renderable}s.
89      */
90     public void requestStop();
91
92 }
93
Popular Tags