    001// Copyright 2006, 2008, 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 * Used to define an <em>embedded component</em> within another component.
    028 */
    029@Target(FIELD)
    030@Documented
    031@Retention(RUNTIME)
    032@UseWith({COMPONENT,PAGE})
    033public @interface Component
    034{
    035
    036    /**
    037     * The id of the component. When left blank (the default), the component id is determined from the field name.
    038     */
    039    String id() default "";
    040
    041    /**
    042     * The component type. When this is left unspecified, then the annotated field's type is used directly as the
    043     * component type.
    044     */
    045    String type() default "";
    046
    047    /**
    048     * Parameter bindings for the component. Each value in the array is of the form "name=value". The value is a binding
    049     * expression, with a default binding prefix of "prop:".
    050     */
    051    String[] parameters() default { };
    052
    053    /**
    054     * If true, then the component will inherit all informal parameters from its parent component. The default is
    055     * false.
    056     */
    057    boolean inheritInformalParameters() default false;
    058
    059    /**
    060     * A comma-separated list of parameters of the component that should be published as parameters of the containing
    061     * component.   Binding the parameter of the outer component will bind the inner component's parameter, as with the
    062     * "inhert:" binding prefix.
    063     *
    064     * @since 5.1.0.0
    065     */
    066    String publishParameters() default "";
    067}