Module org.apache.wicket.core

Package org.apache.wicket.event

Enum Class Broadcast

java.lang.Object

java.lang.Enum<Broadcast>

org.apache.wicket.event.Broadcast

All Implemented Interfaces:

Serializable, Comparable<Broadcast>, Constable

public enum Broadcast
extends Enum<Broadcast>

Defines the event broadcast type.

Author:

igor

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BREADTH	Breadth first traversal.
BUBBLE	A bubble-up traversal.
DEPTH	Depth first traversal.
EXACT	Only the specified sink receives the event

Method Summary

Modifier and Type	Method	Description
static Broadcast	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Broadcast[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BREADTH

public static final Broadcast BREADTH

Breadth first traversal. Supported sinks in order of traversal:

1. Application
2. Session
3. RequestCycle
4. Page
5. Components

Components receive the event with a preorder breadth-first traversal, eg: Apply recursively:

1. The component receives the event
2. The component's children receive the event

Any sink along the path can be specified and traversal will start with the specified sink as root, eg:

• If a component inside the page is specified then only the component and all its children will receive the event
• If Session is specified then the session, the request cycle, the page and all its components will receive the event

DEPTH

public static final Broadcast DEPTH

Depth first traversal. Supported sinks in order of traversal:

1. Components
2. Page
3. RequestCycle
4. Session
5. Application

Components receive the event with a postorder depth-first traversal, eg: Apply recursively:

1. The component's children receive the event
2. The component receives the event

Any sink along the path can be specified and traversal will start with the specified sink as root, eg:

• If a component inside the page is specified then only the component and all its children will receive the event
• If Session is specified then the session, the request cycle, the page and all its components will receive the event

BUBBLE

public static final Broadcast BUBBLE

A bubble-up traversal. In a bubble-up traversal only the sink and its parents are notified. Supported sinks in order of traversal are:

1. Components
2. Page
3. RequestCycle
4. Session
5. Application

Any sink along the path can be specified and traversal will start at the specified sink and work its way up to the Application, eg:

• If a component inside the page is specified then only the component, its parents, the request cycle, the session, and the application will be notified.
• If Session is specified then the session, the application will be notified

EXACT

public static final Broadcast EXACT

Only the specified sink receives the event

Method Details

values

public static Broadcast[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Broadcast valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null