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   * <br>
32   * Some features are 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      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIScript",
38      componentFamily = "org.apache.myfaces.tobago.Script",
39      faceletHandler = "org.apache.myfaces.tobago.facelets.ScriptHandler",
40      rendererType = RendererTypes.SCRIPT,
41      allowedChildComponenents = "NONE")
42  public interface ScriptTagDeclaration extends HasIdBindingAndRendered {
43  
44    /**
45     * File name to include into the rendered page.
46     * @param file A JavaScript file.
47     */
48    @TagAttribute()
49    @UIComponentTagAttribute()
50    void setFile(String file);
51  
52    /**
53     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
54     * <code>Tobago.registerListener(myFunction, Tobago.Phase.DOCUMENT_READY);</code> or
55     * <code>Tobago.registerListener(myFunction, Tobago.Phase.WINDOW_LOAD);</code>
56     */
57    @Deprecated
58    @TagAttribute()
59    @UIComponentTagAttribute()
60    void setOnload(String onload);
61  
62    /**
63     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
64     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_UNLOAD);</code>
65     */
66    @Deprecated
67    @TagAttribute()
68    @UIComponentTagAttribute()
69    void setOnunload(String onunload);
70  
71    /**
72     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
73     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_EXIT);</code>
74     */
75    @Deprecated
76    @TagAttribute()
77    @UIComponentTagAttribute()
78    void setOnexit(String onexit);
79  
80    /**
81     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute and use
82     * <code>Tobago.registerListener(myFunction, Tobago.Phase.BEFORE_SUBMIT);</code>
83     */
84    @Deprecated
85    @TagAttribute()
86    @UIComponentTagAttribute()
87    void setOnsubmit(String onsubmit);
88  
89    /**
90     * @deprecated Since 2.0.0. Please include a custom script file via the file attribute.
91     */
92    @Deprecated
93    @TagAttribute(bodyContent = true)
94    @UIComponentTagAttribute()
95    void setScript(String script);
96  
97  }