org.zkoss.zk.au.out
Class AuInvoke

java.lang.Object
  org.zkoss.zk.au.AuResponse
      org.zkoss.zk.au.out.AuInvoke

public class AuInvoke
extends AuResponse

A response to ask the client to execute the specified client function. Unlike AuScript, it invokes the function called zkType.function, where Type is the component's type (at the client) and function is the function name specified in AuInvoke.

data[0]: the component UUID
data[1]: the client function name (i.e., JavaScript function)
data[2]: the second argument
data[3]: the third argument...

Note: the first argument is always the component itself.

Since:

3.0.0

Author:

tomyeh

Constructor Summary

AuInvoke(Component comp, java.lang.String function)
Construct AuInvoke to call a client function with one argument, the component itself.

AuInvoke(Component comp, java.lang.String function, java.lang.String arg)
Construct AuInvoke to call a client function with two arguments, the component itself and arg.

AuInvoke(Component comp, java.lang.String function, java.lang.String arg1, java.lang.String arg2)
Construct AuInvoke to call a client function with three arguments, the component itself, arg1 and arg2.

AuInvoke(Component comp, java.lang.String function, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)
Construct AuInvoke to call a client function with four arguments, the component itself, arg1, arg2 and arg3.

Method Summary

Methods inherited from class org.zkoss.zk.au.AuResponse

equals, getCommand, getData, getDepends, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuInvoke

public AuInvoke(Component comp,
                java.lang.String function)

Construct AuInvoke to call a client function with one argument, the component itself.

In other words, it invokes (assume Type is the comp's z.type)
zkType.function(comp)

Parameters:

comp - the component that this script depends on. It cannot be null.

function - the function name

AuInvoke

public AuInvoke(Component comp,
                java.lang.String function,
                java.lang.String arg)

Construct AuInvoke to call a client function with two arguments, the component itself and arg.

In other words, it invokes (assume Type is the comp's z.type)
zkType.function(comp, arg)

Parameters:

comp - the component that this script depends on. It cannot be null.

function - the function name

arg - the additional argument

AuInvoke

public AuInvoke(Component comp,
                java.lang.String function,
                java.lang.String arg1,
                java.lang.String arg2)

Construct AuInvoke to call a client function with three arguments, the component itself, arg1 and arg2.

In other words, it invokes (assume Type is the comp's z.type)
zkType.function(comp, arg1, arg2)

Parameters:

comp - the component that this script depends on. It cannot be null.

function - the function name

AuInvoke

public AuInvoke(Component comp,
                java.lang.String function,
                java.lang.String arg1,
                java.lang.String arg2,
                java.lang.String arg3)

Construct AuInvoke to call a client function with four arguments, the component itself, arg1, arg2 and arg3.

In other words, it invokes (assume Type is the comp's z.type)
zkType.function(comp, arg1, arg2, arg3)

Parameters:

comp - the component that this script depends on. It cannot be null.

function - the function name