001    // Copyright 2007, 2009, 2010 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use tis file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.annotations;
016    
017    import java.lang.annotation.Documented;
018    import static java.lang.annotation.ElementType.METHOD;
019    import java.lang.annotation.Retention;
020    import static java.lang.annotation.RetentionPolicy.RUNTIME;
021    import java.lang.annotation.Target;
022    
023    import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
024    import org.apache.tapestry5.ioc.annotations.UseWith;
025    
026    /**
027     * Method annotation used for methods that should be invoked once the page is fully loaded. This is useful for one-time
028     * component initializations that can't be done at instance initialization time, such as references to embedded
029     * components or blocks.
030     * <p/>
031     * PageLoaded methods should take no parameters and return void. They must either have this annotation, or be named
032     * "pageLoaded".
033     */
034    @Target(METHOD)
035    @Retention(RUNTIME)
036    @Documented
037    @UseWith({COMPONENT,MIXIN,PAGE})
038    public @interface PageLoaded
039    {
040    
041    }