javax.faces.component.ActionSource Maven / Gradle / Ivy
/*
* $Id: ActionSource.java,v 1.15 2007/01/29 07:56:13 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
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);
}