com.facebook.litho.sections.common

Class HideableDataDiffSection<T>

java.lang.Object

com.facebook.litho.sections.SectionLifecycle

com.facebook.litho.sections.Section

com.facebook.litho.sections.common.HideableDataDiffSection<T>

All Implemented Interfaces:

Equivalence<Section>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, Cloneable

public final class HideableDataDiffSection<T>
extends Section

A HideableDataDiffSectionSpec that wraps a DataDiffSectionSpec. It provides the ability to remove an item from the DataDiffSection via the HideItemEvent. This Section emits the following events:

RenderWithHideItemHandlerEvent whenever it needs a Component to render a model T from the list of data. A HideItemEvent handler is a param of this event. Providing an handler for this OnEvent is mandatory.

GetUniqueIdentifierEvent is fired when a single unique identifier is needed for a model object.

See Also:

com.facebook.litho.sections.common.HideableDataDiffSectionSpec

Required Props

data

Type:

java.util.List

getUniqueIdentifierHandler

Type:

com.facebook.litho.EventHandler

renderWithHideItemHandler

Type:

com.facebook.litho.EventHandler

Optional Props

onSameContentEventHandler

Type:

com.facebook.litho.EventHandler

onSameItemEventHandler

Type:

com.facebook.litho.EventHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HideableDataDiffSection.Builder<T>

Method Summary

Modifier and Type	Method and Description
static <T> HideableDataDiffSection.Builder<T>	create(SectionContext context)
protected Children	createChildren(SectionContext c) This methods will delegate to the GroupSectionSpec method annotated with OnCreateChildren
protected void	createInitialState(SectionContext c)
Object	dispatchOnEvent(EventHandler eventHandler, Object eventState)
static EventHandler	getGetUniqueIdentifierEventHandler(SectionContext context)
static EventHandler	getRenderWithHideItemHandlerEventHandler(SectionContext context)
protected StateContainer	getStateContainer()
boolean	isEquivalentTo(Section other) Compares this section to a different one to check if they are the same
HideableDataDiffSection	makeShallowCopy(boolean deepCopy)
protected static void	onBlacklistUpdate(SectionContext c, Object modelObject, EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)
protected static void	onBlacklistUpdateAsync(SectionContext c, Object modelObject, EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)
protected static void	onBlacklistUpdateSync(SectionContext c, Object modelObject, EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)
static EventHandler<HideItemEvent>	onHideItem(SectionContext c)
static EventHandler<RenderEvent>	onRenderEvent(SectionContext c)
protected void	transferState(StateContainer _prevStateContainer, StateContainer _nextStateContainer) Call this to transfer the State annotated values between two Section with the same global scope.

Methods inherited from class com.facebook.litho.sections.Section

generateUniqueGlobalKeyForChild, getChildren, getEventDispatcher, getGlobalKey, getHandle, getKey, getLogTag, getParent, getScopedContext, getSimpleName, makeShallowCopy, recordEventTrigger, setChildren, setCount, setGlobalKey, setKey, setScopedContext

Methods inherited from class com.facebook.litho.sections.SectionLifecycle

acceptTriggerEvent, bindService, createService, dataBound, dataRendered, dispatchLoadingEvent, generateChangeSet, getEventTrigger, getEventTrigger, getLoadingEventHandler, getService, getTreePropsForChildren, isDiffSectionSpec, isSectionIndexValid, newEventHandler, newEventHandler, newEventTrigger, populateTreeProps, refresh, requestFocus, requestFocus, requestFocus, requestFocusWithOffset, requestFocusWithOffset, requestFocusWithOffset, requestSmoothFocus, requestSmoothFocus, requestSmoothFocus, shouldUpdate, transferService, unbindService, viewportChanged

Methods inherited from class java.lang.Object

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

Method Detail

getStateContainer

protected StateContainer getStateContainer()

Overrides:

getStateContainer in class Section

isEquivalentTo

public boolean isEquivalentTo(Section other)

Description copied from class: Section

Compares this section to a different one to check if they are the same

This is used to be able to skip rendering a section again. We avoid using the Object.equals(Object) so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.

Specified by:

isEquivalentTo in interface Equivalence<Section>

Overrides:

isEquivalentTo in class Section

Parameters:

other - the component to compare to

Returns:

true if the components are of the same type and have the same props

makeShallowCopy

public HideableDataDiffSection makeShallowCopy(boolean deepCopy)

Overrides:

makeShallowCopy in class Section

Returns:

a clone of this Section. if deepCopy is false the clone won't contain any children or count as it will be returned in a pre - ChangeSet generation state.

create

public static <T> HideableDataDiffSection.Builder<T> create(SectionContext context)

transferState

protected void transferState(StateContainer _prevStateContainer,
                             StateContainer _nextStateContainer)

Description copied from class: SectionLifecycle

Call this to transfer the State annotated values between two Section with the same global scope.

Overrides:

transferState in class SectionLifecycle

onBlacklistUpdate

protected static void onBlacklistUpdate(SectionContext c,
                                        Object modelObject,
                                        EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)

onBlacklistUpdateAsync

protected static void onBlacklistUpdateAsync(SectionContext c,
                                             Object modelObject,
                                             EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)

onBlacklistUpdateSync

protected static void onBlacklistUpdateSync(SectionContext c,
                                            Object modelObject,
                                            EventHandler<GetUniqueIdentifierEvent> getUniqueIdentifierHandlerParam)

getRenderWithHideItemHandlerEventHandler

public static EventHandler getRenderWithHideItemHandlerEventHandler(SectionContext context)

getGetUniqueIdentifierEventHandler

public static EventHandler getGetUniqueIdentifierEventHandler(SectionContext context)

onRenderEvent

public static EventHandler<RenderEvent> onRenderEvent(SectionContext c)

onHideItem

public static EventHandler<HideItemEvent> onHideItem(SectionContext c)

dispatchOnEvent

public Object dispatchOnEvent(EventHandler eventHandler,
                              Object eventState)

Specified by:

dispatchOnEvent in interface EventDispatcher

Overrides:

dispatchOnEvent in class SectionLifecycle

createInitialState

protected void createInitialState(SectionContext c)

Overrides:

createInitialState in class SectionLifecycle

createChildren

protected Children createChildren(SectionContext c)

Description copied from class: SectionLifecycle

This methods will delegate to the GroupSectionSpec method annotated with OnCreateChildren

Overrides:

createChildren in class SectionLifecycle