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