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