org.apache.tapestry5.annotations
Annotation Type BeginRender


@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
@UseWith(value={COMPONENT,MIXIN,PAGE})
public @interface BeginRender

Marker annotation for methods that should be executed at the start of rendering the component. This usually includes rendering of the component's start tag.

Such methods may optionally take a MarkupWriter parameter, and may return void or boolean. Returning true or void will allow the component to advance into the render template / render body phase. If a body is present, the BeforeRenderBody phase will execute. If a component has a template, the BeforeRenderTemplate phase will execute (and the render body will only occur if the template directs so).

Either way, the AfterRender phase will execute after the template and/or body have rendered. A component with a body but without a template will still see the BeforeRenderBody phase execute.

Returning false will skip rendering of the template and/or body, and jump directly to the AfterRender phase.



Copyright © 2003-2012 The Apache Software Foundation.