Typed4EpoxyController

abstract class Typed4EpoxyController<T, U, V, W> : EpoxyController

This is a wrapper around com.airbnb.epoxy.EpoxyController to simplify how data is accessed. Use this if the data required to build your models is represented by four objects.

To use this, create a subclass typed with your data object. Then, call setData whenever that data changes. This class will handle calling buildModels with the latest data.

You should NOT call requestModelBuild directly.

Constructors

Typed4EpoxyController

open fun Typed4EpoxyController()

Typed4EpoxyController

open fun Typed4EpoxyController(modelBuildingHandler: Handler, diffingHandler: Handler)

Functions

add

open fun add(@NonNull() model: EpoxyModel<out Any>)

Add the model to this controller.

abstract fun add(model: Null)

addInterceptor

open fun addInterceptor(@NonNull() interceptor: EpoxyController.Interceptor)

Add an interceptor callback to be run after models are built, to make any last changes beforethey are set on the adapter.

addModelBuildListener

open fun addModelBuildListener(listener: OnModelBuildFinishedListener)

Add a listener that will be called every time buildModels has finished runningand changes have been dispatched to the RecyclerView.

cancelPendingModelBuild

open fun cancelPendingModelBuild()

Cancels a pending call to buildModels if one has been queued by .

getAdapter

@NonNull()

open fun getAdapter(): EpoxyControllerAdapter

Get the underlying adapter built by this controller.

getSpanCount

open fun getSpanCount(): Int

getSpanSizeLookup

@NonNull()

open fun getSpanSizeLookup(): GridLayoutManager.SpanSizeLookup

For use with a grid layout manager - use this to get the SpanSizeLookup for models inthis controller.

hasPendingModelBuild

open fun hasPendingModelBuild(): Boolean

Whether an update to models is currently pending.

isDebugLoggingEnabled

open fun isDebugLoggingEnabled(): Boolean

isDuplicateFilteringEnabled

open fun isDuplicateFilteringEnabled(): Boolean

isMultiSpan

open fun isMultiSpan(): Boolean

isStickyHeader

abstract fun isStickyHeader(position: Int): Boolean

open fun isStickyHeader(position: Int): Boolean

Called to check if the item at the position is a sticky item,by default returns false.The sub-classes should override the function if they areusing sticky header feature.

moveModel

open fun moveModel(fromPosition: Int, toPosition: Int)

An optimized way to move a model from one position to another without rebuilding all models.

notifyModelChanged

open fun notifyModelChanged(position: Int)

An way to notify the adapter that a model has changed.

onRestoreInstanceState

open fun onRestoreInstanceState(@Nullable() inState: Bundle)

onSaveInstanceState

open fun onSaveInstanceState(@NonNull() outState: Bundle)

removeInterceptor

open fun removeInterceptor(@NonNull() interceptor: EpoxyController.Interceptor)

Remove an interceptor that was added with addInterceptor.

removeModelBuildListener

open fun removeModelBuildListener(listener: OnModelBuildFinishedListener)

Remove a listener added with addModelBuildListener.

requestDelayedModelBuild

open fun requestDelayedModelBuild(delayMs: Int)

Call this to request a delayed model update.

requestModelBuild

fun requestModelBuild()

Call this to request a model update.

setData

open fun setData(data1: T, data2: U, data3: V, data4: W)

Call this with the latest data when you want models to be rebuilt.

setDebugLoggingEnabled

open fun setDebugLoggingEnabled(enabled: Boolean)

If enabled, DEBUG logcat messages will be printed to show when models are rebuilt, the timetaken to build them, the time taken to diff them, and the item change outcomes from thediffer.

setFilterDuplicates

open fun setFilterDuplicates(filterDuplicates: Boolean)

If set to true, Epoxy will search for models with duplicate ids added during and remove any duplicates found.

setGlobalDebugLoggingEnabled

open fun setGlobalDebugLoggingEnabled(globalDebugLoggingEnabled: Boolean)

Similar to setDebugLoggingEnabled, but this changes the global default forall EpoxyControllers.

setGlobalDuplicateFilteringDefault

open fun setGlobalDuplicateFilteringDefault(filterDuplicatesByDefault: Boolean)

setFilterDuplicates is disabled in each EpoxyController by default.

setGlobalExceptionHandler

open fun setGlobalExceptionHandler(@NonNull() globalExceptionHandler: EpoxyController.ExceptionHandler)

Set a callback to be notified when a recoverable exception occurs at runtime.

setSpanCount

open fun setSpanCount(spanCount: Int)

If you are using a grid layout manager you must call this to set the span count of the grid.This span count will be passed on to the models so models can choose which span count to be.

setupStickyHeaderView

open fun setupStickyHeaderView(stickyHeader: View)

open fun setupStickyHeaderView(@NotNull() stickyHeader: View)

Optional callback to setup the sticky view,by default it doesn't do anything.The sub-classes should override the function if they areusing sticky header feature.

teardownStickyHeaderView

open fun teardownStickyHeaderView(stickyHeader: View)

open fun teardownStickyHeaderView(@NotNull() stickyHeader: View)

Optional callback to perform tear down operation on thesticky view, by default it doesn't do anything.The sub-classes should override the function if they areusing sticky header feature.

Typed4EpoxyController

See also

Constructors

Functions