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 org.apache.myfaces.custom.autoscroll;
20  
21  import java.io.IOException;
22  
23  import javax.faces.component.UIComponent;
24  import javax.faces.component.UIViewRoot;
25  import javax.faces.view.facelets.BehaviorConfig;
26  import javax.faces.view.facelets.BehaviorHandler;
27  import javax.faces.view.facelets.FaceletContext;
28  
29  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFFaceletTag;
30  
31  /**
32   * @since 1.1.10
33   * @author Leonardo Uribe (latest modification by $Author: lu4242 $)
34   * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (miƩ, 03 sep 2008) $
35   */
36  @JSFFaceletTag(name="t:autoScroll", behaviorClass="org.apache.myfaces.custom.autoscroll.AutoscrollBehavior")
37  public class AutoscrollBehaviorTagHandler extends BehaviorHandler
38  {
39  
40      public static final String AUTOSCROLL_TAG_ON_PAGE = "oam.autoscroll.AUTOSCROLL_TAG_ON_PAGE";
41      
42      public AutoscrollBehaviorTagHandler(BehaviorConfig config)
43      {
44          super(config);
45      }
46  
47      @Override
48      public void apply(FaceletContext ctx, UIComponent parent)
49              throws IOException
50      {
51          super.apply(ctx, parent);
52          
53          UIViewRoot root = getViewRoot(ctx, parent);
54          
55          if (!root.getAttributes().containsKey(AUTOSCROLL_TAG_ON_PAGE))
56          {
57              root.getAttributes().put(AUTOSCROLL_TAG_ON_PAGE, Boolean.TRUE);
58          }
59      }
60      
61      private UIViewRoot getViewRoot(FaceletContext ctx, UIComponent parent)
62      {
63          UIComponent c = parent;
64          do
65          {
66              if (c instanceof UIViewRoot)
67              {
68                  return (UIViewRoot) c;
69              }
70              else
71              {
72                  c = c.getParent();
73              }
74          } while (c != null);
75  
76          return ctx.getFacesContext().getViewRoot();
77      }
78  }