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 HasLink {
26    /**
27     * Link to an arbitrary URL, either an internal link or an external link.
28  
29     * <dl>
30     *   <dt>internal absolute link</dt>
31     *   <dd>Starts with a slash '/' character. The context path will be added.
32     *       A session id will be added, if needed.</dd>
33     *   <dt>external link</dt>
34     *   <dd>Starts with protocol followed by a colon ':' character.
35     *       The link will not be modified.</dd>
36     *   <dt>internal relative link</dt>
37     *   <dd>Any other strings. A session id will be added, if needed.</dd>
38     * </dl>
39     *
40     * @param link The external or internal link.
41     */
42    @TagAttribute
43    @UIComponentTagAttribute()
44    void setLink(String link);
45  }