Home » tapestry-src-5.0.19 » org.apache.tapestry5.runtime » [javadoc | source]
public interface: Component [javadoc | source]

All Implemented Interfaces:
    PageLifecycleListener, 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.

This interface is likely to change without notice.
Method from org.apache.tapestry5.runtime.Component Summary:
afterRender,   afterRenderBody,   afterRenderTemplate,   beforeRenderBody,   beforeRenderTemplate,   beginRender,   cleanupRender,   dispatchComponentEvent,   postRenderCleanup,   setupRender
Method from org.apache.tapestry5.runtime.Component Detail:
 public  void afterRender(MarkupWriter writer,
    Event event)
 public  void afterRenderBody(MarkupWriter writer,
    Event event)
    Invoked just after rendering the body of the component.
 public  void afterRenderTemplate(MarkupWriter writer,
    Event event)
    Invoked after rendering the template for a component (only for components with a template).
 public  void beforeRenderBody(MarkupWriter writer,
    Event event)
    Invoked just before rendering the body of component.
 public  void beforeRenderTemplate(MarkupWriter writer,
    Event event)
    This phase is only invoked for components with templates.
 public  void beginRender(MarkupWriter writer,
    Event event)
    Invoked to allow a component to render its tag (start tag and attributes).
 public  void cleanupRender(MarkupWriter writer,
    Event event)
    Generally used to perform final cleanup of the component after rendering.
 public boolean dispatchComponentEvent(ComponentEvent event)
    Invoked to handle a component event. Methods with the OnEvent annotation (or the matching naming convention) will be invoked until one returns a non-null value.
 public  void postRenderCleanup()
    Lifecycle method invoked at the end of the org.apache.tapestry5.annotations.CleanupRender render 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.
 public  void setupRender(MarkupWriter writer,
    Event event)
    Invoked before rendering a component (or its template).