Module org.apache.wicket.core

Package org.apache.wicket.ajax

Class AjaxChannel

java.lang.Object

org.apache.wicket.ajax.AjaxChannel

All Implemented Interfaces:

Serializable, IClusterable

public class AjaxChannel
extends Object
implements IClusterable

A Channel used to define how Ajax requests are processed at the client side. Channels are either:

• queueing - Ajax requests are kept in a Queue at the client side and processed one at a time. Default.
• dropping - only the last Ajax request is processed, all previously scheduled requests are discarded
• active - discards any Ajax requests if there is a running Ajax request on the same channel

Author:

Martin Dilger

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AjaxChannel.Type	The type of an AjaxChannel

Field Summary

Fields

Modifier and Type	Field	Description
static final AjaxChannel	DEFAULT	The default channel for all Ajax calls
static final String	DEFAULT_NAME	The name of the default channel
static final AjaxChannel.Type	DEFAULT_TYPE	The type of the default channel

Constructor Summary

Constructors

Constructor	Description
AjaxChannel(String name)	Construct.
AjaxChannel(String name, AjaxChannel.Type type)	Construct.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getName()
AjaxChannel.Type	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

The name of the default channel

See Also:

• Constant Field Values

DEFAULT_TYPE

public static final AjaxChannel.Type DEFAULT_TYPE

The type of the default channel

DEFAULT

public static final AjaxChannel DEFAULT

The default channel for all Ajax calls

Constructor Details

AjaxChannel

public AjaxChannel(String name)

Construct.

Parameters:

name - the name of the channel

AjaxChannel

public AjaxChannel(String name,
 AjaxChannel.Type type)

Construct.

Parameters:

name - the name of the channel

type - the behavior type of this channel

Method Details

getName

public String getName()

Returns:

the name

getType

public AjaxChannel.Type getType()

Returns:

the type of this channel

See Also:

• AjaxChannel.Type

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object