Router (conductor API)

java.lang.Object
- com.bluelinelabs.conductor.Router

Direct Known Subclasses:

ActivityHostedRouter
```
public abstract class Router
extends java.lang.Object
```
A Router implements navigation and backstack handling for Controllers. Router objects are attached to Activity/containing ViewGroup pairs. Routers do not directly render or push Views to the container ViewGroup, but instead defer this responsibility to the ControllerChangeHandler specified in a given transaction.

Constructor Summary

Constructors
Constructor and Description

Router()

Constructors
Constructor and Description
`Router()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(ControllerChangeHandler.ControllerChangeListener changeListener)` Adds a listener for all of this Router's `Controller` change events
`abstract android.app.Activity`	`getActivity()` Returns this Router's host Activity or `null` if it has either not yet been attached to an Activity or if the Activity has been destroyed.
`java.util.List<RouterTransaction>`	`getBackstack()` Returns the current backstack, ordered from root to most recently pushed.
`int`	`getBackstackSize()` Returns the number of `Controller`s currently in the backstack
`int`	`getContainerId()`
`Controller`	`getControllerWithInstanceId(java.lang.String instanceId)` Returns the hosted Controller with the given instance id or `null` if no such Controller exists in this Router.
`Controller`	`getControllerWithTag(java.lang.String tag)` Returns the hosted Controller that was pushed with the given tag or `null` if no such Controller exists in this Router.
`boolean`	`handleBack()` This should be called by the host Activity when its onBackPressed method is called.
`java.lang.Boolean`	`handleRequestedPermission(java.lang.String permission)`
`boolean`	`hasRootController()` Returns whether or not this Router has a root `Controller`
`void`	`onActivityDestroyed(android.app.Activity activity)`
`void`	`onActivityPaused(android.app.Activity activity)`
`abstract void`	`onActivityResult(int requestCode, int resultCode, android.content.Intent data)` This should be called by the host Activity when its onActivityResult method is called if the instanceId of the controller that called startActivityForResult is not known.
`void`	`onActivityResult(java.lang.String instanceId, int requestCode, int resultCode, android.content.Intent data)`
`void`	`onActivityResumed(android.app.Activity activity)`
`void`	`onActivityStarted(android.app.Activity activity)`
`void`	`onActivityStopped(android.app.Activity activity)`
`void`	`onCreateOptionsMenu(android.view.Menu menu, android.view.MenuInflater inflater)`
`boolean`	`onOptionsItemSelected(android.view.MenuItem item)`
`void`	`onPrepareOptionsMenu(android.view.Menu menu)`
`void`	`onRequestPermissionsResult(java.lang.String instanceId, int requestCode, java.lang.String[] permissions, int[] grantResults)` This should be called by the host Activity when its onRequestPermissionsResult method is called.
`boolean`	`popController(Controller controller)` Pops the passed `Controller` from the backstack
`boolean`	`popCurrentController()` Pops the top `Controller` from the backstack
`boolean`	`popToRoot()` Pops all `Controller`s until only the root is left
`boolean`	`popToRoot(ControllerChangeHandler changeHandler)` Pops all `Controller` until only the root is left
`boolean`	`popToTag(java.lang.String tag)` Pops all `Controller`s until the Controller with the passed tag is at the top
`boolean`	`popToTag(java.lang.String tag, ControllerChangeHandler changeHandler)` Pops all `Controller`s until the `Controller` with the passed tag is at the top
`void`	`prepareForHostDetach()`
`void`	`pushController(RouterTransaction transaction)` Pushes a new `Controller` to the backstack
`protected void`	`pushToBackstack(RouterTransaction entry)`
`void`	`rebindIfNeeded()` Attaches this Router's existing backstack to its container if one exists.
`void`	`removeChangeListener(ControllerChangeHandler.ControllerChangeListener changeListener)` Removes a previously added listener
`void`	`replaceTopController(RouterTransaction transaction)` Replaces this Router's top `Controller` with a new `Controller`
`void`	`restoreInstanceState(android.os.Bundle savedInstanceState)`
`void`	`saveInstanceState(android.os.Bundle outState)`
`void`	`setBackstack(java.util.List<RouterTransaction> newBackstack, ControllerChangeHandler changeHandler)` Sets the backstack, transitioning from the current top controller to the top of the new stack (if different) using the passed `ControllerChangeHandler`
`Router`	`setPopsLastView(boolean popsLastView)` If set to true, this router will handle back presses by performing a change handler on the last controller and view in the stack.
`void`	`setRoot(RouterTransaction transaction)` Sets the root Controller.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Router
```
public Router()
```
- Method Detail
  - getActivity
```
public abstract android.app.Activity getActivity()
```
    Returns this Router's host Activity or null if it has either not yet been attached to an Activity or if the Activity has been destroyed.
  - onActivityResult
```
public abstract void onActivityResult(int requestCode,
                                      int resultCode,
                                      android.content.Intent data)
```
    This should be called by the host Activity when its onActivityResult method is called if the instanceId of 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
```
public void onRequestPermissionsResult(java.lang.String instanceId,
                                       int requestCode,
                                       java.lang.String[] permissions,
                                       int[] grantResults)
```
    This should be called by the host Activity when its onRequestPermissionsResult method is called. The call will be forwarded to 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
```
public boolean handleBack()
```
    This should be called by the host Activity when its onBackPressed method is called. The call will be forwarded to its top Controller. If that controller doesn't handle it, then it will be popped.
    
    Returns:
    
    Whether or not a back action was handled by the Router
  - popCurrentController
