Home » Mojarra-2.0.1 » javax » faces » component » [javadoc | source]

    1   /*
    2    * $Id: ActionSource2.java,v 1.4 2007/04/27 22:00:03 ofung Exp $
    3    */
    4   
    5   /*
    6    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    7    * 
    8    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    9    * 
   10    * The contents of this file are subject to the terms of either the GNU
   11    * General Public License Version 2 only ("GPL") or the Common Development
   12    * and Distribution License("CDDL") (collectively, the "License").  You
   13    * may not use this file except in compliance with the License. You can obtain
   14    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   15    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   16    * language governing permissions and limitations under the License.
   17    * 
   18    * When distributing the software, include this License Header Notice in each
   19    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   20    * Sun designates this particular file as subject to the "Classpath" exception
   21    * as provided by Sun in the GPL Version 2 section of the License file that
   22    * accompanied this code.  If applicable, add the following below the License
   23    * Header, with the fields enclosed by brackets [] replaced by your own
   24    * identifying information: "Portions Copyrighted [year]
   25    * [name of copyright owner]"
   26    * 
   27    * Contributor(s):
   28    * 
   29    * If you wish your version of this file to be governed by only the CDDL or
   30    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   31    * elects to include this software in this distribution under the [CDDL or GPL
   32    * Version 2] license."  If you don't indicate a single choice of license, a
   33    * recipient has the option to distribute your version of this file under
   34    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   35    * its licensees as provided above.  However, if you add GPL Version 2 code
   36    * and therefore, elected the GPL Version 2 license, then the option applies
   37    * only if the new code is made subject to such option by the copyright
   38    * holder.
   39    */
   40   
   41   package javax.faces.component;
   42   
   43   import javax.el.MethodExpression;
   44   import javax.faces.event.ActionListener;
   45   
   46   
   47   
   48   /**
   49    * <p><strong>ActionSource2</strong> extends {@link ActionSource} and
   50    * provides a JavaBeans property analogous to the "<code>action</code>"
   51    * property on <code>ActionSource</code>.  The difference is the type of
   52    * this property is a {@link MethodExpression} rather than a
   53    * <code>MethodBinding</code>.  This allows the
   54    * <code>ActionSource</code> concept to leverage the new Unified EL
   55    * API.</p>
   56    *
   57    * @since 1.2
   58    */
   59   
   60   public interface ActionSource2 extends ActionSource {
   61   
   62   
   63       // -------------------------------------------------------------- Properties
   64   
   65       /**
   66        * <p>Return the {@link MethodExpression} pointing at the application
   67        * action to be invoked, if this {@link UIComponent} is activated by
   68        * the user, during the <em>Apply Request Values</em> or <em>Invoke
   69        * Application</em> phase of the request processing lifecycle,
   70        * depending on the value of the <code>immediate</code>
   71        * property.</p>
   72        *
   73        * <p>Note that it's possible that the returned
   74        * <code>MethodExpression</code> is just a wrapper around a
   75        * <code>MethodBinding</code> instance whith was set by a call to
   76        * {@link ActionSource#setAction}.  This makes it possible for the
   77        * default {@link ActionListener} to continue to work properly with
   78        * older components.</p>
   79        */
   80       public MethodExpression getActionExpression();
   81   
   82       /**
   83        * <p>Set the {@link MethodExpression} pointing at the appication
   84        * action to be invoked, if this {@link UIComponent} is activated by
   85        * the user, during the <em>Apply Request Values</em> or <em>Invoke
   86        * Application</em> phase of the request processing lifecycle,
   87        * depending on the value of the <code>immediate</code>
   88        * property.</p>
   89        *
   90        * <p>Any method referenced by such an expression must be public, with
   91        * a return type of <code>String</code>, and accept no parameters.</p>
   92        *
   93        * @param action The new method expression
   94        */
   95       public void setActionExpression(MethodExpression action);
   96   
   97       
   98   }

Home » Mojarra-2.0.1 » javax » faces » component » [javadoc | source]