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 org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.Tag;
23  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
24  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
26  import org.apache.myfaces.tobago.component.RendererTypes;
27  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
28  
29  /**
30   * This tag adds script files to include into the rendered page.
31   * <p/>
32   * Deprecated (because of CSP): This tag adds client side script to the rendered page.
33   */
34  @Tag(name = "script")
35  @UIComponentTag(
36      uiComponent = "org.apache.myfaces.tobago.component.UIScript",
37      uiComponentFacesClass = "javax.faces.component.UIComponentBase",
38      componentFamily = "org.apache.myfaces.tobago.Script",
39      faceletHandler = "org.apache.myfaces.tobago.facelets.ScriptHandler",
40      rendererType = RendererTypes.SCRIPT,
41      isTransparentForLayout = true,
42      allowedChildComponenents = "NONE")
43  public interface ScriptTagDeclaration extends HasIdBindingAndRendered {
44  
45    /**
46     * File name to include into the rendered page.
47     * @param file A JavaScript file.
48     */
49    @TagAttribute()
50    @UIComponentTagAttribute()
51    void setFile(String file);
52  
53    /**
54     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
55     * <code>Tobago.registerListener(myFunction, Tobago.Phase.DOCUMENT_READY);</code> or
56     * <code>Tobago.registerListener(myFunction, Tobago.Phase.WINDOW_LOAD);</code>
57     */
58    @Deprecated
59    @TagAttribute()
60    @UIComponentTagAttribute()
61    void setOnload(String onload);
62  
63    /**
64     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
65     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_UNLOAD);</code>
66     */
67    @Deprecated
68    @TagAttribute()
69    @UIComponentTagAttribute()
70    void setOnunload(String onunload);
71  
72    /**
73     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
74     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_EXIT);</code>
75     */
76    @Deprecated
77    @TagAttribute()
78    @UIComponentTagAttribute()
79    void setOnexit(String onexit);
80  
81    /**
82     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
83     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_SUBMIT);</code>
84     */
85    @Deprecated
86    @TagAttribute()
87    @UIComponentTagAttribute()
88    void setOnsubmit(String onsubmit);
89  
90    /**
91     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute.
92     */
93    @Deprecated
94    @TagAttribute(bodyContent = true)
95    @UIComponentTagAttribute()
96    void setScript(String script);
97  
98  }