1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package javax.faces.event;
21
22 import java.util.EventObject;
23
24 import javax.faces.component.UIComponent;
25
26 /**
27 * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
28 *
29 * @author Thomas Spiegl (latest modification by $Author: skitching $)
30 * @version $Revision: 676298 $ $Date: 2008-07-13 05:31:48 -0500 (Sun, 13 Jul 2008) $
31 */
32 public abstract class FacesEvent extends EventObject
33 {
34 // FIELDS
35 private PhaseId _phaseId;
36
37 // CONSTRUCTORS
38 public FacesEvent(UIComponent uiComponent)
39 {
40 super(uiComponent);
41 if (uiComponent == null) throw new IllegalArgumentException("uiComponent");
42 _phaseId = PhaseId.ANY_PHASE;
43 }
44
45 // METHODS
46 public abstract boolean isAppropriateListener(FacesListener faceslistener);
47
48 public abstract void processListener(FacesListener faceslistener);
49
50 public UIComponent getComponent()
51 {
52 return (UIComponent)getSource();
53 }
54
55 public void queue()
56 {
57 ((UIComponent)getSource()).queueEvent(this);
58 }
59
60 public PhaseId getPhaseId()
61 {
62 return _phaseId;
63 }
64
65 public void setPhaseId(PhaseId phaseId)
66 {
67 _phaseId = phaseId;
68 }
69 }