01: /* Updatable.java
02:
03: {{IS_NOTE
04: Purpose:
05:
06: Description:
07:
08: History:
09: Thu Jul 21 18:50:03 2005, Created by tomyeh
10: }}IS_NOTE
11:
12: Copyright (C) 2005 Potix Corporation. All Rights Reserved.
13:
14: {{IS_RIGHT
15: This program is distributed under GPL Version 2.0 in the hope that
16: it will be useful, but WITHOUT ANY WARRANTY.
17: }}IS_RIGHT
18: */
19: package org.zkoss.zk.ui.ext.client;
20:
21: import org.zkoss.zk.ui.UiException;
22:
23: /**
24: * Implemented by the object returned by {@link org.zkoss.zk.ui.sys.ComponentCtrl#getExtraCtrl}
25: * if a component supports special updates (other than async-update).
26: *
27: * <h2>Supported special updates</h2>
28: * <h3>File upload</h3>
29: * <ol>
30: * <li>Component uses to use inner-frame or other mechanism to submit a file
31: * to {@link org.zkoss.zk.au.http.DHtmlUpdateServlet}'s /upload.
32: * <li>DHtmlUpdateServlet than store the result in desktop's attribute,
33: * and ask client to do a standard async-update called updateResult.
34: * <li>When client sends the updateResult request to the server, server invokes
35: * {@link #setResult} to put the upload result to the component.
36: * </ol>
37: *
38: * @author tomyeh
39: */
40: public interface Updatable {
41: /** Sets the result when it is updated from the client successfully.
42: */
43: public void setResult(Object result);
44: }
|