EpoxyModel

abstract class EpoxyModel<T>

Helper to bind data to a view using a builder style. The parameterized type should extend Android's View or EpoxyHolder.

See also

com.airbnb.epoxy.EpoxyModelWithHolder

com.airbnb.epoxy.EpoxyModelWithView

Constructors

EpoxyModel

open fun EpoxyModel()

Types

AddPredicate

interface AddPredicate

#addIf(AddPredicate, EpoxyController)

SpanSizeOverrideCallback

interface SpanSizeOverrideCallback

Functions

addIf

open fun addIf(condition: Boolean, @NonNull() controller: EpoxyController)

Add this model to the given controller if the condition is true.

open fun addIf(@NonNull() predicate: EpoxyModel.AddPredicate, @NonNull() controller: EpoxyController)

Add this model to the given controller if the AddPredicate return true.

addTo

open fun addTo(@NonNull() controller: EpoxyController)

Add this model to the given controller.

bind

open fun bind(@NonNull() view: T)

Binds the current data to the given view.

open fun bind(@NonNull() view: T, @NonNull() previouslyBoundModel: EpoxyModel<out Any>)

Similar to bind, but provides a non null model which was previously bound tothis view.

open fun bind(@NonNull() view: T, @NonNull() payloads: List<Any>)

Similar to bind, but provides a non null, non empty list of payloadsdescribing what changed.

buildView

open fun buildView(@NonNull() parent: ViewGroup): View

Create and return a new instance of a view for this model.

equals

open fun equals(o: Any): Boolean

getSpanSize

open fun getSpanSize(totalSpanCount: Int, position: Int, itemCount: Int): Int

Subclasses can override this if they want their view to take up more than one span in a gridlayout.

hashCode

open fun hashCode(): Int

hide

open fun hide(): EpoxyModel<T>

Change the visibility of the model so that it's view is hidden.

id

open fun id(): Long

open fun id(@Nullable() key: CharSequence): EpoxyModel<T>

Use a string as the model id.

open fun id(@Nullable() ids: Array<Number>): EpoxyModel<T>

Use multiple numbers as the id for this model.

open fun id(id: Long): EpoxyModel<T>

Override the default id in cases where the data subject naturally has an id, like an objectfrom a database.

open fun id(@Nullable() key: CharSequence, @Nullable() otherKeys: Array<CharSequence>): EpoxyModel<T>

Use several strings to define the id of the model.

open fun id(@Nullable() key: CharSequence, id: Long): EpoxyModel<T>

Set an id that is namespaced with a string.

open fun id(id1: Long, id2: Long): EpoxyModel<T>

Use two numbers as the id for this model.

isShown

open fun isShown(): Boolean

Whether the model's view should be shown on screen.

layout

open fun layout(@LayoutRes() layoutRes: Int): EpoxyModel<T>

onFailedToRecycleView

open fun onFailedToRecycleView(@NonNull() view: T): Boolean

Called if the RecyclerView failed to recycle this model's view.

onViewAttachedToWindow

open fun onViewAttachedToWindow(@NonNull() view: T)

Called when this model's view is attached to the window.

onViewDetachedFromWindow

open fun onViewDetachedFromWindow(@NonNull() view: T)

Called when this model's view is detached from the the window.

onVisibilityChanged

open fun onVisibilityChanged(@FloatRange(from = 0.0f, to = 100.0f) percentVisibleHeight: Float, @FloatRange(from = 0.0f, to = 100.0f) percentVisibleWidth: Float, @Px() visibleHeight: Int, @Px() visibleWidth: Int, @NonNull() view: T)

TODO link to the wiki

onVisibilityStateChanged

open fun onVisibilityStateChanged(visibilityState: Int, @NonNull() view: T)

TODO link to the wiki

reset

open fun reset(): EpoxyModel<T>

Sets fields of the model to default ones.

shouldSaveViewState

open fun shouldSaveViewState(): Boolean

Whether the adapter should save the state of the view bound to this model.

show

open fun show(): EpoxyModel<T>

Change the visibility of the model so that it's view is shown.

open fun show(show: Boolean): EpoxyModel<T>

Change the visibility of the model's view.

spanSize

fun spanSize(totalSpanCount: Int, position: Int, itemCount: Int): Int

Returns the actual span size of this model, using the SpanSizeOverrideCallback if onewas set, otherwise using the value from getSpanSize

spanSizeOverride

open fun spanSizeOverride(@Nullable() spanSizeCallback: EpoxyModel.SpanSizeOverrideCallback): EpoxyModel<T>

toString

open fun toString(): String

unbind

open fun unbind(@NonNull() view: T)

Called when the view bound to this model is recycled.

Properties

layout

private open val layout: Int

Inheritors

SimpleEpoxyModel

EpoxyModelWithView

EpoxyModelWithHolder