001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *   http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.myfaces.tobago.taglib.decl;
021    
022    import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
023    import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
024    
025    public interface HasResource {
026      /**
027       * Link to an internal resource.
028       * Resources will be processed by the resource management.
029       * E. g. define help.html and it will be served help_es.html or help_de.html if available.
030       * For JSF-Pages you have to set the jsfResource attribute.
031       *
032       * @param resource The internal resource.
033       * @see #setJsfResource(String)
034       */
035      @TagAttribute
036      @UIComponentTagAttribute()
037      void setResource(String resource);
038    
039      /**
040       * Flag indicating that the resource referenced by the resource attribute is a jsf resource.
041       * That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or
042       * /faces/*). Default is false.
043       *
044       * @param jsfResource Is the Resource a JSF page or not?
045       */
046      @TagAttribute
047      @UIComponentTagAttribute(type = "java.lang.Boolean")
048      void setJsfResource(String jsfResource);
049    
050    }