001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.html.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.html.*;
021
022/**
023 * Used in conjunction with the {@link HtmlSerializer} class to define hyperlinks.
024 *
025 * <p>
026 * This annotation is applied to classes.
027 *
028 * <p>
029 * Annotation that can be used to specify that a class has a URL associated with it.
030 *
031 * <p>
032 * When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get
033 * rendered as a hyperlink like so...
034 * <p class='code'>
035 *    <xt>&lt;a</xt> <xa>href</xa>=<xs>'hrefProperty'</xs><xt>&gt;</xt>nameProperty<xt>&lt;/a&gt;</xt>
036 * </p>
037 */
038@Documented
039@Target(TYPE)
040@Retention(RUNTIME)
041@Inherited
042public @interface HtmlLink {
043
044   /**
045    * The bean property whose value becomes the name in the hyperlink.
046    */
047   String nameProperty() default "name";
048
049   /**
050    * Dynamically apply this annotation to the specified classes.
051    *
052    * <p>
053    * Used in conjunction with the {@link HtmlConfig#applyHtmlLink()}.
054    * It is ignored when the annotation is applied directly to classes.
055    *
056    * <h5 class='section'>Valid patterns:</h5>
057    * <ul class='spaced-list'>
058    *    <li>Classes:
059    *       <ul>
060    *          <li>Fully qualified: <js>"com.foo.MyClass"</js>
061    *          <li>Fully qualified inner class: <js>"com.foo.MyClass$Inner1$Inner2"</js>
062    *          <li>Simple: <js>"MyClass"</js>
063    *          <li>Simple inner: <js>"MyClass$Inner1$Inner2"</js> or <js>"Inner1$Inner2"</js> or <js>"Inner2"</js>
064    *       </ul>
065    *    <li>A comma-delimited list of anything on this list.
066    * </ul>
067    *
068    * <ul class='seealso'>
069    *    <li class='link'>{@doc juneau-marshall.DynamicallyAppliedAnnotations}
070    * </ul>
071    */
072   String on() default "";
073
074   /**
075    * The bean property whose value becomes the url in the hyperlink.
076    */
077   String uriProperty() default "uri";
078}