List of Implicit Objects"
From Documentation
Maya001122 (talk | contribs) (Created page with '{{ZKDevelopersGuidePageHeader}} {| border="1" ! <center>Object Name</center> ! <center>Type</center> ! <center>Description</center> |- | self | [http://www.zkoss.org/javadoc/…') |
Maya001122 (talk | contribs) m |
||
| Line 8: | Line 8: | ||
|- | |- | ||
| self | | self | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/Component.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/Component.html <javadoc type="interface">org.zkoss.zk.ui.Component</javadoc>] |
|The component itself. | |The component itself. | ||
| Line 14: | Line 14: | ||
|- | |- | ||
| spaceOwner | | spaceOwner | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/idspace.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/idspace.html <javadoc type="interface">org.zkoss.zk.ui.IdSpace</javadoc>] |
| − | |The space owner of this component. It is the same as < | + | |The space owner of this component. It is the same as <javadoc>self.spaceOwner</javadoc>. |
|- | |- | ||
| page | | page | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/page.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/page.html <javadoc type="interface">org.zkoss.zk.ui.Page</javadoc>] |
|The page. It is the same as <tt>self.page</tt>. | |The page. It is the same as <tt>self.page</tt>. | ||
| Line 26: | Line 26: | ||
|- | |- | ||
| desktop | | desktop | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/desktop.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/desktop.html <javadoc type="interface">org.zkoss.zk.ui.Desktop</javadoc>] |
|The desktop. It is the same as <tt>self.desktop</tt>. | |The desktop. It is the same as <tt>self.desktop</tt>. | ||
| Line 32: | Line 32: | ||
|- | |- | ||
| execution | | execution | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/execution.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/execution.html <javadoc type="interface">org.zkoss.zk.ui.Execution</javadoc>] |
|The current execution. | |The current execution. | ||
| Line 38: | Line 38: | ||
|- | |- | ||
| session | | session | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/session.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/session.html <javadoc type="interface">org.zkoss.zk.ui.Session</javadoc>] |
|The session. | |The session. | ||
| Line 44: | Line 44: | ||
|- | |- | ||
| application | | application | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/webapp.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/webapp.html <javadoc type="interface">org.zkoss.zk.ui.WebApp</javadoc>] |
|The Web application. | |The Web application. | ||
| Line 52: | Line 52: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the component. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the component. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.Component</javadoc> interface. |
|- | |- | ||
| Line 64: | Line 64: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the page. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the page. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.Page</javadoc> interface. |
|- | |- | ||
| Line 70: | Line 70: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the desktop. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the desktop. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.Desktop</javadoc> interface. |
|- | |- | ||
| Line 76: | Line 76: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the session. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the session. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.Session</javadoc> interface. |
|- | |- | ||
| Line 82: | Line 82: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the web application. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the web application. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.WebApp</javadoc> interface. |
|- | |- | ||
| Line 88: | Line 88: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |A map of attributes defined in the request. It is the same as the <tt>getAttributes</tt> method in the < | + | |A map of attributes defined in the request. It is the same as the <tt>getAttributes</tt> method in the <javadoc type="interface">org.zkoss.zk.ui.Execution</javadoc> interface. |
|- | |- | ||
| Line 100: | Line 100: | ||
| <tt>java.util.Map</tt> | | <tt>java.util.Map</tt> | ||
| − | |The <tt>arg</tt> argument passed to the <tt>createComponents</tt> method in the < | + | |The <tt>arg</tt> argument passed to the <tt>createComponents</tt> method in the <javadoc>org.zkoss.zk.ui.Executions</javadoc> class. It is never <tt>null</tt>. |
It is the same as <tt>self.desktop.execution.arg</tt>. | It is the same as <tt>self.desktop.execution.arg</tt>. | ||
| Line 116: | Line 116: | ||
|- | |- | ||
| forEachStatus | | forEachStatus | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/util/foreachstatus.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/util/foreachstatus.html <javadoc type="interface">org.zkoss.zk.ui.util.ForEachStatus</javadoc>] |
|The status of an iteration. ZK exposes the information relative to the iteration taking place when evaluating the iterative element. | |The status of an iteration. ZK exposes the information relative to the iteration taking place when evaluating the iterative element. | ||
| Line 122: | Line 122: | ||
|- | |- | ||
| event | | event | ||
| − | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/event/event.html < | + | | [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/event/event.html <javadoc>org.zkoss.zk.ui.event.Event</javadoc>] or derived |
|The current event. Available for the event listener only. | |The current event. Available for the event listener only. | ||
Revision as of 01:22, 13 July 2010
This documentation is for an older version of ZK. For the latest one, please click here.
| self | Component | The component itself. |
| spaceOwner | IdSpace | The space owner of this component. It is the same as Owner. |
| page | Page | The page. It is the same as self.page. |
| desktop | Desktop | The desktop. It is the same as self.desktop. |
| execution | Execution | The current execution. |
| session | Session | The session. |
| application | WebApp | The Web application. |
| componentScope | java.util.Map | A map of attributes defined in the component. It is the same as the getAttributes method in the Component interface. |
| spaceScope | java.util.Map | A map of attributes defined in the ID space containing this component. |
| pageScope | java.util.Map | A map of attributes defined in the page. It is the same as the getAttributes method in the Page interface. |
| desktopScope | java.util.Map | A map of attributes defined in the desktop. It is the same as the getAttributes method in the Desktop interface. |
| sessionScope | java.util.Map | A map of attributes defined in the session. It is the same as the getAttributes method in the Session interface. |
| applicationScope | java.util.Map | A map of attributes defined in the web application. It is the same as the getAttributes method in the WebApp interface. |
| requestScope | java.util.Map | A map of attributes defined in the request. It is the same as the getAttributes method in the Execution interface. |
| param | java.util.Map | A map of attributes passed by the query string. Please refer to section Pass Values to the Included Page for example. |
| arg | java.util.Map | The arg argument passed to the createComponents method in the Executions class. It is never null.
It is the same as self.desktop.execution.arg. Notice that arg is available only when creating the components for the included page (the first argument of createComponents). On the other hand, all events, including onCreate, are processed later. Thus, if you want to access arg in the onCreate's listener, use the getArg method of the org.zkoss.zk.ui.event.CreateEvent class.
|
| each | java.lang.Object | The current item of the collection being iterated, when ZK evaluates an iterative element. An iterative element is an element with the forEach attribute. |
| forEachStatus | ForEachStatus | The status of an iteration. ZK exposes the information relative to the iteration taking place when evaluating the iterative element. |
| event | Event or derived | The current event. Available for the event listener only. |
Implicit objects provides many useful methods for web application. You can click the hyperlink to see the java doc of each implicit object.