com.facebook.rendercore.extensions

Class MountExtension<Input,State>

java.lang.Object

com.facebook.rendercore.extensions.MountExtension<Input,State>

Direct Known Subclasses:

DynamicPropsExtension, EndToEndTestingExtension, IncrementalMountExtension, LithoViewAttributesExtension, NestedLithoViewsExtension, TransitionsExtension, VisibilityMountExtension

public abstract class MountExtension<Input,State>
extends java.lang.Object

Mount extension which can be registered by a MountState as an extension which can override mounting behaviour. MountState will rely on the extensions registered on the MountDelegate to decide what to mount or unmount. If no extensions are registered on the MountState's delegate, it falls back to its default behaviour.

Constructor Summary

Constructors

Constructor and Description
MountExtension()

Method Summary

Modifier and Type	Method and Description
void	afterMount(ExtensionState<State> extensionState) Called immediately after mounting.
void	beforeMount(ExtensionState<State> extensionState, Input input, Rect localVisibleRect) Called for setting up input on the extension before mounting.
void	beforeMountItem(ExtensionState<State> extensionState, RenderTreeNode renderTreeNode, int index)
boolean	canPreventMount()
ExtensionState<State>	createExtensionState(MountDelegate mountDelegate)
protected abstract State	createState()
protected static java.lang.Object	getContentAt(ExtensionState<?> extensionState, int position)
protected static java.lang.Object	getContentById(ExtensionState<?> extensionState, long id)
static MountDelegateTarget	getMountTarget(ExtensionState<?> extensionState)
protected static boolean	isLockedForMount(ExtensionState<?> extensionState, RenderTreeNode renderTreeNode)
protected static boolean	isLockedForMount(ExtensionState extensionState, long id)
protected static boolean	isRootItem(long id)
void	onBindItem(ExtensionState<State> extensionState, RenderUnit<?> renderUnit, java.lang.Object content, java.lang.Object layoutData) Called after an item is bound, after it gets mounted or updated.
void	onBoundsAppliedToItem(ExtensionState<State> extensionState, RenderUnit<?> renderUnit, java.lang.Object content, java.lang.Object layoutData)
void	onMountItem(ExtensionState<State> extensionState, RenderUnit<?> renderUnit, java.lang.Object content, java.lang.Object layoutData) Called after an item is mounted.
void	onUnbind(ExtensionState<State> extensionState) Called after all the Host's children have been unbound.
void	onUnbindItem(ExtensionState<State> extensionState, RenderUnit<?> renderUnit, java.lang.Object content, java.lang.Object layoutData) Called after an item is unbound.
void	onUnmount(ExtensionState<State> extensionState) Called after all the Host's children have been unmounted.
void	onUnmountItem(ExtensionState<State> extensionState, RenderUnit<?> renderUnit, java.lang.Object content, java.lang.Object layoutData) Called after an item is unmounted.
void	onVisibleBoundsChanged(ExtensionState<State> extensionState, Rect localVisibleRect) Called when the visible bounds of the Host change.
boolean	shouldUpdateItem(RenderUnit<?> previousRenderUnit, java.lang.Object previousLayoutData, RenderUnit<?> nextRenderUnit, java.lang.Object nextLayoutData) Called when an item is already mounted.

Methods inherited from class java.lang.Object

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

Constructor Detail

MountExtension

public MountExtension()

Method Detail

createExtensionState

public final ExtensionState<State> createExtensionState(MountDelegate mountDelegate)

createState

protected abstract State createState()

canPreventMount

public boolean canPreventMount()

beforeMount

public void beforeMount(ExtensionState<State> extensionState,
                        Input input,
                        Rect localVisibleRect)

Called for setting up input on the extension before mounting.

Parameters:

extensionState - The inner state of this extension when beforeMount is called.

input - The new input the extension should use.

beforeMountItem

public void beforeMountItem(ExtensionState<State> extensionState,
                            RenderTreeNode renderTreeNode,
                            int index)

afterMount

public void afterMount(ExtensionState<State> extensionState)

Called immediately after mounting.

onVisibleBoundsChanged

public void onVisibleBoundsChanged(ExtensionState<State> extensionState,
                                   Rect localVisibleRect)

Called when the visible bounds of the Host change.

onUnmount

public void onUnmount(ExtensionState<State> extensionState)

Called after all the Host's children have been unmounted.

onUnbind

public void onUnbind(ExtensionState<State> extensionState)

Called after all the Host's children have been unbound.

shouldUpdateItem

public boolean shouldUpdateItem(RenderUnit<?> previousRenderUnit,
                                java.lang.Object previousLayoutData,
                                RenderUnit<?> nextRenderUnit,
                                java.lang.Object nextLayoutData)

Called when an item is already mounted. If true, the old item will be unbound and the new item will be rebound

onBindItem

public void onBindItem(ExtensionState<State> extensionState,
                       RenderUnit<?> renderUnit,
                       java.lang.Object content,
                       java.lang.Object layoutData)

Called after an item is bound, after it gets mounted or updated.

onUnbindItem

public void onUnbindItem(ExtensionState<State> extensionState,
                         RenderUnit<?> renderUnit,
                         java.lang.Object content,
                         java.lang.Object layoutData)

Called after an item is unbound.

onUnmountItem

public void onUnmountItem(ExtensionState<State> extensionState,
                          RenderUnit<?> renderUnit,
                          java.lang.Object content,
                          java.lang.Object layoutData)

Called after an item is unmounted.

onMountItem

public void onMountItem(ExtensionState<State> extensionState,
                        RenderUnit<?> renderUnit,
                        java.lang.Object content,
                        java.lang.Object layoutData)

Called after an item is mounted.

onBoundsAppliedToItem

public void onBoundsAppliedToItem(ExtensionState<State> extensionState,
                                  RenderUnit<?> renderUnit,
                                  java.lang.Object content,
                                  java.lang.Object layoutData)

getMountTarget

public static MountDelegateTarget getMountTarget(ExtensionState<?> extensionState)

isRootItem

protected static boolean isRootItem(long id)

getContentAt

protected static java.lang.Object getContentAt(ExtensionState<?> extensionState,
                                               int position)

getContentById

protected static java.lang.Object getContentById(ExtensionState<?> extensionState,
                                                 long id)

isLockedForMount

protected static boolean isLockedForMount(ExtensionState<?> extensionState,
                                          RenderTreeNode renderTreeNode)

isLockedForMount

protected static boolean isLockedForMount(ExtensionState extensionState,
                                          long id)