forward"

From Documentation
m
m
Line 9: Line 9:
 
It is used to forward an event, that is targeting a specific component, to another component in another event name. It is called the forward condition.
 
It is used to forward an event, that is targeting a specific component, to another component in another event name. It is called the forward condition.
  
The forward event is an instance of the <javadoc>org.zkoss.zk.ui.event.ForwardEvent</javadoc> class. you can invoke the <tt>getOrigin</tt> method to retrieve the original event.
+
The forward event is an instance of the <javadoc>org.zkoss.zk.ui.event.ForwardEvent</javadoc> class. you can invoke <javadoc method="getOrigin()">org.zkoss.zk.ui.event.ForwardEvent</javadoc>. to retrieve the original event.
  
 
The original event is optional. If it is omitted, <tt>onClick</tt> is assumed. Similarly, the target ID is also optional. If omitted, the space owner is assumed.
 
The original event is optional. If it is omitted, <tt>onClick</tt> is assumed. Similarly, the target ID is also optional. If omitted, the space owner is assumed.
  
The data specified in the parenthesis is the application-specific data, which can be retrieved by calling the <tt>getData</tt> method.
+
You could specify any application-specific data in the forward condition by surrunding it with the parenthesis as shown below.
  
 
<source lang="xml" >
 
<source lang="xml" >
Line 20: Line 20:
 
</source>
 
</source>
  
If you want to forward several events, you can specify these conditions in the forward attribute by separating them with the comma (,):
+
Then, the application-specific data can be retrieved by use of <javadoc method="getData()">org.zkoss.zk.ui.event.ForwardEvent</javadoc>.
 +
 
 +
If you want to forward several events, you can specify all these conditions in the forward attribute by separating them with the comma (,):
  
 
<source lang="xml" >
 
<source lang="xml" >

Revision as of 09:04, 8 April 2011

Syntax:

forward="orginalEvent=targetId1/targetId2.targetEvent"
forward="orginalEvent=targetId1/targetId2.targetEvent(eventData)"
forward="originalEvent=${el-target}.targetEvent(${el-eventdata})"
forward="targetEvent"

It is used to forward an event, that is targeting a specific component, to another component in another event name. It is called the forward condition.

The forward event is an instance of the ForwardEvent class. you can invoke ForwardEvent.getOrigin(). to retrieve the original event.

The original event is optional. If it is omitted, onClick is assumed. Similarly, the target ID is also optional. If omitted, the space owner is assumed.

You could specify any application-specific data in the forward condition by surrunding it with the parenthesis as shown below.

 <button forward="onCancel(abort)"/><!-- "abort" is passed -->
 <button forward="onPrint(${inf})"/><!-- the object returned by ${inf} is passed -->

Then, the application-specific data can be retrieved by use of ForwardEvent.getData().

If you want to forward several events, you can specify all these conditions in the forward attribute by separating them with the comma (,):

 <textbox forward="onChanging=onUpdating, onChange=some.onUpdate"/>

The target component and the event data can be specified in EL expressions, while the event names cannot.

Version History

Version Date Content
     



Last Update : 2011/04/08

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