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.declaration;
21  
22  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
23  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
24  
25  public interface HasResource {
26    /**
27     * Link to an internal resource.
28     * Resources will be processed by the resource management.
29     * E. g. define help.html and it will be served help_es.html or help_de.html if available.
30     * For JSF-Pages you have to set the jsfResource attribute.
31     *
32     * @param resource The internal resource.
33     * @see #setJsfResource(String)
34     */
35    @TagAttribute
36    @UIComponentTagAttribute()
37    void setResource(String resource);
38  
39    /**
40     * Flag indicating that the resource referenced by the resource attribute is a jsf resource.
41     * That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or
42     * /faces/*). Default is false.
43     *
44     * @param jsfResource Is the Resource a JSF page or not?
45     */
46    @TagAttribute
47    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
48    void setJsfResource(String jsfResource);
49  
50  }