com.facebook.litho.widget

Class BaseRenderInfo

java.lang.Object

com.facebook.litho.widget.BaseRenderInfo

All Implemented Interfaces:

RenderInfo

Direct Known Subclasses:

ComponentRenderInfo, ViewRenderInfo

public abstract class BaseRenderInfo
extends java.lang.Object
implements RenderInfo

Keeps the list item information that will allow the framework to understand how to render it.

SpanSize will be defaulted to 1. It is the information that is required to calculate how much of the SpanCount the component should occupy in a Grid layout.

IsSticky will be defaulted to false. It determines if the component should be a sticky header or not

IsFullSpan will be defaulted to false. It is the information that determines if the component should occupy all of the SpanCount in a StaggeredGrid layout.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRenderInfo(BaseRenderInfo.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	addCustomAttribute(java.lang.String key, java.lang.Object value)
void	addDebugInfo(java.lang.String key, java.lang.Object value)
Component	getComponent()
ComponentsLogger	getComponentsLogger()
java.lang.Object	getCustomAttribute(java.lang.String key)
java.lang.Object	getDebugInfo(java.lang.String key)
java.lang.String	getLogTag()
EventHandler<RenderCompleteEvent>	getRenderCompleteEventHandler()
int	getSpanSize()
ViewBinder	getViewBinder()
ViewCreator	getViewCreator()
int	getViewType()
boolean	hasCustomViewType()
boolean	isFullSpan()
boolean	isSticky()
boolean	rendersComponent()
boolean	rendersView()
void	setViewType(int viewType) Set viewType of current RenderInfo if it was created through ViewRenderInfo.create() and a custom viewType was not set, or otherwise it will throw UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.litho.widget.RenderInfo

getName

Constructor Detail

BaseRenderInfo

protected BaseRenderInfo(BaseRenderInfo.Builder builder)

Method Detail

isSticky

public boolean isSticky()

Specified by:

isSticky in interface RenderInfo

getSpanSize

public int getSpanSize()

Specified by:

getSpanSize in interface RenderInfo

isFullSpan

public boolean isFullSpan()

Specified by:

isFullSpan in interface RenderInfo

getCustomAttribute

public java.lang.Object getCustomAttribute(java.lang.String key)

Specified by:

getCustomAttribute in interface RenderInfo

addCustomAttribute

public void addCustomAttribute(java.lang.String key,
                               java.lang.Object value)

Specified by:

addCustomAttribute in interface RenderInfo

rendersComponent

public boolean rendersComponent()

Specified by:

rendersComponent in interface RenderInfo

Returns:

true, if RenderInfo was created through ComponentRenderInfo.create(), or false otherwise. This should be queried before accessing getComponent() from RenderInfo type.

getComponent

public Component getComponent()

Specified by:

getComponent in interface RenderInfo

Returns:

Valid Component if RenderInfo was created through ComponentRenderInfo.create(), otherwise it will throw UnsupportedOperationException. If this method is accessed from RenderInfo type, rendersComponent() should be queried first before accessing.

getRenderCompleteEventHandler

public EventHandler<RenderCompleteEvent> getRenderCompleteEventHandler()

Specified by:

getRenderCompleteEventHandler in interface RenderInfo

Returns:

Valid EventHandler if RenderInfo was created through ComponentRenderInfo.create(), otherwise it will throw UnsupportedOperationException.

getComponentsLogger

public ComponentsLogger getComponentsLogger()

Specified by:

getComponentsLogger in interface RenderInfo

Returns:

Optional ComponentsLogger if RenderInfo was created through ComponentRenderInfo.create(), null otherwise

getLogTag

public java.lang.String getLogTag()

Specified by:

getLogTag in interface RenderInfo

Returns:

Optional identifier for logging if RenderInfo was created through ComponentRenderInfo.create(), null otherwise

rendersView

public boolean rendersView()

Specified by:

rendersView in interface RenderInfo

Returns:

true, if RenderInfo was created through ViewRenderInfo.create(), or false otherwise. This should be queried before accessing view related methods, such as getViewBinder(), getViewCreator(), getViewType() and setViewType(int) from RenderInfo type.

getViewBinder

public ViewBinder getViewBinder()

Specified by:

getViewBinder in interface RenderInfo

Returns:

Valid ViewBinder if RenderInfo was created through ViewRenderInfo.create(), or otherwise it will throw UnsupportedOperationException. If this method is accessed from RenderInfo type, rendersView() should be queried first before accessing.

getViewCreator

public ViewCreator getViewCreator()

Specified by:

getViewCreator in interface RenderInfo

Returns:

Valid ViewCreator if RenderInfo was created through ViewRenderInfo.create(), or otherwise it will throw UnsupportedOperationException. If this method is accessed from RenderInfo type, rendersView() should be queried first before accessing.

hasCustomViewType

public boolean hasCustomViewType()

Specified by:

hasCustomViewType in interface RenderInfo

Returns:

true, if a custom viewType was set for this RenderInfo and it was created through ViewRenderInfo.create(), or false otherwise.

getViewType

public int getViewType()

Specified by:

getViewType in interface RenderInfo

Returns:

viewType of current RenderInfo if it was created through ViewRenderInfo.create() or otherwise it will throw UnsupportedOperationException. If this method is accessed from RenderInfo type, rendersView() should be queried first before accessing.

addDebugInfo

public void addDebugInfo(java.lang.String key,
                         java.lang.Object value)

Specified by:

addDebugInfo in interface RenderInfo

getDebugInfo

public java.lang.Object getDebugInfo(java.lang.String key)

Specified by:

getDebugInfo in interface RenderInfo

setViewType

public void setViewType(int viewType)

Set viewType of current RenderInfo if it was created through ViewRenderInfo.create() and a custom viewType was not set, or otherwise it will throw UnsupportedOperationException.

Specified by:

setViewType in interface RenderInfo