List of Implicit Objects"
From Documentation
m (correct highlight (via JWB)) |
|||
| Line 27: | Line 27: | ||
| [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/page.html <javadoc type="interface">org.zkoss.zk.ui.Page</javadoc>] | | [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 < | + | |The page. It is the same as <code>self.page</code>. |
|- | |- | ||
| Line 33: | Line 33: | ||
| [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/desktop.html <javadoc type="interface">org.zkoss.zk.ui.Desktop</javadoc>] | | [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 < | + | |The desktop. It is the same as <code>self.desktop</code>. |
|- | |- | ||
| Line 55: | Line 55: | ||
|- | |- | ||
| componentScope | | componentScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the component. It is the same as the < | + | |A map of attributes defined in the component. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.Component</javadoc> interface. |
|- | |- | ||
| spaceScope | | spaceScope | ||
| − | | < | + | | <code>java.util.Map</code> |
|A map of attributes defined in the ID space containing this component. | |A map of attributes defined in the ID space containing this component. | ||
| Line 67: | Line 67: | ||
|- | |- | ||
| pageScope | | pageScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the page. It is the same as the < | + | |A map of attributes defined in the page. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.Page</javadoc> interface. |
|- | |- | ||
| desktopScope | | desktopScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the desktop. It is the same as the < | + | |A map of attributes defined in the desktop. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.Desktop</javadoc> interface. |
|- | |- | ||
| sessionScope | | sessionScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the session. It is the same as the < | + | |A map of attributes defined in the session. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.Session</javadoc> interface. |
|- | |- | ||
| applicationScope | | applicationScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the web application. It is the same as the < | + | |A map of attributes defined in the web application. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.WebApp</javadoc> interface. |
|- | |- | ||
| requestScope | | requestScope | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |A map of attributes defined in the request. It is the same as the < | + | |A map of attributes defined in the request. It is the same as the <code>getAttributes</code> method in the <javadoc type="interface">org.zkoss.zk.ui.Execution</javadoc> interface. |
|- | |- | ||
| param | | param | ||
| − | | < | + | | <code>java.util.Map</code> |
|A map of attributes passed by the query string. Please refer to section [[ZK Developer's Guide/Migrate/Integrate Other UI frameworks/Work with HTML Tags#Pass_Values_to_the_Included_Page|Pass Values to the Included Page]] for example. | |A map of attributes passed by the query string. Please refer to section [[ZK Developer's Guide/Migrate/Integrate Other UI frameworks/Work with HTML Tags#Pass_Values_to_the_Included_Page|Pass Values to the Included Page]] for example. | ||
| Line 103: | Line 103: | ||
|- | |- | ||
| arg | | arg | ||
| − | | < | + | | <code>java.util.Map</code> |
| − | |The < | + | |The <code>arg</code> argument passed to the <code>createComponents</code> method in the <javadoc>org.zkoss.zk.ui.Executions</javadoc> class. It is never <code>null</code>. |
| − | It is the same as < | + | It is the same as <code>self.desktop.execution.arg</code>. |
| − | Notice that < | + | Notice that <code>arg</code> is available only when creating the components for the included page (the first argument of <code>createComponents</code>). On the other hand, all events, including <code>onCreate</code>, are processed later. Thus, if you want to access <code>arg</code> in the <code>onCreate</code>'s listener, use the <code>getArg</code> method of the <code>org.zkoss.zk.ui.event.CreateEvent</code> class. |
| Line 115: | Line 115: | ||
|- | |- | ||
| each | | each | ||
| − | | < | + | | <code>java.lang.Object</code> |
|The current item of the collection being iterated, when ZK evaluates an iterative element. An iterative element is an element with the forEach attribute. | |The current item of the collection being iterated, when ZK evaluates an iterative element. An iterative element is an element with the forEach attribute. | ||
Latest revision as of 10:36, 19 January 2022
This documentation is for an older version of ZK. For the latest one, please click here.
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 Notice that
|
| 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.