com.facebook.rendercore

Class RenderUnit<MOUNT_CONTENT>

java.lang.Object

com.facebook.rendercore.RenderUnit<MOUNT_CONTENT>

Direct Known Subclasses:

HostRenderUnit, LithoRenderUnit, Mountable

public abstract class RenderUnit<MOUNT_CONTENT>
extends java.lang.Object

A RenderUnit represents a single rendering primitive for RenderCore. Every RenderUnit has to define at least a createContent method to allocate the RenderUnit content (View or Drawable) via the ContentAllocator it returns from getContentAllocator method. That content will be automatically recycled by RenderCore based on their concrete type.

A RenderUnit should in most cases declare how it intends to bind data returning Binders from its mountUnmountFunctions callback or from the attachDetachFunctions callback.

Immutability: RenderUnits should be immutable! Continuing to change them after they are built and given to RenderCore (e.g. via RenderState) is not safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RenderUnit.Binder<MODEL,CONTENT> Represents a single bind function.
static class	RenderUnit.DelegateBinder<MODEL,CONTENT> A binder is a pair of data Model and RenderUnit.Binder.
static class	RenderUnit.RenderType

Constructor Summary

Constructors

Constructor and Description
RenderUnit(RenderUnit.RenderType renderType)
RenderUnit(RenderUnit.RenderType renderType, java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> mountBinders)
RenderUnit(RenderUnit.RenderType type, java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> mountBinders, java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> attachBinders)

Method Summary

Modifier and Type	Method and Description
void	addAttachBinder(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT> binder) Adds an RenderUnit.DelegateBinder that will be invoked with the other attach/detach binders.
void	addAttachBinders(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>... binders) Adds an RenderUnit.DelegateBinders that will be invoked with the other attach/detach binders.
void	addMountBinder(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT> binder) Adds an RenderUnit.DelegateBinder that will be invoked with the other mount/unmount binders.
void	addMountBinders(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>... binders) Adds RenderUnit.DelegateBinders that will be invoked with the other mount/unmount binders.
protected void	attachBinders(Context context, MOUNT_CONTENT content, java.lang.Object layoutData, Systracer tracer) Bind all attachDetach binder functions.
protected void	detachBinders(Context context, MOUNT_CONTENT content, java.lang.Object layoutData, Systracer tracer) Unbind all attachDetach binder functions.
boolean	doesMountRenderTreeHosts() Override this method to indicate if a RenderUnit has nested RenderTreeHosts, it will ensure that they are notified when this RenderUnit's bounds change and visibility events are processed correctly for them.
protected java.util.List<RenderUnit.DelegateBinder<?,MOUNT_CONTENT>>	getAttachBinders()
protected java.util.Map<java.lang.Class<?>,RenderUnit.DelegateBinder<?,MOUNT_CONTENT>>	getAttachBinderTypeToDelegateMap()
abstract ContentAllocator<MOUNT_CONTENT>	getContentAllocator()
java.lang.String	getDescription()
abstract long	getId()
protected java.util.List<RenderUnit.DelegateBinder<?,MOUNT_CONTENT>>	getMountBinders()
protected java.util.Map<java.lang.Class<?>,RenderUnit.DelegateBinder<?,MOUNT_CONTENT>>	getMountBinderTypeToDelegateMap()
java.lang.Class<?>	getRenderContentType()
RenderUnit.RenderType	getRenderType()
protected void	mountBinders(Context context, MOUNT_CONTENT content, java.lang.Object layoutData, Systracer tracer) Bind all mountUnmount binder functions.
protected void	onEndUpdateRenderUnit()
protected void	onStartUpdateRenderUnit()
protected void	unmountBinders(Context context, MOUNT_CONTENT content, java.lang.Object layoutData, Systracer tracer) Unbind all mountUnmount binder functions.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderUnit

public RenderUnit(RenderUnit.RenderType renderType)

RenderUnit

public RenderUnit(RenderUnit.RenderType renderType,
                  java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> mountBinders)

