BindingAdapter

public abstract @interface BindingAdapter
implements Annotation

android.databinding.BindingAdapter

---

BindingAdapter is applied to methods that are used to manipulate how values with expressions are set to views. The simplest example is to have a public static method that takes the view and the value to set:

@BindingAdapter("android:bufferType")
 public static void setBufferType(TextView view, TextView.BufferType bufferType) {
     view.setText(view.getText(), bufferType);
 }

In the above example, when android:bufferType is used on a TextView, the method setBufferType is called.

It is also possible to take previously set values, if the old values are listed first:

@BindingAdapter("android:onLayoutChange")
 public static void setOnLayoutChangeListener(View view, View.OnLayoutChangeListener oldValue,
                                              View.OnLayoutChangeListener newValue) {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
         if (oldValue != null) {
             view.removeOnLayoutChangeListener(oldValue);
         }
         if (newValue != null) {
             view.addOnLayoutChangeListener(newValue);
         }
     }
 }

When a binding adapter may also take multiple attributes, it will only be called when all attributes associated with the binding adapter have binding expressions associated with them. This is useful when there are unusual interactions between attributes. For example:

@BindingAdapter({"android:onClick", "android:clickable"})
 public static void setOnClick(View view, View.OnClickListener clickListener,
                               boolean clickable) {
     view.setOnClickListener(clickListener);
     view.setClickable(clickable);
 }

The order of the parameters must match the order of the attributes in values in the BindingAdapter.

A binding adapter may optionally take a class extending DataBindingComponent as the first parameter as well. If it does, it will be passed the value passed in during binding, either directly in the inflate method or indirectly, using the value from getDefaultComponent().

If a binding adapter is an instance method, the generated DataBindingComponent will have a getter to retrieve an instance of the BindingAdapter's class to use to call the method.

Summary

Inherited methods

From interface java.lang.annotation.Annotation abstract Class<? extends Annotation> annotationType() Returns the annotation type of this annotation. abstract boolean equals(Object obj) Returns true if the specified object represents an annotation that is logically equivalent to this one. abstract int hashCode() Returns the hash code of this annotation, as defined below: The hash code of an annotation is the sum of the hash codes of its members (including those with default values), as defined below: The hash code of an annotation member is (127 times the hash code of the member-name as computed by hashCode()) XOR the hash code of the member-value, as defined below: The hash code of a member-value depends on its type: The hash code of a primitive value v is equal to WrapperType.valueOf(v).hashCode(), where WrapperType is the wrapper type corresponding to the primitive type of v (Byte, Character, Double, Float, Integer, Long, Short, or Boolean). abstract String toString() Returns a string representation of this annotation.