Package com.airbnb.epoxy

Class DataBindingEpoxyModel

java.lang.Object

com.airbnb.epoxy.EpoxyModel<T>

com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

com.airbnb.epoxy.DataBindingEpoxyModel

public abstract class DataBindingEpoxyModel
extends com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

A version of EpoxyModel that can be used with databinding. The layout resource used with this model must be a databinding layout. This class will create the databinding object from the layout and call the setDataBindingVariables(androidx.databinding.ViewDataBinding) methods when the view needs binding to the model.

The easiest way to use this model is to have Epoxy generate a model to do all the binding work for you. To do this, create an abstract subclass of this model, annotate it with EpoxyModelClass, and pass your layout resource as the layout param. (You must pass the layout this way instead of implementing EpoxyModel.getDefaultLayout()).

Then, make a field to represent each of the data variables in your layout and annotate each one with EpoxyAttribute. The name of each field must match the name of the variable in the layout exactly.

Epoxy will generate a subclass of your model at compile time that implements setDataBindingVariables(ViewDataBinding) and setDataBindingVariables(ViewDataBinding, EpoxyModel) for you. This will do all binding for you, and also only bind variables that change if you update your model (Note: The change optimization only works when used with EpoxyController).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataBindingEpoxyModel.DataBindingHolder

Nested classes/interfaces inherited from class com.airbnb.epoxy.EpoxyModel

com.airbnb.epoxy.EpoxyModel.AddPredicate, com.airbnb.epoxy.EpoxyModel.SpanSizeOverrideCallback

Constructor Summary

Constructors

Constructor	Description
DataBindingEpoxyModel()

Method Summary

Modifier and Type	Method	Description
void	bind(DataBindingEpoxyModel.DataBindingHolder holder)
void	bind(DataBindingEpoxyModel.DataBindingHolder holder, com.airbnb.epoxy.EpoxyModel<?> previouslyBoundModel)
void	bind(DataBindingEpoxyModel.DataBindingHolder holder, List<Object> payloads)
View	buildView(ViewGroup parent)
protected DataBindingEpoxyModel.DataBindingHolder	createNewHolder(ViewParent parent)
protected abstract void	setDataBindingVariables(androidx.databinding.ViewDataBinding binding)	This is called when the model is bound to a view, and the view's variables should be updated with the model's data.
protected void	setDataBindingVariables(androidx.databinding.ViewDataBinding dataBinding, com.airbnb.epoxy.EpoxyModel<?> previouslyBoundModel)	Similar to setDataBindingVariables(ViewDataBinding), but this method only binds variables that have changed.
protected void	setDataBindingVariables(androidx.databinding.ViewDataBinding dataBinding, List<Object> payloads)
void	unbind(DataBindingEpoxyModel.DataBindingHolder holder)

Methods inherited from class com.airbnb.epoxy.EpoxyModelWithHolder

onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onVisibilityChanged, onVisibilityStateChanged

Methods inherited from class com.airbnb.epoxy.EpoxyModel

addIf, addIf, addTo, addWithDebugValidation, equals, getDefaultLayout, getLayout, getSpanSize, getViewType, hashCode, hide, id, id, id, id, id, id, id, isShown, layout, onMutation, preBind, reset, shouldSaveViewState, show, show, spanSize, spanSizeOverride, toString, validateStateHasNotChangedSinceAdded

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataBindingEpoxyModel

public DataBindingEpoxyModel()

Method Detail

buildView

public View buildView(@NonNull
                      ViewGroup parent)

Overrides:

buildView in class com.airbnb.epoxy.EpoxyModel<DataBindingEpoxyModel.DataBindingHolder>

bind

public void bind(@NonNull
                 DataBindingEpoxyModel.DataBindingHolder holder)

Overrides:

bind in class com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

bind

public void bind(@NonNull
                 DataBindingEpoxyModel.DataBindingHolder holder,
                 @NonNull
                 com.airbnb.epoxy.EpoxyModel<?> previouslyBoundModel)

Overrides:

bind in class com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

bind

public void bind(@NonNull
                 DataBindingEpoxyModel.DataBindingHolder holder,
                 @NonNull
                 List<Object> payloads)

Overrides:

bind in class com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

setDataBindingVariables

protected abstract void setDataBindingVariables(androidx.databinding.ViewDataBinding binding)

This is called when the model is bound to a view, and the view's variables should be updated with the model's data. ViewDataBinding.executePendingBindings() is called for you after this method is run.

If you leave your class abstract and have a model generated for you via annotations this will be implemented for you. However, you may choose to implement this manually if you like.

setDataBindingVariables

protected void setDataBindingVariables(androidx.databinding.ViewDataBinding dataBinding,
                                       com.airbnb.epoxy.EpoxyModel<?> previouslyBoundModel)

Similar to setDataBindingVariables(ViewDataBinding), but this method only binds variables that have changed. The changed model comes from bind(DataBindingHolder, EpoxyModel). This will only be called if the model is used in an EpoxyController

If you leave your class abstract and have a model generated for you via annotations this will be implemented for you. However, you may choose to implement this manually if you like.

setDataBindingVariables

protected void setDataBindingVariables(androidx.databinding.ViewDataBinding dataBinding,
                                       List<Object> payloads)

unbind

public void unbind(@NonNull
                   DataBindingEpoxyModel.DataBindingHolder holder)

Overrides:

unbind in class com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>

createNewHolder

protected final DataBindingEpoxyModel.DataBindingHolder createNewHolder(@NonNull
                                                                        ViewParent parent)

Specified by:

createNewHolder in class com.airbnb.epoxy.EpoxyModelWithHolder<DataBindingEpoxyModel.DataBindingHolder>