android.databinding

Class ViewDataBinding

java.lang.Object

android.databinding.ViewDataBinding

public abstract class ViewDataBinding
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ViewDataBinding.IncludedLayouts This class is used by generated subclasses of ViewDataBinding to track the included layouts contained in the bound layout.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINDING_TAG_PREFIX Prefix for android:tag on Views with binding.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ViewDataBinding(android.view.View root, int localFieldCount)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOnRebindCallback(OnRebindCallback listener) Add a listener to be called when reevaluating dirty fields.
protected static ViewDataBinding	bind(android.view.View view, int layoutId)
protected abstract void	executeBindings()
void	executePendingBindings() Evaluates the pending bindings, updating any Views that have expressions bound to modified variables.
protected void	finalize()
static int	getBuildSdkInt()
protected java.lang.Object	getObservedField(int localFieldId)
android.view.View	getRoot() Returns the outermost View in the layout file associated with the Binding.
abstract boolean	hasPendingBindings() Returns whether the UI needs to be refresh to represent the current data.
abstract void	invalidateAll() Invalidates all binding expressions and requests a new rebind to refresh UI.
protected static java.lang.Object[]	mapBindings(android.view.View[] roots, int numBindings, ViewDataBinding.IncludedLayouts includes, android.util.SparseIntArray viewsWithIds) Walks the view hierarchy under roots and pulls out tagged Views, includes, and views with IDs into an Object[] that is returned.
protected static java.lang.Object[]	mapBindings(android.view.View root, int numBindings, ViewDataBinding.IncludedLayouts includes, android.util.SparseIntArray viewsWithIds) Walks the view hierarchy under root and pulls out tagged Views, includes, and views with IDs into an Object[] that is returned.
protected abstract boolean	onFieldChange(int localFieldId, java.lang.Object object, int fieldId) Called when an observed object changes.
protected void	registerTo(int localFieldId, java.lang.Object observable, android.databinding.ViewDataBinding.CreateWeakListener listenerCreator)
void	removeOnRebindCallback(OnRebindCallback listener) Removes a listener that was added in addOnRebindCallback(OnRebindCallback).
protected void	requestRebind()
protected void	setRootTag(android.view.View view)
protected void	setRootTag(android.view.View[] views)
abstract boolean	setVariable(int variableId, java.lang.Object value) Set a value value in the Binding class.
void	unbind() Removes binding listeners to expression variables.
protected boolean	unregisterFrom(int localFieldId)
protected boolean	updateRegistration(int localFieldId, Observable observable)
protected boolean	updateRegistration(int localFieldId, ObservableList observable)
protected boolean	updateRegistration(int localFieldId, ObservableMap observable)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BINDING_TAG_PREFIX

public static final java.lang.String BINDING_TAG_PREFIX

Prefix for android:tag on Views with binding. The root View and include tags will not have android:tag attributes and will use ids instead.

See Also:

Constant Field Values

Constructor Detail

ViewDataBinding

protected ViewDataBinding(android.view.View root,
               int localFieldCount)

Method Detail

setRootTag

protected void setRootTag(android.view.View view)

setRootTag

protected void setRootTag(android.view.View[] views)

getBuildSdkInt

public static int getBuildSdkInt()

onFieldChange

protected abstract boolean onFieldChange(int localFieldId,
                    java.lang.Object object,
                    int fieldId)

Called when an observed object changes. Sets the appropriate dirty flag if applicable.

Parameters:

localFieldId - The index into mLocalFieldObservers that this Object resides in.

object - The object that has changed.

fieldId - The BR ID of the field being changed or _all if no specific field is being notified.

Returns:

true if this change should cause a change to the UI.

setVariable

public abstract boolean setVariable(int variableId,
                  java.lang.Object value)

Set a value value in the Binding class.

