1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
* 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;
/**
* <p><strong>ActionSource</strong> 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.</p>
*/
public interface ActionSource {
// -------------------------------------------------------------- Properties
/**
* <p>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 <code>MethodBinding</code> from it and
* return it. Otherwise, wrap the returned {@link
* javax.el.MethodExpression} in a <code>MethodBinding</code>
* implementation, and return it.</p>
*
* <p>If the implementing class does not implement
* <code>ActionSource2</code>, return the {@link
* MethodBinding}pointing at the application action to be invoked,
* if this {@link UIComponent} is activated by the user, during the
* <em>Apply Request Values</em> or <em>Invoke Application</em>
* phase of the request processing lifecycle, depending on the value
* of the <code>immediate</code> property.</p>
*
* @deprecated This has been replaced by {@link
* ActionSource2#getActionExpression}.
*/
public MethodBinding getAction();
/**
* <p>If the implementing class also implements {@link
* ActionSource2}, the implementation of this method must wrap the
* argument <code>action</code> in a class that implements {@link
* javax.el.MethodExpression} and call through to {@link
* ActionSource2#setActionExpression}, passing the wrapped
* <code>action</code>.</p>
*
* <p>If the implementing class does not implement
* <code>ActionSource2</code>, set the {@link MethodBinding}
* pointing at the appication action to be invoked, if this {@link
* UIComponent} is activated by the user, during the <em>Apply
* Request Values</em> or <em>Invoke Application</em> phase of the
* request processing lifecycle, depending on the value of the
* <code>immediate</code> property.</p>
*
* <p>Any method referenced by such an expression must be public, with
* a return type of <code>String</code>, and accept no parameters.</p>
*
* @param action The new MethodBinding expression
*
* @deprecated This has been replaced by {@link
* ActionSource2#setActionExpression(javax.el.MethodExpression)}.
*/
public void setAction(MethodBinding action);
/**
* <p>If {@link #setActionListener} was not previously called
* for this instance, this method must return <code>null</code>. If
* it was called, this method must return the exact
* <code>MethodBinding</code> instance that was passed to {@link
* #setActionListener}.</p>
*
* <p> The method to be invoked, if this {@link UIComponent} is
* activated by the user, will be called during the <em>Apply
* Request Values</em> or <em>Invoke Application</em> phase of the
* request processing lifecycle, depending upon the value of the
* <code>immediate</code> property.</p>
*
* @deprecated Use {@link #getActionListeners} instead.
*/
public MethodBinding getActionListener();
/**
* <p>Wrap the argument <code>actionListener</code> 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
* <code>setActionListener</code>.</p>
*
* <p>Any method referenced by such an expression must be public, with
* a return type of <code>void</code>, and accept a single parameter of
* type <code>ActionEvent</code>.</p>
*
* @param actionListener The new method binding expression
*
* @deprecated This has been replaced by {@link
* #addActionListener(javax.faces.event.ActionListener)}.
*/
public void setActionListener(MethodBinding actionListener);
/**
* <p>Return a flag indicating that the default {@link ActionListener}
* provided by the JavaServer Faces implementation should be executed
* immediately (that is, during <em>Apply Request Values</em> phase
* of the request processing lifecycle), rather than waiting until the
* <em>Invoke Application</em> phase. The default value for this
* property must be <code>false</code>.</p>
*/
public boolean isImmediate();
/**
* <p>Set the "immediate execution" flag for this {@link UIComponent}.</p>
*
* @param immediate The new immediate execution flag
*/
public void setImmediate(boolean immediate);
// -------------------------------------------------- Event Listener Methods
/**
* <p>Add a new {@link ActionListener} to the set of listeners interested
* in being notified when {@link ActionEvent}s occur.</p>
*
* @param listener The {@link ActionListener} to be added
*
* @throws NullPointerException if <code>listener</code>
* is <code>null</code>
*/
public void addActionListener(ActionListener listener);
/**
* <p>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.</p>
*/
public abstract ActionListener[] getActionListeners();
/**
* <p>Remove an existing {@link ActionListener} (if any) from the set of
* listeners interested in being notified when {@link ActionEvent}s
* occur.</p>
*
* @param listener The {@link ActionListener} to be removed
*
* @throws NullPointerException if <code>listener</code>
* is <code>null</code>
*/
public void removeActionListener(ActionListener listener);
}
|
