org.apache.wicket.event
Enum Broadcast
java.lang.Object
java.lang.Enum<Broadcast>
org.apache.wicket.event.Broadcast
- All Implemented Interfaces:
- Serializable, Comparable<Broadcast>
public enum Broadcast
- extends Enum<Broadcast>
Defines the event broadcast type.
- Author:
- igor
Enum Constant Summary |
BREADTH
Breadth first traversal. |
BUBBLE
A bubble-up traversal. |
DEPTH
Depth first traversal. |
EXACT
Only the specified sink receives the event |
Method Summary |
static Broadcast |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Broadcast[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared. |
BREADTH
public static final Broadcast BREADTH
- Breadth first traversal. Supported sinks in order of traversal:
Application
Session
RequestCycle
Page
Component
s
Components receive the event with a preorder breadth-first traversal, eg: Apply recursively:
- The component receives the event
- 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:
Component
s
Page
RequestCycle
Session
Application
Components receive the event with a postorder depth-first traversal, eg: Apply recursively:
- The component's children receive the event
- 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:
Component
s
Page
RequestCycle
Session
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
values
public static Broadcast[] values()
- Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
for (Broadcast c : Broadcast.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static Broadcast valueOf(String name)
- Returns the enum constant of this type with the specified name.
The string must match exactly an identifier used to declare an
enum constant in this type. (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 type has no constant
with the specified name
NullPointerException
- if the argument is null
Copyright © 2006–2016 Apache Software Foundation. All rights reserved.