    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005//     http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5.annotations;
    014
    015import org.apache.tapestry5.ioc.annotations.UseWith;
    016
    017import java.lang.annotation.Documented;
    018import java.lang.annotation.ElementType;
    019import java.lang.annotation.Retention;
    020import java.lang.annotation.Target;
    021
    022import static java.lang.annotation.RetentionPolicy.RUNTIME;
    023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
    024
    025/**
    026 * Marks methods to be invoked when the component rendering state machine hits the point in the component's template
    027 * where the body element occurs. Such methods may optionally take a {@link org.apache.tapestry5.MarkupWriter}
    028 * parameter, and may return void or boolean.
    029 *
    030 * Returning true (or void) will queue up the component's body for rendering.
    031 *
    032 * Returning false will skip the component's body, but continue rendering the template. The {@link
    033 * org.apache.tapestry5.annotations.AfterRenderBody} phase will still execute after the template finishes rendering.
    034 *
    035 * This phase is skipped for components which do not have a body.
    036 */
    037@Target(ElementType.METHOD)
    038@Retention(RUNTIME)
    039@Documented
    040@UseWith({COMPONENT,MIXIN,PAGE})
    041public @interface BeforeRenderBody
    042{
    043
    044}