Step

abstract class Step(val toolbarData: ToolbarData? = null) : CoroutineScope

Base controller that controls the fragment of a Step. It is a controller in the context of the MVC architectural pattern. This controller is responsible for populating the fragment with the sections HeaderSection, ContentSection and FooterSection.

It also dictates the flow by using the flowCoordinator.

Constructors

Step

fun Step(toolbarData: ToolbarData? = null)

Functions

canGoBack

open fun canGoBack(): Boolean

getMenuResource

open fun getMenuResource(): Int

Used to provide the menu resource that will be displayed in the toolbar for this step. By default, no menu is displayed.

onCreate

open fun onCreate( activity: Activity, header: Section?, content: Section?, footer: Section?)

Base Lifecycle onCreate method called by the StepFragment

onDestroy

open fun onDestroy()

Base Lifecycle onDestroyed method called by the StepFragment

onFragmentCreated

open fun onFragmentCreated(fragment: Fragment)

Base Lifecycle onFragmentCreated method called by the StepFragment

onOptionsItemSelected

open fun onOptionsItemSelected(menuItem: MenuItem): Boolean

Called when an item was selected.

onPause

open fun onPause()

Base Lifecycle onPause method called by the StepFragment

onRequestPermissionsResult

open fun onRequestPermissionsResult( requestCode: Int, permissions: Array<out String>, grantResults: IntArray)

onResume

open fun onResume()

Base Lifecycle onResume method called by the StepFragment

toString

open override fun toString(): String

Properties

backButtonOverride

open val backButtonOverride: () -> Unit? = null

bundle

var bundle: Bundle

Bundle object used to share information between Steps.

contentSectionCls

open val contentSectionCls: KClass<out Section>? = null

coroutineContext

open override val coroutineContext: CoroutineContext

footerSectionCls

open val footerSectionCls: KClass<out Section>? = null

headerSectionCls

open val headerSectionCls: KClass<out Section>? = null

toolbarData

val toolbarData: ToolbarData? = null

Inheritors

SimpleStep