com.facebook.rendercore.visibility

Class VisibilityOutput

java.lang.Object

com.facebook.rendercore.visibility.VisibilityOutput

public class VisibilityOutput
extends Object

Stores information about a node which has registered visibility handlers for. The information is passed to the visibility extension which then dispatches the appropriate events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VisibilityOutput.Factory<R extends Node.LayoutResult<?>> The factory that client frameworks must implement to enable VisibilityExtension to create a VisibilityOutput for every visited Node.LayoutResult during the layout pass.

Constructor Summary

Constructors

Constructor and Description
VisibilityOutput(String id, String key, Rect bounds, float visibleHeightRatio, float visibleWidthRatio, Function<Void> visibleEventHandler, Function<Void> focusedEventHandler, Function<Void> unfocusedEventHandler, Function<Void> fullImpressionEventHandler, Function<Void> invisibleEventHandler, Function<Void> visibilityChangedEventHandler)

Method Summary

Modifier and Type	Method and Description
Rect	getBounds()
int	getComponentArea()
float	getFocusedBottom()
Function<Void>	getFocusedEventHandler()
float	getFocusedLeft()
float	getFocusedRight()
float	getFocusedTop()
float	getFullImpressionBottom()
Function<Void>	getFullImpressionEventHandler()
float	getFullImpressionLeft()
float	getFullImpressionRight()
float	getFullImpressionTop()
String	getId() An identifier unique to this visibility output.
Function<Void>	getInvisibleEventHandler()
String	getKey() A pretty name of this visibility output; does not need to be unique.
Function<Void>	getUnfocusedEventHandler()
float	getVisibilityBottom()
Function<Void>	getVisibilityChangedEventHandler()
float	getVisibilityLeft()
float	getVisibilityRight()
float	getVisibilityTop()
Function<Void>	getVisibleEventHandler()
float	getVisibleHeightRatio()
float	getVisibleWidthRatio()
void	setFocusedRatio(float focusedRatio)

Methods inherited from class java.lang.Object

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

Constructor Detail

VisibilityOutput

public VisibilityOutput(String id,
                        String key,
                        Rect bounds,
                        float visibleHeightRatio,
                        float visibleWidthRatio,
                        Function<Void> visibleEventHandler,
                        Function<Void> focusedEventHandler,
                        Function<Void> unfocusedEventHandler,
                        Function<Void> fullImpressionEventHandler,
                        Function<Void> invisibleEventHandler,
                        Function<Void> visibilityChangedEventHandler)

Method Detail

getId

public String getId()

An identifier unique to this visibility output. This needs to be unique for every output in a given RenderTree.

getKey

public String getKey()

A pretty name of this visibility output; does not need to be unique.

getBounds

public Rect getBounds()

getVisibilityTop

public float getVisibilityTop()

getVisibilityBottom

public float getVisibilityBottom()

getVisibilityLeft

public float getVisibilityLeft()

getVisibilityRight

public float getVisibilityRight()

getFullImpressionTop

public float getFullImpressionTop()

getFullImpressionBottom

public float getFullImpressionBottom()

getFullImpressionLeft

public float getFullImpressionLeft()

getFullImpressionRight

public float getFullImpressionRight()

getFocusedTop

public float getFocusedTop()

getFocusedBottom

public float getFocusedBottom()

getFocusedLeft

public float getFocusedLeft()

getFocusedRight

public float getFocusedRight()

getComponentArea

public int getComponentArea()

getVisibleHeightRatio

public float getVisibleHeightRatio()

getVisibleWidthRatio

public float getVisibleWidthRatio()

setFocusedRatio

public void setFocusedRatio(float focusedRatio)

getVisibleEventHandler

public Function<Void> getVisibleEventHandler()

getFocusedEventHandler

public Function<Void> getFocusedEventHandler()

getUnfocusedEventHandler

public Function<Void> getUnfocusedEventHandler()

getFullImpressionEventHandler

public Function<Void> getFullImpressionEventHandler()

getInvisibleEventHandler

public Function<Void> getInvisibleEventHandler()

getVisibilityChangedEventHandler

public Function<Void> getVisibilityChangedEventHandler()