org.apache.wicket.event.Broadcast Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.event;

import org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.Page;
import org.apache.wicket.Session;
import org.apache.wicket.request.cycle.RequestCycle;

/**
 * Defines the event broadcast type.
 * 
 * @author igor
 */
public enum Broadcast {
	/**
	 * Breadth first traversal. Supported sinks in order of traversal:
	 * 
	 * 
	 * {@link Application}
	 * {@link Session}
	 * {@link RequestCycle}
	 * {@link Page}
	 * {@link 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
	 * 
	 */
	BREADTH,
	/**
	 * Depth first traversal. Supported sinks in order of traversal:
	 * 
	 * 
	 * {@link Component}s
	 * {@link Page}
	 * {@link RequestCycle}
	 * {@link Session}
	 * {@link 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
	 * 
	 * 
	 */
	DEPTH,
	/**
	 * A bubble-up traversal. In a bubble-up traversal only the sink and its parents are notified.
	 * 
	 * Supported sinks in order of traversal are:
	 * 
	 * {@link Component}s
	 * {@link Page}
	 * {@link RequestCycle}
	 * {@link Session}
	 * {@link Application}
	 * 
	 * 
	 * Any sink along the path can be specified and traversal will start at the specified sink and
	 * work its way up to the {@link 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
	 * 
	 */
	BUBBLE,
	/**
	 * Only the specified sink receives the event
	 */
	EXACT
}