```
public boolean popCurrentController()
```
    Pops the top Controller from the backstack
    
    Returns:
    
    Whether or not this Router still has controllers remaining on it after popping.
  - popController
```
public boolean popController(Controller controller)
```
    Pops the passed Controller from the backstack
    
    Parameters:
    
    controller - The controller that should be popped from this Router
    
    Returns:
    
    Whether or not this Router still has controllers remaining on it after popping.
  - pushController
```
public void pushController(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
```
public void replaceTopController(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
```
public int getContainerId()
```
  - setPopsLastView
```
public Router setPopsLastView(boolean popsLastView)
```
    If set to true, this router will handle back presses by performing a change handler on the last controller and view in the stack. This defaults to false so that the developer can either finish its containing Activity or otherwise hide its parent view without any strange artifacting.
  - popToRoot
```
public boolean popToRoot()
```
    Pops all Controllers until only the root is left
    
    Returns:
    
    Whether or not any Controllers were popped in order to get to the root transaction
  - popToRoot
```
public boolean popToRoot(ControllerChangeHandler changeHandler)
```
    Pops all Controller until only the root is left
    
    Parameters:
    
    changeHandler - The ControllerChangeHandler to handle this transaction
    
    Returns:
    
    Whether or not any Controllers were popped in order to get to the root transaction
  - popToTag
```
public boolean popToTag(java.lang.String tag)
```
    Pops all Controllers until the Controller with the passed tag is at the top
    
    Parameters:
    
    tag - The tag being popped to
    
    Returns:
    
    Whether or not any Controllers were popped in order to get to the transaction with the passed tag
  - popToTag
```
public boolean popToTag(java.lang.String tag,
                        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
    
    Returns:
    
    Whether or not the Controller with the passed tag is now at the top
  - setRoot
```
public void setRoot(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
```
public Controller getControllerWithInstanceId(java.lang.String instanceId)
```
    Returns the hosted Controller with the given instance id or null if no such Controller exists in this Router.
    
    Parameters:
    
    instanceId - The instance ID being searched for
  - getControllerWithTag
```
public Controller getControllerWithTag(java.lang.String tag)
```
    Returns the hosted Controller that was pushed with the given tag or null if no such Controller exists in this Router.
    
    Parameters:
    
    tag - The tag being searched for
  - getBackstackSize
```
public int getBackstackSize()
```
    Returns the number of Controllers currently in the backstack
  - getBackstack
```
public java.util.List<RouterTransaction> getBackstack()
```
    Returns the current backstack, ordered from root to most recently pushed.
  - setBackstack
```
public void setBackstack(java.util.List<RouterTransaction> newBackstack,
                         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
  - hasRootController
```
public boolean hasRootController()
```
    Returns whether or not this Router has a root Controller
  - addChangeListener
```
public void addChangeListener(ControllerChangeHandler.ControllerChangeListener changeListener)
```
    Adds a listener for all of this Router's Controller change events
    
    Parameters:
    
    changeListener - The listener
  - removeChangeListener
```
public void removeChangeListener(ControllerChangeHandler.ControllerChangeListener changeListener)
```
    Removes a previously added listener
    
    Parameters:
    
    changeListener - The listener to be removed
  - rebindIfNeeded
```
public void rebindIfNeeded()
```
    Attaches this Router's existing backstack to its container if one exists.
  - onActivityResult
```
public final void onActivityResult(java.lang.String instanceId,
                                   int requestCode,
                                   int resultCode,
                                   android.content.Intent data)
```
  - onActivityStarted
```
public final void onActivityStarted(android.app.Activity activity)
```
  - onActivityResumed
```
public final void onActivityResumed(android.app.Activity activity)
```
  - onActivityPaused
```
public final void onActivityPaused(android.app.Activity activity)
```
  - onActivityStopped
```
public final void onActivityStopped(android.app.Activity activity)
```
  - onActivityDestroyed
```
public void onActivityDestroyed(android.app.Activity activity)
```
  - prepareForHostDetach
```
public void prepareForHostDetach()
```
  - saveInstanceState
```
public void saveInstanceState(android.os.Bundle outState)
```
  - restoreInstanceState
```
public void restoreInstanceState(android.os.Bundle savedInstanceState)
```
  - onCreateOptionsMenu
```
public final void onCreateOptionsMenu(android.view.Menu menu,
                                      android.view.MenuInflater inflater)
```
  - onPrepareOptionsMenu
```
public final void onPrepareOptionsMenu(android.view.Menu menu)
```
  - onOptionsItemSelected
```
public final boolean onOptionsItemSelected(android.view.MenuItem item)
```
  - handleRequestedPermission
```
public final java.lang.Boolean handleRequestedPermission(java.lang.String permission)
```
  - pushToBackstack
```
protected void pushToBackstack(RouterTransaction entry)
```

Class Router

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Router

Method Detail

getActivity

onActivityResult

onRequestPermissionsResult

handleBack

popCurrentController

popController

pushController

replaceTopController

getContainerId

setPopsLastView

popToRoot

popToRoot

popToTag

popToTag

setRoot

getControllerWithInstanceId

getControllerWithTag

getBackstackSize

getBackstack

setBackstack

hasRootController

addChangeListener

removeChangeListener

rebindIfNeeded

onActivityResult

onActivityStarted

onActivityResumed

onActivityPaused

onActivityStopped

onActivityDestroyed

prepareForHostDetach

saveInstanceState

restoreInstanceState

onCreateOptionsMenu

onPrepareOptionsMenu

onOptionsItemSelected

handleRequestedPermission

pushToBackstack