org.apache.wicket.event
Enum Broadcast

java.lang.Object
  extended by java.lang.Enum<Broadcast>
      extended by 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.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

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:


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:


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:


EXACT

public static final Broadcast EXACT
Only the specified sink receives the event

Method Detail

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–2020 Apache Software Foundation. All rights reserved.