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