net.sf.tacos.ajax
Class AjaxDirectServiceParameter

java.lang.Object
  org.apache.tapestry.engine.DirectServiceParameter
      net.sf.tacos.ajax.AjaxDirectServiceParameter

public class AjaxDirectServiceParameter
extends org.apache.tapestry.engine.DirectServiceParameter

Adds additional functionality to DirectServiceParameter in the form of being able to specify optional id's of components that should have their contents replaced on a page.

Author:

jkuhnert

Field Summary

protected boolean	processScripts Whether or not response invoked from link should process client side javascript.
protected boolean	updateDirect Whether or not to update the components directly
protected String[]	updateIds List of components to update

Constructor Summary

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds)
Creates a parameter list that will cause the entire page to re-render, with only the contents of the specified IComponents returned and updated on the client.

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds, boolean updateDirect)
Same as AjaxDirectServiceParameter(IDirect, Object[], String[]), except the additional paramter updateDirect overrides the default behaviour of having the components rendered by direct invocation, rather than having the entire page re-rendered with only the ajax output returned to the client.

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds, boolean updateDirect, boolean processScripts)
Same as others, with additional processScripts parameter controlling whether or not link invoked should process javascript on the client side on response returned.

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds, String[] updateBlocks)
Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[]) - will be removed before tacos4-final

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds, String[] updateBlocks, boolean updateDirect)
Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[], boolean) )} - will be removed before tacos4-final

AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct, Object[] parameters, String[] updateIds, String[] updateBlocks, boolean updateDirect, boolean processScripts)
Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[], boolean, boolean) )} - will be removed before tacos4-final

Method Summary

String[]	getUpdateBlocks() Deprecated. always returns null - will be removed before tacos4-final
String[]	getUpdateIds() List of component ids to update.
boolean	isProcessScripts() Whether or not response invoked from this link should evaluate embedded javascript calls.
boolean	isUpdateDirect()

Methods inherited from class org.apache.tapestry.engine.DirectServiceParameter

getDirect, getServiceParameters

Methods inherited from class java.lang.Object

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

Field Detail

updateIds

protected String[] updateIds

List of components to update

updateDirect

protected boolean updateDirect

Whether or not to update the components directly

processScripts

protected boolean processScripts

Whether or not response invoked from link should process client side javascript.

Constructor Detail

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds)

Creates a parameter list that will cause the entire page to re-render, with only the contents of the specified IComponents returned and updated on the client.

The components will be updated directly and the response will not process client side javascript.

Parameters:

direct -

parameters -

updateIds -

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds,
                                  boolean updateDirect)

Same as AjaxDirectServiceParameter(IDirect, Object[], String[]), except the additional paramter updateDirect overrides the default behaviour of having the components rendered by direct invocation, rather than having the entire page re-rendered with only the ajax output returned to the client.

The response will not process client side javascript.

Parameters:

direct -

parameters -

updateIds -

updateDirect - If false, causes the entire page to be re-rendered. The default is true, which causes only the specified components to be invoked directly.

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds,
                                  boolean updateDirect,
                                  boolean processScripts)

Same as others, with additional processScripts parameter controlling whether or not link invoked should process javascript on the client side on response returned.

Parameters:

direct -

parameters -

updateIds -

updateDirect -

processScripts -

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds,
                                  String[] updateBlocks)

Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[]) - will be removed before tacos4-final

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds,
                                  String[] updateBlocks,
                                  boolean updateDirect)

Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[], boolean) )} - will be removed before tacos4-final

AjaxDirectServiceParameter

public AjaxDirectServiceParameter(org.apache.tapestry.IDirect direct,
                                  Object[] parameters,
                                  String[] updateIds,
                                  String[] updateBlocks,
                                  boolean updateDirect,
                                  boolean processScripts)

Deprecated. Use AjaxDirectServiceParameter(org.apache.tapestry.IDirect, Object[], String[], boolean, boolean) )} - will be removed before tacos4-final

Method Detail

getUpdateIds

public String[] getUpdateIds()

List of component ids to update.

Returns:

getUpdateBlocks

public String[] getUpdateBlocks()

Deprecated. always returns null - will be removed before tacos4-final

List of html block ids to update.

Returns:

isUpdateDirect

public boolean isUpdateDirect()

Returns:

True if this request should invoke components directly, false otherwise.

isProcessScripts

public boolean isProcessScripts()

Whether or not response invoked from this link should evaluate embedded javascript calls.

Returns: