com.nhaarman.triad

Interface Triad

public interface Triad

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Triad.ActivityResultListener
static interface	Triad.Callback Supplied by Triad to the Listener, which is responsible for calling onComplete().
static interface	Triad.Listener<T>

Method Summary

Modifier and Type	Method and Description
void	backward(Backstack newBackstack) Replaces the entire backstack with given backstack, in a backward manner.
boolean	canStart(android.content.Intent intent) Returns whether the given Intent can be launched.
void	forward(Backstack newBackstack) Replaces the entire backstack with given backstack, in a forward manner.
Backstack	getBackstack()
boolean	goBack() Pops the current screen off the backstack.
void	goTo(Screen<?> screen) Pushes given Screen onto the backstack.
void	goTo(Screen<?> screen, TransitionAnimator animator) Pushes given Screen onto the backstack.
boolean	isTransitioning()
void	onActivityResult(int requestCode, int resultCode, android.content.Intent data) Propagates the activity result to the proper [ActivityResultListener].
void	popTo(Screen<?> screen) Pops the backstack until given Screen is found.
void	popTo(Screen<?> screen, TransitionAnimator animator) Pops the backstack until given Screen is found.
void	replace(Backstack newBackstack) Replaces the entire backstack with given backstack, in a replace manner.
void	replace(Backstack newBackstack, TransitionAnimator animator) Replaces the entire backstack with given backstack, in a replace manner.
void	replaceWith(Screen<?> screen) Replaces the current Screen with given Screen.
void	replaceWith(Screen<?> screen, TransitionAnimator animator) Replaces the current Screen with given Screen.
void	setActivity(android.app.Activity activity) Sets the current Activity, to be able to start other Activities from the Triad instance.
void	setListener(Triad.Listener<?> listener)
void	showCurrent() Forces a notification of the current screen.
void	startActivity(android.content.Intent intent) Launches the Activity described by given Intent.
void	startActivityForResult(android.content.Intent intent, Triad.ActivityResultListener listener) Launches the Activity described by given Intent for result.
void	startWith(Backstack backstack) Initializes with given backstack.
void	startWith(Screen<?> screen) Initializes the backstack with given Screen.
void	startWith(Screen<?> screen, TransitionAnimator animator) Initializes the backstack with given Screen.

Method Detail

getBackstack

@NonNull
Backstack getBackstack()

isTransitioning

boolean isTransitioning()

setListener

void setListener(@Nullable
                 Triad.Listener<?> listener)

setActivity

void setActivity(@Nullable
                 android.app.Activity activity)

Sets the current Activity, to be able to start other Activities from the Triad instance.

startWith

void startWith(Screen<?> screen)

Initializes the backstack with given Screen. If the backstack is not empty, this call is ignored. This method must be called before any other backstack operation.

Parameters:

screen - The Screen to start with.

startWith

void startWith(@NonNull
               Screen<?> screen,
               @Nullable
               TransitionAnimator animator)

Initializes the backstack with given Screen. If the backstack is not empty, this call is ignored. This method must be called before any other backstack operation.

Parameters:

screen - The Screen to start with.

startWith

void startWith(@NonNull
               Backstack backstack)

Initializes with given backstack. If the current backstack is not empty, this call is ignored. This method must be called before any other backstack operation.

goTo

void goTo(@NonNull
          Screen<?> screen)

Pushes given Screen onto the backstack. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The screen to push onto the backstack.

goTo

void goTo(@NonNull
          Screen<?> screen,
          @Nullable
          TransitionAnimator animator)

Pushes given Screen onto the backstack. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The screen to push onto the backstack.

showCurrent

void showCurrent()

Forces a notification of the current screen.

popTo

void popTo(@NonNull
           Screen<?> screen)

Pops the backstack until given Screen is found. If the Screen is not found, the Screen is pushed onto the current backstack. Does nothing if the Screen is already on top of the stack. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The Screen to pop to.

popTo

void popTo(@NonNull
           Screen<?> screen,
           @Nullable
           TransitionAnimator animator)

Pops the backstack until given Screen is found. If the Screen is not found, the Screen is pushed onto the current backstack. Does nothing if the Screen is already on top of the stack. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The Screen to pop to.

replaceWith

void replaceWith(@NonNull
                 Screen<?> screen)

Replaces the current Screen with given Screen. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The Screen to replace the current Screen.

replaceWith

void replaceWith(@NonNull
                 Screen<?> screen,
                 @Nullable
                 TransitionAnimator animator)

Replaces the current Screen with given Screen. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

screen - The Screen to replace the current Screen.

goBack

boolean goBack()

Pops the current screen off the backstack. Does nothing if the backstack would be empty afterwards. One must first initialize this instance with [.startWith] before this method is called.

Returns:

true if the transition will execute.

forward

void forward(@NonNull
             Backstack newBackstack)

Replaces the entire backstack with given backstack, in a forward manner. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

newBackstack - The new backstack.

backward

void backward(@NonNull
              Backstack newBackstack)

Replaces the entire backstack with given backstack, in a backward manner. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

newBackstack - The new backstack.

replace

void replace(@NonNull
             Backstack newBackstack)

Replaces the entire backstack with given backstack, in a replace manner. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

newBackstack - The new backstack.

replace

void replace(@NonNull
             Backstack newBackstack,
             @Nullable
             TransitionAnimator animator)

Replaces the entire backstack with given backstack, in a replace manner. One must first initialize this instance with [.startWith] before this method is called.

Parameters:

newBackstack - The new backstack.

canStart

boolean canStart(@NonNull
                 android.content.Intent intent)

Returns whether the given Intent can be launched.

startActivity

void startActivity(@NonNull
                   android.content.Intent intent)

Launches the Activity described by given Intent.

Parameters:

intent - The Activity to start.

startActivityForResult

void startActivityForResult(@NonNull
                            android.content.Intent intent,
                            @NonNull
                            Triad.ActivityResultListener listener)

Launches the Activity described by given Intent for result.

Parameters:

intent - The Activity to start for result.

listener - The callback to notify for the result.

onActivityResult

void onActivityResult(int requestCode,
                      int resultCode,
                      @Nullable
                      android.content.Intent data)

Propagates the activity result to the proper [ActivityResultListener].

Parameters:

requestCode - The request code, as created by [.startActivityForResult].

resultCode - The result code of the returning Activity.

data - The result data of the returning Activity.