DataBindingUtil - Android SDK

Summary: Methods | Inherited Methods | [Expand All]

public class

DataBindingUtil

extends Object

java.lang.Object
↳	android.databinding.DataBindingUtil

Class Overview

Utility class to create ViewDataBinding from layouts.

Summary

Public Methods
static <T extends ViewDataBinding> T	bind(View root) Returns the binding for the given layout root or creates a binding if one does not exist.
static <T extends ViewDataBinding> T	bind(View root, DataBindingComponent bindingComponent) Returns the binding for the given layout root or creates a binding if one does not exist.
static String	convertBrIdToString(int id) Converts the given BR id to its string representation which might be useful for logging purposes.
static <T extends ViewDataBinding> T	findBinding(View view) Retrieves the binding responsible for the given View.
static <T extends ViewDataBinding> T	getBinding(View view) Retrieves the binding responsible for the given View layout root.
static DataBindingComponent	getDefaultComponent() Returns the default `DataBindingComponent` used in data binding.
static <T extends ViewDataBinding> T	inflate(LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent) Inflates a binding layout and returns the newly-created binding for that layout.
static <T extends ViewDataBinding> T	inflate(LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent, DataBindingComponent bindingComponent) Inflates a binding layout and returns the newly-created binding for that layout.
static <T extends ViewDataBinding> T	setContentView(Activity activity, int layoutId) Set the Activity's content view to the given layout and return the associated binding.
static <T extends ViewDataBinding> T	setContentView(Activity activity, int layoutId, DataBindingComponent bindingComponent) Set the Activity's content view to the given layout and return the associated binding.
static void	setDefaultComponent(DataBindingComponent bindingComponent) Set the default `DataBindingComponent` to use for data binding.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public static T bind (View root)

Returns the binding for the given layout root or creates a binding if one does not exist. This uses the DataBindingComponent set in setDefaultComponent(DataBindingComponent).

Prefer using the generated Binding's bind method to ensure type-safe inflation when it is known that root has not yet been bound.

Parameters

root	The root View of the inflated binding layout.

Returns

A ViewDataBinding for the given root View. If one already exists, the existing one will be returned.

Throws

IllegalArgumentException	when root is not from an inflated binding layout.

public static T bind (View root, DataBindingComponent bindingComponent)

Returns the binding for the given layout root or creates a binding if one does not exist.

Prefer using the generated Binding's bind method to ensure type-safe inflation when it is known that root has not yet been bound.

Parameters

root	The root View of the inflated binding layout.
bindingComponent	The DataBindingComponent to use in data binding.

Returns

A ViewDataBinding for the given root View. If one already exists, the existing one will be returned.

Throws

IllegalArgumentException	when root is not from an inflated binding layout.

public static String convertBrIdToString (int id)

Converts the given BR id to its string representation which might be useful for logging purposes.

Parameters

id	The integer id, which should be a field from BR class.

Returns

The name if the BR id or null if id is out of bounds.

public static T findBinding (View view)

Retrieves the binding responsible for the given View. If view is not a binding layout root, its parents will be searched for the binding. If there is no binding, null will be returned.

This differs from getBinding(View) in that findBinding takes any view in the layout and searches for the binding associated with the root. getBinding takes only the root view.

Parameters

view	A `View` in the bound layout.

Returns

The ViewDataBinding associated with the given view or null if view is not part of a bound layout.

public static T getBinding (View view)

Retrieves the binding responsible for the given View layout root. If there is no binding, null will be returned. This uses the DataBindingComponent set in setDefaultComponent(DataBindingComponent).

Parameters

view	The root `View` in the layout with binding.

Returns

The ViewDataBinding associated with the given view or null if either the view is not a root View for a layout or view hasn't been bound.

public static DataBindingComponent getDefaultComponent ()

Returns the default DataBindingComponent used in data binding. This can be null if no default was set in setDefaultComponent(DataBindingComponent).

Returns

the default DataBindingComponent used in data binding. This can be null if no default was set in setDefaultComponent(DataBindingComponent).

