01: // Copyright 2006 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // Unless required by applicable law or agreed to in writing, software
10: // distributed under the License is distributed on an "AS IS" BASIS,
11: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: // See the License for the specific language governing permissions and
13: // limitations under the License.
14:
15: package org.apache.tapestry.annotations;
16:
17: import static java.lang.annotation.RetentionPolicy.RUNTIME;
18:
19: import java.lang.annotation.Documented;
20: import java.lang.annotation.ElementType;
21: import java.lang.annotation.Retention;
22: import java.lang.annotation.Target;
23:
24: /**
25: * Marks methods to be invoked when the component rendering state machine hits the point in the
26: * component's template where the body element occurs. Such methods may optionally take a
27: * {@link org.apache.tapestry.MarkupWriter} parameter, and may return void or boolean.
28: * <p>
29: * Returning true (or void) will queue up the component's body for rendering.
30: * <p>
31: * Returning false will skip the component's body, but continue rendering the template. The
32: * {@link org.apache.tapestry.annotations.AfterRenderBody} phase will still execute after the
33: * template finishes rendering.
34: * <p>
35: * This phase is skipped for components which do not have a body.
36: */
37: @Target(ElementType.METHOD)
38: @Retention(RUNTIME)
39: @Documented
40: public @interface BeforeRenderBody {
41:
42: }
|