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 015package org.apache.tapestry.annotations; 016 017import java.lang.annotation.Documented; 018import java.lang.annotation.ElementType; 019import java.lang.annotation.Retention; 020import java.lang.annotation.RetentionPolicy; 021import 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 035public @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. 045 */ 046 047 String type(); 048 049 /** 050 * If true, then the component inherits informal parameters from its container. 051 */ 052 053 boolean inheritInformalParameters() default false; 054 055 /** 056 * Bindings for the component. Each binding string is of the format 057 * <code><em>name</em>=<em>binding refernce</em></code>, where the binding reference is 058 * the same kind of string (possibly with a prefix such as "ognl:" or "message:" as would appear 059 * in a specification. 060 * 061 * @Binding annotations. 062 */ 063 064 String[] bindings() default {}; 065}