Method Detail

• setBackstack

  @UiThread() void setBackstack(@NonNull() List<RouterTransaction> newBackstack, @Nullable() ControllerChangeHandler changeHandler)

  Sets the backstack, transitioning from the current top controller to the top of the new stack (if different)using the passed ControllerChangeHandler

  Parameters:

  newBackstack - The new backstack

  changeHandler - An optional change handler to be used to handle the root view of transition

• setPopRootControllerMode

  @NonNull() Router setPopRootControllerMode(@NonNull() Router.PopRootControllerMode popRootControllerMode)

  Sets the method this router will use to handle back presses when there is only one controller left in the backstack.Defaults to POP_ROOT_CONTROLLER_LEAVING_VIEW so that the developer can either finish its containing Activity orotherwise hide its parent view without any strange artifacting.

• getActivity

  @Nullable() abstract Activity getActivity()

  Returns this Router's host Activity or {@code null} if it has either not yet been attached toan Activity or if the Activity has been destroyed.

• onActivityResult

   abstract void onActivityResult(int requestCode, int resultCode, @Nullable() Intent data)

  This should be called by the host Activity when its onActivityResult method is called if the instanceIdof the controller that called startActivityForResult is not known.

  Parameters:

  requestCode - The Activity's onActivityResult requestCode

  resultCode - The Activity's onActivityResult resultCode

  data - The Activity's onActivityResult data

• onRequestPermissionsResult

   void onRequestPermissionsResult(@NonNull() String instanceId, int requestCode, @NonNull() Array<String> permissions, @NonNull() Array<int> grantResults)

  This should be called by the host Activity when its onRequestPermissionsResult method is called. The call will be forwardedto the Controller with the instanceId passed in.

  Parameters:

  instanceId - The instanceId of the Controller to which this result should be forwarded

  requestCode - The Activity's onRequestPermissionsResult requestCode

  permissions - The Activity's onRequestPermissionsResult permissions

  grantResults - The Activity's onRequestPermissionsResult grantResults

• handleBack

  @UiThread() boolean handleBack()

  This should be called by the host Activity when its onBackPressed method is called. The call will be forwardedto its top Controller. If that controller doesn't handle it, then it will be popped.

• popCurrentController

  @UiThread() boolean popCurrentController()

  Pops the top Controller from the backstack

• popController

  @UiThread() boolean popController(@NonNull() Controller controller)

  Pops the passed Controller from the backstack

  Parameters:

  controller - The controller that should be popped from this Router

• pushController

  @UiThread() void pushController(@NonNull() RouterTransaction transaction)

  Pushes a new Controller to the backstack

  Parameters:

  transaction - The transaction detailing what should be pushed, including the Controller,and its push and pop ControllerChangeHandler, and its tag.

• replaceTopController

  @UiThread() void replaceTopController(@NonNull() RouterTransaction transaction)

  Replaces this Router's top Controller with a new Controller

  Parameters:

  transaction - The transaction detailing what should be pushed, including the Controller,and its push and pop ControllerChangeHandler, and its tag.

• getContainerId

   int getContainerId()

• setPopsLastView

  @NonNull()@Deprecated() Router setPopsLastView(boolean popsLastView)

  If set to true, this router will handle back presses by performing a change handler on the last controller and viewin the stack. This defaults to false so that the developer can either finish its containing Activity or otherwisehide its parent view without any strange artifacting.Note: This method has been deprecated and should be replaced with setPopRootControllerMode.

• popToRoot

  @UiThread() boolean popToRoot()

  Pops all Controllers until only the root is left

• popToRoot

  @UiThread() boolean popToRoot(@Nullable() ControllerChangeHandler changeHandler)

  Pops all Controller until only the root is left

  Parameters:

  changeHandler - The ControllerChangeHandler to handle this transaction

• popToTag

  @UiThread() boolean popToTag(@NonNull() String tag)

  Pops all Controllers until the Controller with the passed tag is at the top

  Parameters:

  tag - The tag being popped to

• popToTag

  @UiThread() boolean popToTag(@NonNull() String tag, @Nullable() ControllerChangeHandler changeHandler)

  Pops all Controllers until the Controller with the passed tag is at the top

  Parameters:

  tag - The tag being popped to

  changeHandler - The ControllerChangeHandler to handle this transaction

• setRoot

  @UiThread() void setRoot(@NonNull() RouterTransaction transaction)

  Sets the root Controller. If any Controllers are currently in the backstack, they will be removed.

  Parameters:

  transaction - The transaction detailing what should be pushed, including the Controller,and its push and pop ControllerChangeHandler, and its tag.

• getControllerWithInstanceId

  @Nullable() Controller getControllerWithInstanceId(@NonNull() String instanceId)

  Returns the hosted Controller with the given instance id or {@code null} if no suchController exists in this Router.

  Parameters:

  instanceId - The instance ID being searched for

• getControllerWithTag

  @Nullable() Controller getControllerWithTag(@NonNull() String tag)

  Returns the hosted Controller that was pushed with the given tag or {@code null} if nosuch Controller exists in this Router.

  Parameters:

  tag - The tag being searched for

• getBackstackSize

   int getBackstackSize()

  Returns the number of Controllers currently in the backstack

• hasRootController

   boolean hasRootController()

  Returns whether or not this Router has a root Controller

• addChangeListener

   void addChangeListener(@NonNull() ControllerChangeHandler.ControllerChangeListener changeListener)

  Adds a listener for all of this Router's Controller change events

  Parameters:

  changeListener - The listener

• removeChangeListener

   void removeChangeListener(@NonNull() ControllerChangeHandler.ControllerChangeListener changeListener)

  Removes a previously added listener

  Parameters:

  changeListener - The listener to be removed

• rebindIfNeeded

  @UiThread() void rebindIfNeeded()

  Attaches this Router's existing backstack to its container if one exists.

• onActivityResult

   final void onActivityResult(@NonNull() String instanceId, int requestCode, int resultCode, @Nullable() Intent data)

• onActivityStarted

   final void onActivityStarted(@NonNull() Activity activity)

• onActivityResumed

   final void onActivityResumed(@NonNull() Activity activity)

• onActivityPaused

   final void onActivityPaused(@NonNull() Activity activity)

• onActivityStopped

   final void onActivityStopped(@NonNull() Activity activity)

• onActivityDestroyed

   void onActivityDestroyed(@NonNull() Activity activity, boolean isConfigurationChange)

• prepareForHostDetach

   void prepareForHostDetach()

• saveInstanceState

   void saveInstanceState(@NonNull() Bundle outState)

• restoreInstanceState

   void restoreInstanceState(@NonNull() Bundle savedInstanceState)

• onCreateOptionsMenu

   final void onCreateOptionsMenu(@NonNull() Menu menu, @NonNull() MenuInflater inflater)

• onPrepareOptionsMenu

   final void onPrepareOptionsMenu(@NonNull() Menu menu)

• onOptionsItemSelected

   final boolean onOptionsItemSelected(@NonNull() MenuItem item)

• handleRequestedPermission

  @Nullable() final Boolean handleRequestedPermission(@NonNull() String permission)