public
abstract
class
ViewDataBinding
extends BaseObservable
| java.lang.Object | ||
| ↳ | android.databinding.BaseObservable | |
| ↳ | android.databinding.ViewDataBinding | |
Base class for generated data binding classes. If possible, the generated binding should
be instantiated using one of its generated static bind or inflate methods. If the specific
binding is unknown, bind(View) or
inflate(LayoutInflater, int, ViewGroup, boolean) should be used.
Public methods | |
|---|---|
void
|
addOnRebindCallback(OnRebindCallback listener)
Add a listener to be called when reevaluating dirty fields. |
void
|
executePendingBindings()
Evaluates the pending bindings, updating any Views that have expressions bound to modified variables. |
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. |
void
|
removeOnRebindCallback(OnRebindCallback listener)
Removes a listener that was added in |
abstract
boolean
|
setVariable(int variableId, Object value)
Set a value value in the Binding class. |
void
|
unbind()
Removes binding listeners to expression variables. |
Protected methods | |
|---|---|
void
|
finalize()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Inherited methods | |
|---|---|
 From
class
android.databinding.BaseObservable
| |
From
class
java.lang.Object
| |
From
interface
android.databinding.Observable
| |
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 |
OnRebindCallback:
The listener to add.
|
void executePendingBindings ()
Evaluates the pending bindings, updating any Views that have expressions bound to modified variables. This must be run on the UI thread.
View getRoot ()
Returns the outermost View in the layout file associated with the Binding. If this binding is for a merge layout file, this will return the first root in the merge tag.
| Returns | |
|---|---|
View |
the outermost View in the layout file associated with the Binding. |
boolean hasPendingBindings ()
Returns whether the UI needs to be refresh to represent the current data.
| Returns | |
|---|---|
boolean |
true if any field has changed and the binding should be evaluated. |
void invalidateAll ()
Invalidates all binding expressions and requests a new rebind to refresh UI.
void removeOnRebindCallback (OnRebindCallback listener)
Removes a listener that was added in addOnRebindCallback(OnRebindCallback).
| Parameters | |
|---|---|
listener |
OnRebindCallback:
The listener to remove.
|
Developers
boolean setVariable (int variableId,
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 |
int:
the BR id of the variable to be set. For example, if the variable is
x, then variableId will be BR.x. |
value |
Object:
The new value of the variable to be set. |
| Returns | |
|---|---|
boolean |
true if the variable is declared or used in the binding or
false otherwise.
|
void unbind ()
Removes binding listeners to expression variables.
void finalize ()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the finalize method to dispose of
system resources or to perform other cleanup.
The general contract of finalize is that it is invoked
if and when the JavaTM virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The finalize method may take any action, including
making this object available again to other threads; the usual purpose
of finalize, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.
The finalize method of class Object performs no
special action; it simply returns normally. Subclasses of
Object may override this definition.
The Java programming language does not guarantee which thread will
invoke the finalize method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.
After the finalize method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.
The finalize method is never invoked more than once by a Java
virtual machine for any given object.
Any exception thrown by the finalize method causes
the finalization of this object to be halted, but is otherwise
ignored.
| Throws | |
|---|---|
Throwable |
|