public static T inflate (LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent)

Inflates a binding layout and returns the newly-created binding for that layout. This uses the DataBindingComponent set in setDefaultComponent(DataBindingComponent).

Use this version only if layoutId is unknown in advance. Otherwise, use the generated Binding's inflate method to ensure type-safe inflation.

Parameters

inflater	The LayoutInflater used to inflate the binding layout.
layoutId	The layout resource ID of the layout to inflate.
parent	Optional view to be the parent of the generated hierarchy (if attachToParent is true), or else simply an object that provides a set of LayoutParams values for root of the returned hierarchy (if attachToParent is false.)
attachToParent	Whether the inflated hierarchy should be attached to the parent parameter. If false, parent is only used to create the correct subclass of LayoutParams for the root view in the XML.

Returns

The newly-created binding for the inflated layout or null if the layoutId wasn't for a binding layout.

Throws

InflateException	When a merge layout was used and attachToParent was false.

public static T inflate (LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent, DataBindingComponent bindingComponent)

Inflates a binding layout and returns the newly-created binding for that layout.

Use this version only if layoutId is unknown in advance. Otherwise, use the generated Binding's inflate method to ensure type-safe inflation.

Parameters

inflater	The LayoutInflater used to inflate the binding layout.
layoutId	The layout resource ID of the layout to inflate.
parent	Optional view to be the parent of the generated hierarchy (if attachToParent is true), or else simply an object that provides a set of LayoutParams values for root of the returned hierarchy (if attachToParent is false.)
attachToParent	Whether the inflated hierarchy should be attached to the parent parameter. If false, parent is only used to create the correct subclass of LayoutParams for the root view in the XML.
bindingComponent	The DataBindingComponent to use in the binding.

Returns

The newly-created binding for the inflated layout or null if the layoutId wasn't for a binding layout.

Throws

InflateException	When a merge layout was used and attachToParent was false.

public static T setContentView (Activity activity, int layoutId)

Set the Activity's content view to the given layout and return the associated binding. The given layout resource must not be a merge layout.

Parameters

activity	The Activity whose content View should change.
layoutId	The resource ID of the layout to be inflated, bound, and set as the Activity's content.

Returns

The binding associated with the inflated content view.

public static T setContentView (Activity activity, int layoutId, DataBindingComponent bindingComponent)

Set the Activity's content view to the given layout and return the associated binding. The given layout resource must not be a merge layout.

Parameters

activity	The Activity whose content View should change.
layoutId	The resource ID of the layout to be inflated, bound, and set as the Activity's content.
bindingComponent	The DataBindingComponent to use in data binding.

Returns

The binding associated with the inflated content view.

public static void setDefaultComponent (DataBindingComponent bindingComponent)

Set the default DataBindingComponent to use for data binding.

bindingComponent may be passed as the first parameter of binding adapters.

When instance method BindingAdapters are used, the class instance for the binding adapter is retrieved from the DataBindingComponent.

Results

Annotations

Interfaces

Classes

DataBindingUtil

Class Overview

Summary

Public Methods

public static T bind (View root)

Parameters

Returns

Throws

See Also

public static T bind (View root, DataBindingComponent bindingComponent)

Parameters

Returns

Throws

See Also

public static String convertBrIdToString (int id)

Parameters

Returns

public static T findBinding (View view)

Parameters

Returns

public static T getBinding (View view)

Parameters

Returns

public static DataBindingComponent getDefaultComponent ()

Returns

public static T inflate (LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent)

Parameters

Returns

Throws

See Also

public static T inflate (LayoutInflater inflater, int layoutId, ViewGroup parent, boolean attachToParent, DataBindingComponent bindingComponent)

Parameters

Returns

Throws

public static T setContentView (Activity activity, int layoutId)

Parameters

Returns

public static T setContentView (Activity activity, int layoutId, DataBindingComponent bindingComponent)

Parameters

Returns

public static void setDefaultComponent (DataBindingComponent bindingComponent)