ZK Developer's Reference/Event Handling/Event Forwarding

Overview

For easy programming, ZK does not introduce any complex event flow. When an event is sent to a target component, only the event listeners registered for the target component will be called. It is the application's job to forward an event to another component if necessary.

For example, you might have a menu item and a button to trigger the same action, say, opening a dialog, and then it is more convenient to have a single listener to open the dialog, and register the listener to the main window rather than register to both the menu item and button.

Event Forwarding in Java

Forwarding an event is straightforward: just post or send the event again. However, there is a better way: composer. The composer can be the central place to handle the events. For example, you could invoke openDialog in the event handler for the menu item and button as shown below:

public class FooComposer extends GenericForwardComposer {
   public void onClick$menuitem() {
     openDialog();
   }
   public void onClick$button() {
     openDialog();
   }
   private void openDialog() {
     //whatever you want
   }
}

Event Forwarding in ZUML

Event forwarding can be done with the forward attribute in ZUML. For example,

<window>
	<button label="Save" forward="onSave"/>
	<button label="Cancel" forward="onCancel"/>
</window>

Then, window will receive the onSave event when the Save button is clicked.

With this approach we could introduce an abstract layer between the event and the component. For example, window needs only to handle the onSave event without knowing which component causes it. Therefore, you could introduce another UI to trigger onSave without modifying the event listener. For example,

	<menuitem label="Save" forward="onSave"/>

Of course, you can use the composer and ZUML's forward together to have more maintainable code.

public class BetterComposer
extends org.zkoss.zk.ui.util.GenericForwardComposer {
    public void onSave(ForwardEvent event) { //signature if you care about event
        ...
    }
    public void onCancel() { //signature if you don't care the event
        ...

Notice that, as shown above, the event being forwarded is wrapped as an instance of ForwardEvent. To retrieve the original event, you could invoke ForwardEvent.getOrigin()

Using component Path

You can also use component Path within your ZUML pages to specify target component to which you would like to forward specific event. This is especially useful if you want to forward events across different IdSpace such as forwarding event from a component in an included ZUML page to the main page component. For example

<?page id="mainPage" ?>
<window id="mainWindow" apply="BetterComposer">
...
    <include src="incDetails.zul" />
...
</window>

Now in your included page use Path while forwarding event to mainWindow Window component

   <button forward="//mainPage/mainWindow.onSave" /> <!-- default forward event is onClick -->

You could specify any application-specific data in the forward attribute 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 at once, you can specify them in the forward attribute by separating them with the comma (,). For example,

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

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

Version History

Version	Date	Content