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
015package org.apache.tapestry5.annotations;
016
017import java.lang.annotation.Documented;
018import static java.lang.annotation.ElementType.FIELD;
019import java.lang.annotation.Retention;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021import java.lang.annotation.Target;
022
023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE;
024import 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 * If using this annotation more than once per page class you must specify unique indexes for each. Indexes must start
032 * at 0 and increment by 1 (eg. if 3 annotations are present they must have indexes of 0, 1 and 2)
033 */
034@Target(FIELD)
035@Documented
036@Retention(RUNTIME)
037@UseWith(PAGE)
038public @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    
050    /**
051     * The index of the page activation context parameter (default 0)
052     * @since 5.4
053     */
054    int index() default 0;
055}