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 * Marks methods to be invoked when the component rendering state machine hits the point in the component's template
028 * where the body element occurs. Such methods may optionally take a {@link org.apache.tapestry5.MarkupWriter}
029 * parameter, and may return void or boolean.
030 * <p/>
031 * Returning true (or void) will queue up the component's body for rendering.
032 * <p/>
033 * Returning false will skip the component's body, but continue rendering the template. The {@link
034 * org.apache.tapestry5.annotations.AfterRenderBody} phase will still execute after the template finishes rendering.
035 * <p/>
036 * This phase is skipped for components which do not have a body.
037 */
038@Target(ElementType.METHOD)
039@Retention(RUNTIME)
040@Documented
041@UseWith({COMPONENT,MIXIN,PAGE})
042public @interface BeforeRenderBody
043{
044
045}