001    // Copyright 2008, 2009 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this 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.FIELD;
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.PAGE;
024    import org.apache.tapestry5.ioc.annotations.UseWith;
025    
026    /**
027     * Annotation for a field for which the page activation context handlers (onActivate and onPassivate) should be created.
028     * In order to use this annotation you must contribute a {@link org.apache.tapestry5.ValueEncoder} for the class of the
029     * annotated property.
030     * <p/>
031     * You should not use this annotation within a class that already has an onActivate() or onPassivate() method; doing so
032     * will result in a runtime exception.
033     */
034    @Target(FIELD)
035    @Documented
036    @Retention(RUNTIME)
037    @UseWith(PAGE)
038    public @interface PageActivationContext
039    {
040        /**
041         * Whether to create an activate event handler.
042         */
043        boolean activate() default true;
044    
045        /**
046         * Whether to create a passivate event handler
047         */
048        boolean passivate() default true;
049    }