Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 // Copyright 2006, 2009 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.apache.tapestry5.runtime;
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.

{

    
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.
    void postRenderCleanup();

    
Invoked before rendering a component (or its template).
    void setupRender(MarkupWriter writerEvent event);

    
Invoked to allow a component to render its tag (start tag and attributes).
    void beginRender(MarkupWriter writerEvent event);

    
This phase is only invoked for components with templates.
    void beforeRenderTemplate(MarkupWriter writerEvent event);

    
Invoked after rendering the template for a component (only for components with a template).
    void afterRenderTemplate(MarkupWriter writerEvent event);

    
Invoked just before rendering the body of component.
    void beforeRenderBody(MarkupWriter writerEvent event);

    
Invoked just after rendering the body of the component.
    void afterRenderBody(MarkupWriter writerEvent event);

    
Generally used to write the close tag matching any open tag written by beginRender(org.apache.tapestry5.MarkupWriter,org.apache.tapestry5.runtime.Event).
    void afterRender(MarkupWriter writerEvent event);

    
Generally used to perform final cleanup of the component after rendering.
    void cleanupRender(MarkupWriter writerEvent event);

    
Invoked to handle a component event. Methods with the org.apache.tapestry5.annotations.OnEvent annotation (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:
java.lang.RuntimeException wrapping any checked exceptions that are thrown by individual event handler methods
    boolean dispatchComponentEvent(ComponentEvent event);
New to GrepCode? Check out our FAQ X