com.facebook.litho.dataflow

Class GraphBinding

java.lang.Object

com.facebook.litho.dataflow.GraphBinding

public final class GraphBinding
extends Object

Defines the relationship of a set of input values to a set of output values where the values from the input nodes 'flow into' the output nodes. For example, input values could be a touch X/Y or a layout value, and output values could be the X/Y position of a View or its opacity. Input and output values can be connected to each other via intermediate operators like springs or timing.

NB: ValueNodes can be referenced by multiple GraphBindings (e.g. a view property).

Method Summary

Modifier and Type	Method and Description
void	activate() Activates a binding, adding the sub-graph defined by this binding to the main DataFlowGraph associated with this binding.
void	addBinding(ValueNode fromNode, ValueNode toNode)
void	addBinding(ValueNode fromNode, ValueNode toNode, String name) Adds a connection between two nodes to this graph.
static GraphBinding	create() Creates a GraphBinding associated with the default DataFlowGraph instance.
static GraphBinding	create(DataFlowGraph dataFlowGraph)
void	deactivate() Deactivates this binding which, as you might guess, is the reverse of activating it: the sub-graph associated with this binding is removed from the main DataFlowGraph.
boolean	isActive()
void	setListener(BindingListener listener) Sets the BindingListener.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GraphBinding create()

Creates a GraphBinding associated with the default DataFlowGraph instance.

create

public static GraphBinding create(DataFlowGraph dataFlowGraph)

addBinding

public void addBinding(ValueNode fromNode,
                       ValueNode toNode,
                       String name)

Adds a connection between two nodes to this graph. The connection will not be actualized until activate() is called, and will be removed once deactivate() is called.

addBinding

public void addBinding(ValueNode fromNode,
                       ValueNode toNode)

activate

public void activate()

Activates a binding, adding the sub-graph defined by this binding to the main DataFlowGraph associated with this binding. This is expected to be called from framework code and should not be called by the end developer.

deactivate

public void deactivate()

Deactivates this binding which, as you might guess, is the reverse of activating it: the sub-graph associated with this binding is removed from the main DataFlowGraph. As with activate(), this is expected to only be called by framework code and not the end developer.

isActive

public boolean isActive()

Returns:

whether this binding has been activated and not yet deactivated.

setListener

public void setListener(BindingListener listener)

Sets the BindingListener.