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 jakarta.faces.lifecycle;
20  
21  import java.util.Map;
22  import jakarta.faces.context.FacesContext;
23  
24  /**
25   * @since 2.2
26   */
27  public abstract class ClientWindow
28  {
29      
30      public static final String CLIENT_WINDOW_MODE_PARAM_NAME = 
31              "jakarta.faces.CLIENT_WINDOW_MODE";
32      
33      private static final String CLIENT_WINDOW_RENDER_MODE_DISABLED = 
34              "org.apache.myfaces.CLIENT_WINDOW_URL_QUERY_PARAMETER_DISABLED";
35      
36      public abstract void decode(FacesContext context);
37      
38      public abstract String getId();
39      
40      public abstract Map<String,String> getQueryURLParameters(FacesContext context);
41      
42      public boolean isClientWindowRenderModeEnabled(FacesContext context)
43      {
44          // By default is enabled, so it is easier to check the opposite.
45          return !Boolean.TRUE.equals(
46                  context.getAttributes().get(CLIENT_WINDOW_RENDER_MODE_DISABLED));
47      }
48      
49      public void disableClientWindowRenderMode(FacesContext context)
50      {
51          context.getAttributes().put(CLIENT_WINDOW_RENDER_MODE_DISABLED, Boolean.TRUE);
52      }
53      
54      public void enableClientWindowRenderMode(FacesContext context)
55      {
56          context.getAttributes().put(CLIENT_WINDOW_RENDER_MODE_DISABLED, Boolean.FALSE);
57      }
58  }