Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fix broken cwiki-test images

...

The rendering of each component is divided into a number of phases, illustrated below.

Image AddedImage Removed
Each of the orange phases (SetupRender, BeginRender, BeforeRenderBody, etc.) corresponds to an annotation you may place on one or more methods of your class. The annotation directs Tapestry to invoke your method as part of that phase.

...

All Render phase methods are optional; a default behavior is associated with each phase.

Annotation

Method Name

When Called

@SetupRender

setupRender()

When initial setup actions, if any, are needed

@BeginRender

beginRender()

When Tapestry is ready for the component's start tag, if any, to be rendered

@BeforeRenderTemplate

beforeRenderTemplate()

Before Tapestry renders the component's template, if any

@BeforeRenderBody

beforeRenderBody()

Before Tapestry renders the body of the component, if any

@AfterRenderBody

afterRenderBody()

After Tapestry renders the body of the component, if any, but before the rest of the component's template is rendered

@AfterRenderTemplate

afterRenderTemplate()

After Tapestry finishes rendering the component's template, if any

@AfterRender

afterRender()

After Tapestry has finished rendering both the template and body of the component

@CleanupRender

cleanupRender()

When final cleanup actions, if any, are needed

The large number of phases reflects the need for precise control of components from component mixins. Several of the phases exist almost exclusively for mixins.

...

What's really mind blowing is that the template and body of a component will often contain ... more components! That means that many different components will be in different phases of their own state machine.

Render Phases in Detail

...

Note

The SetupRender phase, like all render phases, occurs once for each rendering of the component. If the component is inside a looping component (Loop, Grid, etc.), then the SetupRender method will be called once for each iteration of the loop.

SetupRender

The SetupRender phase (see @SetupRender) is where you can perform any one-time per-render setup for your component. This is a good place to read component parameters and use them to set temporary instance variables.

...

Code Block
  http://www.example.com/myapp/mypage?t:component-trace=true

Scrollbar