org.androidannotations.annotations.PageScrolled Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation

The API jar containing the annotations and the runtime helpers

There is a newer version: 4.8.0

Show newest version

/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 *
 * 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.androidannotations.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * This annotation is intended to be used on methods to receive events defined
 * by
 * android.support.v4.view.ViewPager.OnPageChangeListener.OnPageScrolled
 * when the current page is scrolled, either as part of a programmatically
 * initiated smooth scroll or a user initiated touch scroll.
 * 
 * 
 * The annotation value should be one or several R.id.* fields that refers to
 * ViewPager or subclasses of ViewPager. If not set, the method name will be
 * used as the R.id.* field name.
 * 
 * 
 * The method MAY have multiple parameters, but the order must be following :
 * 
 * 
 * A ViewPager parameter to know which view has targeted this event.
 * An int parameter named position to get position index of the first page
 * currently being displayed. Page position+1 will be visible if positionOffset
 * is nonzero.
 * A float parameter is value from [0,1) indicating the offset from the page
 * at position.
 * An int parameter named positionOffsetPixels is value in pixels indicating
 * the offset from position.
 * 
 *
 * 
 *
 * Examples :
 *
 *  * @PageScrolled(R.id.viewpager)
 * void onPageScrolled(ViewPager view, int position, float positionOffset, int positionOffsetPixels) {
 * 	// Something Here
 * }
 *
 * @PageScrolled
 * void viewPager(ViewPager view) {
 * 	// Something Here
 * }
 *
 * @PageScrolled({R.id.viewpager, R.id.viewpager2})
 * void onPageScrolledOnMultipleViewPager(ViewPager v, int position) {
 * 	// Something Here
 * }
 *
 * @PageScrolled(R.id.viewpager)
 * void onPageScrolledNoParam() {
 * 	// Something Here
 * }
 * 
 *
 * 
 *
 * @see PageScrollStateChanged
 * @see PageSelected
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface PageScrolled {

	/**
	 * The R.id.* fields which refer to the ViewPager.
	 *
	 * @return the ids of the ViewPager.
	 */
	int[] value() default ResId.DEFAULT_VALUE;

	/**
	 * The resource names as a strings which refer to the ViewPagers.
	 *
	 * @return the resource names of the ViewPagers.
	 */
	String[] resName() default "";

}