001    // Copyright 2005 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    
015    package org.apache.tapestry.annotations;
016    
017    import java.lang.annotation.Documented;
018    import java.lang.annotation.ElementType;
019    import java.lang.annotation.Retention;
020    import java.lang.annotation.RetentionPolicy;
021    import java.lang.annotation.Target;
022    
023    /**
024     * Annotation used within a page or component class to define a contained component (which will
025     * typically match up against a component reference in the template). This annotation is attached to
026     * an accessor method.
027     * 
028     * @author Howard Lewis Ship
029     * @since 4.0
030     */
031    @Target(
032    { ElementType.METHOD })
033    @Retention(RetentionPolicy.RUNTIME)
034    @Documented
035    public @interface Component {
036    
037        /**
038         * The component's id. Defaults to the property name if left unspecified.
039         */
040    
041        String id() default "";
042    
043        /**
044         * The component type. Defaults to the return type class name if left unspecified.
045         */
046    
047        String type() default "";
048        
049        /**
050         * The name of a previously defined component. 
051         * The type and bindings of that component will be copied to this component. 
052         * Either type or copy-of must be specified. 
053         */
054    
055        String copyOf() default "";    
056    
057        /**
058         * If true, then the component inherits informal parameters from its container.
059         */
060    
061        boolean inheritInformalParameters() default false;
062    
063        /**
064         * Bindings for the component. Each binding string is of the format
065         * <code><em>name</em>=<em>binding reference</em></code>, where the binding reference is
066         * the same kind of string (possibly with a prefix such as "ognl:" or "message:" as would appear
067         * in a specification.
068         * 
069         * @Binding annotations.
070         */
071    
072        String[] bindings() default {};
073    
074        /**
075         * Inherited bindings bind a parameter of the component to a parameter
076         * of the container. Each binding string is of the format
077         * <code><em>parameter-name</em>=<em>container-parameter-name</em></code>, where the former is
078         * the name of the component parameter and the latter is the name of the container parameter to bind
079         * the parameter to.
080         * In case both names are the same, it's possible to just use <code><em>parameter-name</em></code>.
081         */
082    
083        String[] inheritedBindings() default {};
084    }