001// Copyright 2006, 2009 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// 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
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.annotations;
016
017import java.lang.annotation.Documented;
018import static java.lang.annotation.ElementType.FIELD;
019import java.lang.annotation.Retention;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021import java.lang.annotation.Target;
022
023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
024import org.apache.tapestry5.ioc.annotations.UseWith;
025
026/**
027 * Allows a a page (really, the root component of the page) to be injected into another component as a read-only field.
028 */
029@Target(FIELD)
030@Documented
031@Retention(RUNTIME)
032@UseWith({COMPONENT,MIXIN,PAGE})
033public @interface InjectPage
034{
035    /**
036     * The name of the page to inject, which is used when the field type is not sufficient to identify the page (for
037     * example, when the field type is an interface implemented by the page). A non-blank value here overrides the
038     * lookup by class name (from the field type).
039     */
040    String value() default "";
041}