1 /*
2 * $Id: IAsyncRenderModeCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3 */
4 package org.rcfaces.core.component.capability;
5
6 /**
7 * A int value that indicates the rendering mode for asynchronous capable
8 * component.
9 * <LI>
10 * <UL>
11 * If value is "0:none", the rendering is synchronous (made with the englobing
12 * page rendering).
13 * </UL>
14 * <UL>
15 * If value is "1:buffer", the rendering is calculated with the page and may
16 * contains HTML elements, it is sent to the client only when needed
17 * (asynchrponously).
18 * </UL>
19 * <UL>
20 * If value is "2:tree", the rendering is calculated only when needed (the HTML
21 * elements are ignored)
22 * </UL>
23 * </LI>
24 *
25 * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
26 * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
27 */
28 public interface IAsyncRenderModeCapability {
29
30 int NONE_ASYNC_RENDER_MODE = 0;
31
32 int BUFFER_ASYNC_RENDER_MODE = 1;
33
34 int TREE_ASYNC_RENDER_MODE = 2;
35
36 int DEFAULT_ASYNC_RENDER_MODE = NONE_ASYNC_RENDER_MODE;
37
38 /**
39 * Returns a int value that indicates the rendering mode for asynchronous
40 * capable component.
41 *
42 * @return 0:none|1:buffer|2:tree
43 */
44 int getAsyncRenderMode();
45
46 /**
47 * Sets a int value that indicates the rendering mode for asynchronous
48 * capable component.
49 *
50 * @param renderMode
51 * 0:none|1:buffer|2:tree
52 */
53 void setAsyncRenderMode(int renderMode);
54 }