com.hannesdorfmann.swipeback.transformer

Interface SwipeBackTransformer

All Known Implementing Classes:

DefaultSwipeBackTransformer, SlideSwipeBackTransformer

public interface SwipeBackTransformer

A SwipeBackTransformer is responsible to manipulate the swipe back view according to its current state (opening or closing) #onSwiping(com.hannesdorfmann.swipeback.SwipeBack, float, int, int) with some nice animations. Also onSwipeBackCompleted(com.hannesdorfmann.swipeback.SwipeBack, android.app.Activity) will be called after the swipe back has been completed to let you finish the activity by setting your own animation transition. Created by Hannes Dorfmann on 03.01.14.

Method Summary

Modifier and Type	Method and Description
void	onSwipeBackCompleted(SwipeBack swipeBack, android.app.Activity activity) This method is called after the swipe back has completed.
void	onSwipeBackReseted(SwipeBack swipeBack, android.app.Activity activity) This method is called if the swipe back has been canceled / reseted.
void	onSwipeBackViewCreated(SwipeBack swipeBack, android.app.Activity activity, android.view.View swipeBackView) This is called if the swipe back view has been created.
void	onSwiping(SwipeBack swipeBack, float openRatio, int pixelOffset) Called while the swipe back view is opening or closing.

Method Detail

onSwipeBackViewCreated

void onSwipeBackViewCreated(SwipeBack swipeBack,
                            android.app.Activity activity,
                            android.view.View swipeBackView)

This is called if the swipe back view has been created. As parameter you get the concrete view and you can setup your internal things like getting references to the child view by using View.findViewById(int) etc.

Parameters:

swipeBack - The reference to the SwipeBack object

activity - Tha activity the swipe back is attached to

swipeBackView - The view that has been inflated as swipe back view

onSwipeBackCompleted

void onSwipeBackCompleted(SwipeBack swipeBack,
                          android.app.Activity activity)

This method is called after the swipe back has completed. This means that the swipe back view is fully shown and the use has released the finger (up) from the display. Usually you use this method to finish the activity by calling or Activity.finish() and you may set the activity animations by using Activity.overridePendingTransition(int, int). You should use Activity.finish() and not Activity.onBackPressed(), because onBackPressed() may cause a IllegalStateException if the user rotates the device (screen rotation from landscape to portrait or vice versa), while the SwipeBackView is fully open, but the user has not released yet the finger (finger is still on the screen).

Parameters:

swipeBack - The reference to the SwipeBack object

activity -

onSwipeBackReseted

void onSwipeBackReseted(SwipeBack swipeBack,
                        android.app.Activity activity)

This method is called if the swipe back has been canceled / reseted. So the swipe back view is no longer visible, only the main activity layout is visible. This is done if the user closes the swipe back view before it was completed #onSwipeBackCompleted(android.app.Activity).

Parameters:

swipeBack - The reference to the SwipeBack object

activity - Tha activity the swipe back is attached to

onSwiping

void onSwiping(SwipeBack swipeBack,
               float openRatio,
               int pixelOffset)

Called while the swipe back view is opening or closing. This is the point where you do your frame by frame (step by step) animation for your swipe back view

Parameters:

swipeBack - The reference to the SwipeBack object

openRatio - a value between 0 and 1 that indicates how much open (visible) the swiping view is

pixelOffset - The number of pixels visible of the swipe back view