All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.component.behavior.Behavior Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.faces.component.behavior;

import javax.faces.component.UIComponent;
import javax.faces.event.BehaviorEvent;

/**
 * 

The Behavior interface is * the root API of the component behavior model. Behaviors are objects that * are attached to {@link UIComponent}s in order to enhance components with * functionality not explicitly defined by the component implementation itself. * The component behavior API is intended to support different types of * behavior contracts, and possibly different types of interactions between * behaviors and components. The first such contract is the * {@link ClientBehavior}, which defines a mechanism by which script-producing * behaviors attach scripts to components for execution on the client. In the * future other types of behavior contracts may be added.

* *

Like other attached objects (converters, validators) Behavior instances * are created via the {@link javax.faces.application.Application} object. See * {@link javax.faces.application.Application#createBehavior} for more details.

* * @since 2.0 */ public interface Behavior { /** *

Broadcast the specified * {@link BehaviorEvent} to all registered * event listeners who have expressed an interest in events of this * type. Listeners are called in the order in which they were * added.

* * @param event The {@link BehaviorEvent} to be broadcast * * @throws javax.faces.event.AbortProcessingException Signal the JavaServer Faces * implementation that no further processing on the current event * should be performed * @throws IllegalArgumentException if the implementation class * of this {@link BehaviorEvent} is not supported by this component * @throws NullPointerException if event is * null * * @since 2.0 */ public void broadcast(BehaviorEvent event); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy