javax.faces.component
Class AjaxBehavior

java.lang.Object
  extended by javax.faces.component.AjaxBehavior
All Implemented Interfaces:
Serializable

public class AjaxBehavior
extends Object
implements Serializable

An instance of this class is added to an EditableValueHolder or ActionSource component's attribute Map to cause the rendering of the JavaScript jsf.ajax.request function call when the component is rendered.

Since:
2.0
See Also:
Serialized Form

Field Summary
static String AJAX_ACTION
          

The identifier for Ajax action events.

static String AJAX_BEHAVIOR
          

The key that when added to a component's attributes Map will cause the rendering of JavaScript to perform an Ajax request.

static String AJAX_VALUE_CHANGE
          

The identifier for Ajax value change events.

static String AJAX_VALUE_CHANGE_ACTION
          

The identifier for both Ajax value change and action events.

 
Constructor Summary
AjaxBehavior(String events, String onevent, String onerror, Collection<String> execute, Collection<String> render, Boolean disabled)
           
 
Method Summary
 String getEvents()
          

Return the Faces event associated with this instance.

 Collection<String> getExecute()
          

Return a Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

 String getOnError()
          

Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

 String getOnEvent()
          

Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.

 Collection<String> getRender()
          

Return a Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

 Boolean isDisabled()
          

Return the disabled status of this component.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AJAX_BEHAVIOR

public static final String AJAX_BEHAVIOR

The key that when added to a component's attributes Map will cause the rendering of JavaScript to perform an Ajax request.

Since:
2.0
See Also:
Constant Field Values

AJAX_VALUE_CHANGE

public static final String AJAX_VALUE_CHANGE

The identifier for Ajax value change events.

Since:
2.0
See Also:
Constant Field Values

AJAX_ACTION

public static final String AJAX_ACTION

The identifier for Ajax action events.

Since:
2.0
See Also:
Constant Field Values

AJAX_VALUE_CHANGE_ACTION

public static final String AJAX_VALUE_CHANGE_ACTION

The identifier for both Ajax value change and action events.

Since:
2.0
See Also:
Constant Field Values
Constructor Detail

AjaxBehavior

public AjaxBehavior(String events,
                    String onevent,
                    String onerror,
                    Collection<String> execute,
                    Collection<String> render,
                    Boolean disabled)
Method Detail

getEvents

public String getEvents()

Return the Faces event associated with this instance.

Since:
2.0

getOnError

public String getOnError()

Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

Since:
2.0

getOnEvent

public String getOnEvent()

Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.

Since:
2.0

getExecute

public Collection<String> getExecute()

Return a Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

Since:
2.0

getRender

public Collection<String> getRender()

Return a Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

Since:
2.0

isDisabled

public Boolean isDisabled()

Return the disabled status of this component.

Since:
2.0


Copyright © 2002-2008 Sun Microsystems, Inc. All Rights Reserved.