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  package javax.faces.context;
20  
21  import java.util.Collection;
22  
23  import javax.faces.event.PhaseId;
24  
25  /**
26   * @since 2.0
27   */
28  public abstract class PartialViewContext
29  {
30      public static final String ALL_PARTIAL_PHASE_CLIENT_IDS = "@all";
31      //public static final String NO_PARTIAL_PHASE_CLIENT_IDS = "@none";
32      public static final String PARTIAL_EXECUTE_PARAM_NAME = "javax.faces.partial.execute";
33      public static final String PARTIAL_RENDER_PARAM_NAME = "javax.faces.partial.render";
34      
35      /**
36       * @since 2.2
37       */
38      public static final java.lang.String RESET_VALUES_PARAM_NAME = "javax.faces.partial.resetValues";
39      
40      /**
41       * @since 2.3
42       */
43      public static final String PARTIAL_EVENT_PARAM_NAME =
44            "javax.faces.partial.event";
45      
46      public abstract Collection<String> getExecuteIds();
47      
48      public abstract PartialResponseWriter getPartialResponseWriter();
49      
50      public abstract Collection<String> getRenderIds();
51      
52      public abstract boolean isAjaxRequest();
53      
54      public abstract boolean isExecuteAll();
55      
56      public abstract boolean isPartialRequest();
57      
58      public abstract boolean isRenderAll();
59      
60      public abstract void processPartial(PhaseId phaseId);
61      
62      public abstract void release();
63      
64      public abstract void setPartialRequest(boolean isPartialRequest);
65      
66      public abstract void setRenderAll(boolean renderAll);
67  
68      /**
69      * @since 2.3
70      */
71      public abstract java.util.List<java.lang.String> getEvalScripts();
72      
73      /**
74       * @since 2.2
75       * @return 
76       */
77      public boolean isResetValues()
78      {
79          return false;
80      }
81  
82  }