List of Implicit Objects"

From Documentation
(Created page with '{{ZKDevelopersGuidePageHeader}} {| border="1" ! <center>Object Name</center> ! <center>Type</center> ! <center>Description</center> |- | self | [http://www.zkoss.org/javadoc/…')
 
m (correct highlight (via JWB))
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{ZKDevelopersGuidePageHeader}}
 
{{ZKDevelopersGuidePageHeader}}
 +
 +
{{Old Version
 +
|url=http://books.zkoss.org/wiki/ZUML_Reference/EL_Expressions/Implicit_Objects
 +
|}}
 +
  
 
{| border="1"
 
{| border="1"
Line 8: Line 13:
 
|-
 
|-
 
|  self
 
|  self
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/Component.html <tt>org.zkoss.zk.ui.Component</tt>]
+
|  [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 19:
 
|-
 
|-
 
|  spaceOwner
 
|  spaceOwner
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/idspace.html <tt>org.zkoss.zk.ui.IdSpace</tt>]
+
|  [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 <tt>self.spaceOwner</tt>.
+
|The space owner of this component. It is the same as <javadoc type="interface">self.spaceOwner</javadoc>.
  
 
|-
 
|-
 
|  page
 
|  page
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/page.html <tt>org.zkoss.zk.ui.Page</tt>]
+
|  [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 <code>self.page</code>.
  
 
|-
 
|-
 
|  desktop
 
|  desktop
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/desktop.html <tt>org.zkoss.zk.ui.Desktop</tt>]
+
|  [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 <code>self.desktop</code>.
  
 
|-
 
|-
 
|  execution
 
|  execution
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/execution.html <tt>org.zkoss.zk.ui.Execution</tt>]
+
|  [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 43:
 
|-
 
|-
 
|  session
 
|  session
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/session.html <tt>org.zkoss.zk.ui.Session</tt>]
+
|  [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 49:
 
|-
 
|-
 
|  application
 
|  application
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/webapp.html <tt>org.zkoss.zk.ui.WebApp</tt>]
+
|  [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 50: Line 55:
 
|-
 
|-
 
|  componentScope
 
|  componentScope
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the component. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.Component</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <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 62: Line 67:
 
|-
 
|-
 
|  pageScope
 
|  pageScope
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the page. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.Page</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the desktop. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.Desktop</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the session. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.Session</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the web application. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.WebApp</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes defined in the request. It is the same as the <tt>getAttributes</tt> method in the <tt>org.zkoss.zk.ui.Execution</tt> interface.
+
|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
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|A map of attributes passed by the query string. Please refer to section [[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.
  
 
|-
 
|-
 
|  arg
 
|  arg
|  <tt>java.util.Map</tt>
+
|  <code>java.util.Map</code>
  
|The <tt>arg</tt> argument passed to the <tt>createComponents</tt> method in the <tt>org.zkoss.zk.ui.Executions</tt> class. It is never <tt>null</tt>.
+
|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 <tt>self.desktop.execution.arg</tt>.
+
It is the same as <code>self.desktop.execution.arg</code>.
  
Notice that <tt>arg</tt> is available only when creating the components for the included page (the first argument of <tt>createComponents</tt>). On the other hand, all events, including <tt>onCreate</tt>, are processed later. Thus, if you want to access <tt>arg</tt> in the <tt>onCreate</tt>'s listener, use the <tt>getArg</tt> method of the <tt>org.zkoss.zk.ui.event.CreateEvent</tt> class.
+
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 110: Line 115:
 
|-
 
|-
 
|  each
 
|  each
|  <tt>java.lang.Object</tt>
+
|  <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.
Line 116: Line 121:
 
|-
 
|-
 
|  forEachStatus
 
|  forEachStatus
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/util/foreachstatus.html <tt>org.zkoss.zk.ui.util.ForEachStatus</tt>]
+
|  [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 127:
 
|-
 
|-
 
|  event
 
|  event
|  [http://www.zkoss.org/javadoc/3.5.1/zk/org/zkoss/zk/ui/event/event.html <tt>org.zkoss.zk.ui.event.Event</tt>] or derived
+
|  [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.

Latest revision as of 10:36, 19 January 2022

Stop.png This documentation is for an older version of ZK. For the latest one, please click here.


Stop.png This documentation is for an older version of ZK. For the latest one, please click here.


Object Name
Type
Description
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.



Last Update : 2022/01/19

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.