01: /* ZidRequired.java
02:
03: {{IS_NOTE
04: Purpose:
05:
06: Description:
07:
08: History:
09: Fri Oct 13 15:47:20 2006, Created by tomyeh
10: }}IS_NOTE
11:
12: Copyright (C) 2006 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.render;
20:
21: /**
22: * Implemented by the object returned by {@link org.zkoss.zk.ui.sys.ComponentCtrl#getExtraCtrl}
23: * if the component might be accessible at the client with
24: * {@link org.zkoss.zk.ui.Component#getId}.
25: *
26: * <p>In other words, the client engine will handle extra info related to
27: * {@link org.zkoss.zk.ui.IdSpace} when this interface is declared and
28: * {@link #isZidRequired} returns true.
29: *
30: * <p>Most components don't need to implement this interface for the object
31: * returned by {@link org.zkoss.zk.ui.sys.ComponentCtrl#getExtraCtrl}.
32: *
33: * <p>Note: if a component is NOT derived from {@link org.zkoss.zk.ui.HtmlBasedComponent},
34: * it has to detect this interface and generate z.zid if {@link #isZidRequired}
35: * return true.
36: *
37: * @author tomyeh
38: */
39: public interface ZidRequired {
40: /** Returns whether the component that owns this object
41: * can be accessible at the client with
42: * {@link org.zkoss.zk.ui.Component#getId}.
43: */
44: public boolean isZidRequired();
45: }
|