Typically, the developer will be able to call the subclass's set method directly. For example, if there is a variable x in the Binding, a setX method will be generated. However, there are times when the specific subclass of ViewDataBinding is unknown, so the generated method cannot be discovered without reflection. The setVariable call allows the values of variables to be set without reflection.

Parameters:

variableId - the BR id of the variable to be set. For example, if the variable is x, then variableId will be BR.x.

value - The new value of the variable to be set.

Returns:

true if the variable exists in the binding or false otherwise.

addOnRebindCallback

public void addOnRebindCallback(OnRebindCallback listener)

Add a listener to be called when reevaluating dirty fields. This also allows automatic updates to be halted, but does not stop explicit calls to executePendingBindings().

Parameters:

listener - The listener to add.

removeOnRebindCallback

public void removeOnRebindCallback(OnRebindCallback listener)

Removes a listener that was added in addOnRebindCallback(OnRebindCallback).

Parameters:

listener - The listener to remove.

executePendingBindings

public void executePendingBindings()

Evaluates the pending bindings, updating any Views that have expressions bound to modified variables. This must be run on the UI thread.

executeBindings

protected abstract void executeBindings()

invalidateAll

public abstract void invalidateAll()

Invalidates all binding expressions and requests a new rebind to refresh UI.

hasPendingBindings

public abstract boolean hasPendingBindings()

Returns whether the UI needs to be refresh to represent the current data.

Returns:

true if any field has changed and the binding should be evaluated.

unbind

public void unbind()

Removes binding listeners to expression variables.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getRoot

public android.view.View getRoot()

Returns the outermost View in the layout file associated with the Binding.

Returns:

the outermost View in the layout file associated with the Binding.

unregisterFrom

protected boolean unregisterFrom(int localFieldId)

requestRebind

protected void requestRebind()

getObservedField

protected java.lang.Object getObservedField(int localFieldId)

updateRegistration

protected boolean updateRegistration(int localFieldId,
                         Observable observable)

updateRegistration

protected boolean updateRegistration(int localFieldId,
                         ObservableList observable)

updateRegistration

protected boolean updateRegistration(int localFieldId,
                         ObservableMap observable)

registerTo

protected void registerTo(int localFieldId,
              java.lang.Object observable,
              android.databinding.ViewDataBinding.CreateWeakListener listenerCreator)

bind

protected static ViewDataBinding bind(android.view.View view,
                   int layoutId)

mapBindings

protected static java.lang.Object[] mapBindings(android.view.View root,
                             int numBindings,
                             ViewDataBinding.IncludedLayouts includes,
                             android.util.SparseIntArray viewsWithIds)

Walks the view hierarchy under root and pulls out tagged Views, includes, and views with IDs into an Object[] that is returned. This is used to walk the view hierarchy once to find all bound and ID'd views.

Parameters:

root - The root of the view hierarchy to walk.

numBindings - The total number of ID'd views, views with expressions, and includes

includes - The include layout information, indexed by their container's index.

viewsWithIds - Indexes of views that don't have tags, but have IDs.

Returns:

An array of size numBindings containing all Views in the hierarchy that have IDs (with elements in viewsWithIds), are tagged containing expressions, or the bindings for included layouts.

mapBindings

protected static java.lang.Object[] mapBindings(android.view.View[] roots,
                             int numBindings,
                             ViewDataBinding.IncludedLayouts includes,
                             android.util.SparseIntArray viewsWithIds)

Walks the view hierarchy under roots and pulls out tagged Views, includes, and views with IDs into an Object[] that is returned. This is used to walk the view hierarchy once to find all bound and ID'd views.

Parameters:

roots - The root Views of the view hierarchy to walk. This is used with merge tags.

numBindings - The total number of ID'd views, views with expressions, and includes

includes - The include layout information, indexed by their container's index.

viewsWithIds - Indexes of views that don't have tags, but have IDs.

Returns:

An array of size numBindings containing all Views in the hierarchy that have IDs (with elements in viewsWithIds), are tagged containing expressions, or the bindings for included layouts.