RenderUnit

public RenderUnit(RenderUnit.RenderType type,
                  java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> mountBinders,
                  java.util.List<RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>> attachBinders)

Method Detail

getRenderType

public RenderUnit.RenderType getRenderType()

getContentAllocator

public abstract ContentAllocator<MOUNT_CONTENT> getContentAllocator()

getId

public abstract long getId()

Returns:

a unique id identifying this RenderUnit in the tree of Node it is part of.

getMountBinderTypeToDelegateMap

protected java.util.Map<java.lang.Class<?>,RenderUnit.DelegateBinder<?,MOUNT_CONTENT>> getMountBinderTypeToDelegateMap()

getMountBinders

protected java.util.List<RenderUnit.DelegateBinder<?,MOUNT_CONTENT>> getMountBinders()

getAttachBinderTypeToDelegateMap

protected java.util.Map<java.lang.Class<?>,RenderUnit.DelegateBinder<?,MOUNT_CONTENT>> getAttachBinderTypeToDelegateMap()

getAttachBinders

protected java.util.List<RenderUnit.DelegateBinder<?,MOUNT_CONTENT>> getAttachBinders()

getRenderContentType

public java.lang.Class<?> getRenderContentType()

onStartUpdateRenderUnit

protected void onStartUpdateRenderUnit()

onEndUpdateRenderUnit

protected void onEndUpdateRenderUnit()

getDescription

public java.lang.String getDescription()

addMountBinder

public void addMountBinder(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT> binder)

Adds an RenderUnit.DelegateBinder that will be invoked with the other mount/unmount binders. Can be used to add generic functionality (e.g. accessibility) to a RenderUnit.

NB: This method should only be called while initially configuring the RenderUnit. See the class-level javadocs about immutability.

addMountBinders

@SafeVarargs
public final void addMountBinders(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>... binders)

Adds RenderUnit.DelegateBinders that will be invoked with the other mount/unmount binders. Can be used to add generic functionality (e.g. accessibility) to a RenderUnit.

NB: This method should only be called while initially configuring the RenderUnit. See the class-level javadocs about immutability.

addAttachBinder

public void addAttachBinder(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT> binder)

Adds an RenderUnit.DelegateBinder that will be invoked with the other attach/detach binders. Can be used to add generic functionality (e.g. Dynamic Props) to a RenderUnit

NB: This method should only be called while initially configuring the RenderUnit. See the class-level javadocs about immutability.

addAttachBinders

@SafeVarargs
public final void addAttachBinders(RenderUnit.DelegateBinder<?,? super MOUNT_CONTENT>... binders)

Adds an RenderUnit.DelegateBinders that will be invoked with the other attach/detach binders. Can be used to add generic functionality (e.g. Dynamic Props) to a RenderUnit

NB: This method should only be called while initially configuring the RenderUnit. See the class-level javadocs about immutability.

doesMountRenderTreeHosts

public boolean doesMountRenderTreeHosts()

Override this method to indicate if a RenderUnit has nested RenderTreeHosts, it will ensure that they are notified when this RenderUnit's bounds change and visibility events are processed correctly for them.

Returns:

true to ensure nested RenderTreeHosts are notified about parent's bounds change, otherwise false

mountBinders

protected void mountBinders(Context context,
                            MOUNT_CONTENT content,
                            java.lang.Object layoutData,
                            Systracer tracer)

Bind all mountUnmount binder functions.

unmountBinders

protected void unmountBinders(Context context,
                              MOUNT_CONTENT content,
                              java.lang.Object layoutData,
                              Systracer tracer)

Unbind all mountUnmount binder functions.

attachBinders

protected void attachBinders(Context context,
                             MOUNT_CONTENT content,
                             java.lang.Object layoutData,
                             Systracer tracer)

Bind all attachDetach binder functions.

detachBinders

protected void detachBinders(Context context,
                             MOUNT_CONTENT content,
                             java.lang.Object layoutData,
                             Systracer tracer)

Unbind all attachDetach binder functions.