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. The name must be full qualified, or relative.
46     * If using a complete path from root, you'll need to add the contextPath from the web application.
47     * This can be done with the EL #{request.contextPath}.
48     * @param file A JavaScript file.
49     */
50    @TagAttribute()
51    @UIComponentTagAttribute()
52    void setFile(String file);
53  
54  }