Package org.apache.tapestry5.runtime
Interface Component
- All Superinterfaces:
ComponentResourcesAware
Interface that defines the lifecycle of a component, within a page, allowing for callbacks into the component for
many different events. This interface is part of the public API for Tapestry, but is not expected to be
directly implemented by component classes; it should only be implemented as part of the component class
transformation process.
Most of the methods are related to render phases; see the corresponding annotations and component rendering
documentation to see how they relate to each other.
Starting in 5.3 this interface no longer implements
PageLifecycleListener. Normally, this would be an incompatible
change, but Component is not supposed to be directly implemented by user code.-
Method Summary
Modifier and TypeMethodDescriptionvoidafterRender(MarkupWriter writer, Event event) Generally used to write the close tag matching any open tag written bybeginRender(org.apache.tapestry5.MarkupWriter, Event).voidafterRenderBody(MarkupWriter writer, Event event) Invoked just after rendering the body of the component.voidafterRenderTemplate(MarkupWriter writer, Event event) Invoked after rendering the template for a component (only for components with a template).voidbeforeRenderBody(MarkupWriter writer, Event event) Invoked just before rendering the body of component.voidbeforeRenderTemplate(MarkupWriter writer, Event event) This phase is only invoked for components with templates.voidbeginRender(MarkupWriter writer, Event event) Invoked to allow a component to render its tag (start tag and attributes).voidcleanupRender(MarkupWriter writer, Event event) Generally used to perform final cleanup of the component after rendering.booleanInvoked to handle a component event.voidLifecycle method invoked at the end of theCleanupRenderrender phase.voidsetupRender(MarkupWriter writer, Event event) Invoked before rendering a component (or its template).Methods inherited from interface org.apache.tapestry5.runtime.ComponentResourcesAware
getComponentResources
-
Method Details
-
postRenderCleanup
void postRenderCleanup()Lifecycle method invoked at the end of theCleanupRenderrender phase. There is no annotation for this method, it is part of CleanupRender, but is always invoked. Its specific use is to allow components to clean up cached parameter values. -
setupRender
Invoked before rendering a component (or its template). -
beginRender
Invoked to allow a component to render its tag (start tag and attributes). -
beforeRenderTemplate
This phase is only invoked for components with templates. -
afterRenderTemplate
Invoked after rendering the template for a component (only for components with a template). -
beforeRenderBody
Invoked just before rendering the body of component. -
afterRenderBody
Invoked just after rendering the body of the component. -
afterRender
Generally used to write the close tag matching any open tag written bybeginRender(org.apache.tapestry5.MarkupWriter, Event). -
cleanupRender
Generally used to perform final cleanup of the component after rendering. -
dispatchComponentEvent
Invoked to handle a component event. Methods with theOnEventannotation (or the matching naming convention) will be invoked until one returns a non-null value.- Parameters:
event-- Returns:
- true if any handler was found (and invoked), false otherwise
- Throws:
RuntimeException- wrapping any checked exceptions that are thrown by individual event handler methods
-