View Javadoc

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: bommel $)
30   * @version $Revision: 1187700 $ $Date: 2011-10-22 12:19:37 +0000 (Sat, 22 Oct 2011) $
31   */
32  public abstract class FacesEvent extends EventObject
33  {
34      private PhaseId _phaseId;
35  
36      public FacesEvent(UIComponent uiComponent)
37      {
38          super(uiComponent);
39          if (uiComponent == null)
40          {
41              throw new IllegalArgumentException("uiComponent");
42          }
43  
44          _phaseId = PhaseId.ANY_PHASE;
45      }
46  
47      public abstract boolean isAppropriateListener(FacesListener faceslistener);
48  
49      public abstract void processListener(FacesListener faceslistener);
50  
51      public UIComponent getComponent()
52      {
53          return (UIComponent) getSource();
54      }
55  
56      public void queue()
57      {
58          ((UIComponent) getSource()).queueEvent(this);
59      }
60  
61      public PhaseId getPhaseId()
62      {
63          return _phaseId;
64      }
65  
66      public void setPhaseId(PhaseId phaseId)
67      {
68          _phaseId = phaseId;
69      }
70  }