Controller

abstract class Controller

A Controller manages portions of the UI. It is similar to an Activity or Fragment in that it manages its own lifecycle and controls interactions between the UI and whatever logic is required. It is, however, a much lighter weight component than either Activities or Fragments. While it offers several lifecycle methods, they are much simpler and more predictable than those of Activities and Fragments.

Types

LifecycleListener

abstract class LifecycleListener

Allows external classes to listen for lifecycle events in a Controller

RetainViewMode

enum RetainViewMode

Modes that will influence when the Controller will allow its view to be destroyed

Functions

addLifecycleListener

fun addLifecycleListener(@NonNull() lifecycleListener: Controller.LifecycleListener)

Adds a listener for all of this Controller's lifecycle events

getActivity

@Nullable()

fun getActivity(): Activity

Returns the host Activity of this Controller's Router or {@code null} if thisController has not yet been attached to an Activity or if the Activity has been destroyed.

getApplicationContext

@Nullable()

fun getApplicationContext(): Context

Returns the Application Context derived from the host Activity or {@code null} if this Controllerhas not yet been attached to an Activity or if the Activity has been destroyed.

getChildRouter

@NonNull()

fun getChildRouter(@NonNull() container: ViewGroup): Router

Retrieves the child Router for the given container.

@NonNull()

fun getChildRouter(@NonNull() container: ViewGroup, @Nullable() tag: String): Router

Retrieves the child Router for the given container/tag combination.

@Nullable()

fun getChildRouter(@NonNull() container: ViewGroup, @Nullable() tag: String, createIfNeeded: Boolean): Router

Retrieves the child Router for the given container/tag combination.

@Nullable()

fun getChildRouter(@NonNull() container: ViewGroup, @Nullable() tag: String, createIfNeeded: Boolean, boundToHostContainerId: Boolean): Router

Retrieves the child Router for the given container/tag combination.

getResources

@Nullable()

fun getResources(): Resources

Returns the Resources from the host Activity or {@code null} if this Controller has notyet been attached to an Activity or if the Activity has been destroyed.

getTargetController

@Nullable()

fun getTargetController(): Controller

Returns the target Controller that was set with the setTargetController method or {@code null} if this Controller has no target.

handleBack

open fun handleBack(): Boolean

Should be overridden if this Controller needs to handle the back button being pressed.

isAttached

fun isAttached(): Boolean

Returns whether or not this Controller is currently attached to a host View.

isDestroyed

fun isDestroyed(): Boolean

Returns whether or not this Controller has been destroyed.

onActivityResult

open fun onActivityResult(requestCode: Int, resultCode: Int, @Nullable() data: Intent)

Should be overridden if this Controller has called startActivityForResult and needs to handlethe result.

onCreateOptionsMenu

open fun onCreateOptionsMenu(@NonNull() menu: Menu, @NonNull() inflater: MenuInflater)

Adds option items to the host Activity's standard options menu.

onOptionsItemSelected

open fun onOptionsItemSelected(@NonNull() item: MenuItem): Boolean

Called when an option menu item has been selected by the user.

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(@NonNull() menu: Menu)

Prepare the screen's options menu to be displayed.

onRequestPermissionsResult

open fun onRequestPermissionsResult(requestCode: Int, @NonNull() permissions: Array<String>, @NonNull() grantResults: Array<Int>)

Should be overridden if this Controller has requested runtime permissions and needs to handle the user's response.

overridePopHandler

open fun overridePopHandler(@Nullable() overriddenPopHandler: ControllerChangeHandler)

Overrides the ControllerChangeHandler that should be used for popping this Controller.

overridePushHandler

open fun overridePushHandler(@Nullable() overriddenPushHandler: ControllerChangeHandler)

Overrides the ControllerChangeHandler that should be used for pushing this Controller.

registerForActivityResult

fun registerForActivityResult(requestCode: Int)

Registers this Controller to handle onActivityResult responses.

removeChildRouter

fun removeChildRouter(@NonNull() childRouter: Router)

Removes a child Router from this Controller.

removeLifecycleListener

fun removeLifecycleListener(@NonNull() lifecycleListener: Controller.LifecycleListener)

Removes a previously added lifecycle listener

requestPermissions

fun requestPermissions(@NonNull() permissions: Array<String>, requestCode: Int)

Calls requestPermission(String[], int) from this Controller's host Activity.

setTargetController

open fun setTargetController(@Nullable() target: Controller)

Optional target for this Controller.

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull() permission: String): Boolean

Gets whether you should show UI with rationale for requesting a permission.

startActivity

fun startActivity(@NonNull() intent: Intent)

Calls startActivity(Intent) from this Controller's host Activity.

startActivityForResult

fun startActivityForResult(@NonNull() intent: Intent, requestCode: Int)

Calls startActivityForResult(Intent, int) from this Controller's host Activity.

fun startActivityForResult(@NonNull() intent: Intent, requestCode: Int, @Nullable() options: Bundle)

Calls startActivityForResult(Intent, int, Bundle) from this Controller's host Activity.

startIntentSenderForResult

fun startIntentSenderForResult(@NonNull() intent: IntentSender, requestCode: Int, @Nullable() fillInIntent: Intent, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable() options: Bundle)

Calls startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle) from this Controller's host Activity.

Properties

args

private val args: Bundle

hasOptionsMenu

private open var hasOptionsMenu: Boolean

instanceId

open val instanceId: String

isBeingDestroyed

open val isBeingDestroyed: Boolean

optionsMenuHidden

private open var optionsMenuHidden: Boolean

overriddenPopHandler

private open val overriddenPopHandler: ControllerChangeHandler

overriddenPushHandler

private open val overriddenPushHandler: ControllerChangeHandler

parentController

private open var parentController: Controller

retainViewMode

private open var retainViewMode: Controller.RetainViewMode

router

open var router: Router

view

open val view: View

Extensions

asTransaction

fun Controller.asTransaction(popChangeHandler: ControllerChangeHandler? = null, pushChangeHandler: ControllerChangeHandler? = null): RouterTransaction