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 java.lang.annotation.ElementType;
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 * Associated with components that have a template, this phase is invoked to allow the component to decorate its
028 * template with additional markup. Returning true will cause the component's template to render (possibly including
029 * additional components, or this component's body), and eventually reach the {@link AfterRenderTemplate} phase. Return
030 * false to skip the template and body, and jump directly to the {@link AfterRenderTemplate} phase.
031 */
032@Target(ElementType.METHOD)
033@Retention(RUNTIME)
034@Documented
035@UseWith({COMPONENT,MIXIN,PAGE})
036public @interface BeforeRenderTemplate
037{
038
039}