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

javax.faces.component.ActionSource Maven / Gradle / Ivy

Go to download

This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * 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;


import javax.faces.event.ActionEvent;
import javax.faces.event.ActionListener;
import javax.faces.el.MethodBinding;



/**
 * 

ActionSource is an interface that may be implemented * by any concrete {@link UIComponent} that wishes to be a source of * {@link ActionEvent}s, including the ability to invoke application * actions via the default {@link ActionListener} mechanism.

*/ public interface ActionSource { // -------------------------------------------------------------- Properties /** *

If the implementing class also implements {@link * ActionSource2}, the implementation of this method must call * through to {@link ActionSource2#getActionExpression} and examine * the result. If the result came from a previous call to {@link * #setAction}, extract the MethodBinding from it and * return it. Otherwise, wrap the returned {@link * javax.el.MethodExpression} in a MethodBinding * implementation, and return it.

* *

If the implementing class does not implement * ActionSource2, return the {@link * MethodBinding}pointing at the application action to be invoked, * if this {@link UIComponent} is activated by the user, during the * Apply Request Values or Invoke Application * phase of the request processing lifecycle, depending on the value * of the immediate property.

* * @deprecated This has been replaced by {@link * ActionSource2#getActionExpression}. */ public MethodBinding getAction(); /** *

If the implementing class also implements {@link * ActionSource2}, the implementation of this method must wrap the * argument action in a class that implements {@link * javax.el.MethodExpression} and call through to {@link * ActionSource2#setActionExpression}, passing the wrapped * action.

* *

If the implementing class does not implement * ActionSource2, set the {@link MethodBinding} * pointing at the appication action to be invoked, if this {@link * UIComponent} is activated by the user, during the Apply * Request Values or Invoke Application phase of the * request processing lifecycle, depending on the value of the * immediate property.

* *

Any method referenced by such an expression must be public, with * a return type of String, and accept no parameters.

* * @param action The new MethodBinding expression * * @deprecated This has been replaced by {@link * ActionSource2#setActionExpression(javax.el.MethodExpression)}. */ public void setAction(MethodBinding action); /** *

If {@link #setActionListener} was not previously called * for this instance, this method must return null. If * it was called, this method must return the exact * MethodBinding instance that was passed to {@link * #setActionListener}.

* *

The method to be invoked, if this {@link UIComponent} is * activated by the user, will be called during the Apply * Request Values or Invoke Application phase of the * request processing lifecycle, depending upon the value of the * immediate property.

* * @deprecated Use {@link #getActionListeners} instead. */ public MethodBinding getActionListener(); /** *

Wrap the argument actionListener in an * implementation of {@link ActionListener} * and store it in the internal data structure that backs the {@link * #getActionListeners} method, taking care to over-write any * instance that was stored by a previous call to * setActionListener.

* *

Any method referenced by such an expression must be public, with * a return type of void, and accept a single parameter of * type ActionEvent.

* * @param actionListener The new method binding expression * * @deprecated This has been replaced by {@link * #addActionListener(javax.faces.event.ActionListener)}. */ public void setActionListener(MethodBinding actionListener); /** *

Return a flag indicating that the default {@link ActionListener} * provided by the JavaServer Faces implementation should be executed * immediately (that is, during Apply Request Values phase * of the request processing lifecycle), rather than waiting until the * Invoke Application phase. The default value for this * property must be false.

*/ public boolean isImmediate(); /** *

Set the "immediate execution" flag for this {@link UIComponent}.

* * @param immediate The new immediate execution flag */ public void setImmediate(boolean immediate); // -------------------------------------------------- Event Listener Methods /** *

Add a new {@link ActionListener} to the set of listeners interested * in being notified when {@link ActionEvent}s occur.

* * @param listener The {@link ActionListener} to be added * * @throws NullPointerException if listener * is null */ public void addActionListener(ActionListener listener); /** *

Return the set of registered {@link ActionListener}s for this * {@link ActionSource} instance. If there are no registered listeners, * a zero-length array is returned.

*/ public abstract ActionListener[] getActionListeners(); /** *

Remove an existing {@link ActionListener} (if any) from the set of * listeners interested in being notified when {@link ActionEvent}s * occur.

* * @param listener The {@link ActionListener} to be removed * * @throws NullPointerException if listener * is null */ public void removeActionListener(ActionListener listener); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy