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.document;
20  
21  import javax.faces.component.behavior.ClientBehaviorHolder;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
24  import org.apache.myfaces.component.EventAware;
25  import org.apache.myfaces.component.StyleAware;
26  import org.apache.myfaces.component.UniversalProperties;
27  
28  /**
29   * Document to enclose the document body. If not otherwise possible you can use
30   * state="start|end" to demarkate the document boundaries
31   * 
32   * @JSFComponent
33   *   name = "t:documentBody"
34   *   class = "org.apache.myfaces.custom.document.DocumentBody"
35   *   tagClass = "org.apache.myfaces.custom.document.DocumentBodyTag"
36   * @since 1.1.7
37   * @author Mario Ivankovits (latest modification by $Author: lu4242 $)
38   * @version $Revision: 691871 $ $Date: 2008-09-03 23:32:08 -0500 (miƩ, 03 sep 2008) $
39   */
40  abstract class AbstractDocumentBody extends AbstractDocument 
41      implements StyleAware, EventAware, UniversalProperties, ClientBehaviorHolder
42  {
43      public static final String COMPONENT_TYPE = "org.apache.myfaces.DocumentBody";
44      private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.DocumentBody";
45  
46      public AbstractDocumentBody()
47      {
48          super(DEFAULT_RENDERER_TYPE);
49      }
50      
51      /**
52       * HTML: Script to be invoked when the page is loaded
53       * 
54       */
55      @JSFProperty(clientEvent="load")
56      public abstract String getOnload();
57      
58      /**
59       * HTML: Script to be invoked when the page is unloaded
60       * 
61       */
62      @JSFProperty(clientEvent="unload")
63      public abstract String getOnunload();
64  
65      /**
66       * 
67       */
68      @JSFProperty(clientEvent="resize")
69      public abstract String getOnresize();
70  }