litho-core/com.facebook.litho/Component/Builder

Builder

abstract class Builder<T : Component.Builder<T>?>

Parameters

<T>

the type of this builder. Required to ensure methods defined here in the abstract class correctly return the type of the concrete subclass.

Inheritors

ContainerBuilder

Functions

accessibilityHeading

open fun accessibilityHeading(isHeading: Boolean): T

Ports setAccessibilityHeading into components world.

accessibilityRole

open fun accessibilityRole(@Nullable role: String): T

accessibilityRoleDescription

open fun accessibilityRoleDescription(@StringRes stringId: Int): T

open fun accessibilityRoleDescription(@Nullable roleDescription: CharSequence): T

open fun accessibilityRoleDescription(@StringRes stringId: Int, formatArgs: Array<Any>): T

addSystemGestureExclusionZone

open fun addSystemGestureExclusionZone(exclusion: (Rect) -> Rect): T

open fun alignSelf(alignSelf: YogaAlign): T

Controls how a child aligns in the cross direction, overriding the alignItems of the parent.

open fun alpha(value: DynamicValue<Float>): T

Links a DynamicValue object ot the alpha value for this Component

open fun alpha(alpha: Float): T

Sets the alpha (opacity) of this component.

open fun aspectRatio(aspectRatio: Float): T

Defined as the ratio between the width and the height of a node.

open fun background(@Nullable background: Drawable): T

Set the background of this component.

open fun backgroundAttr(@AttrRes resId: Int): T

open fun backgroundAttr(@AttrRes resId: Int, @DrawableRes defaultResId: Int): T

backgroundColor

open fun backgroundColor(@Nullable value: DynamicValue<Integer>): T

Links a DynamicValue object to the background color value for this Component

open fun backgroundColor(@ColorInt backgroundColor: Int): T

backgroundDynamicDrawable

open fun backgroundDynamicDrawable(value: DynamicValue<out Drawable>): T

Links a DynamicValue object to the background drawable for this Component

open fun backgroundRes(@DrawableRes resId: Int): T

open fun border(@Nullable border: Border): T

abstract fun build(): Component

open fun clickable(isClickable: Boolean): T

open fun clickHandler(@Nullable clickHandler: EventHandler<ClickEvent>): T

open fun clipChildren(clipChildren: Boolean): T

Ports setClipChildren into components world.

open fun clipToOutline(clipToOutline: Boolean): T

open fun componentTag(@Nullable componentTag: Any): T

contentDescription

open fun contentDescription(@StringRes stringId: Int): T

open fun contentDescription(@Nullable contentDescription: CharSequence): T

open fun contentDescription(@StringRes stringId: Int, formatArgs: Array<Any>): T

dispatchPopulateAccessibilityEventHandler

open fun dispatchPopulateAccessibilityEventHandler(@Nullable dispatchPopulateAccessibilityEventHandler: EventHandler<DispatchPopulateAccessibilityEventEvent>): T

duplicateChildrenStates

open fun duplicateChildrenStates(duplicateChildrenStates: Boolean): T

If true, component applies all of its children's drawable states (focused, pressed, etc.) to itself.

duplicateParentState

open fun duplicateParentState(duplicateParentState: Boolean): T

If true, component duplicates its drawable state (focused, pressed, etc.) from the direct parent.

open fun enabled(isEnabled: Boolean): T

open fun flex(flex: Float): T

Sets flexGrow, flexShrink, and flexBasis at the same time.

open fun flexBasisDip(@Dimension(unit = 0) flexBasis: Float): T

flexBasisPercent

open fun flexBasisPercent(percent: Float): T

open fun flexBasisPx(@Px flexBasis: Int): T

The FlexBasis property is an axis-independent way of providing the default size of an item on the main axis.

open fun flexGrow(flexGrow: Float): T

If the sum of childrens' main axis dimensions is less than the minimum size, how much should this component grow?

open fun flexShrink(flexShrink: Float): T

The FlexShrink property describes how to shrink children along the main axis in the case that the total size of the children overflow the size of the container on the main axis.

open fun focusable(isFocusable: Boolean): T

focusChangeHandler

open fun focusChangeHandler(@Nullable focusChangeHandler: EventHandler<FocusChangedEvent>): T

open fun focusedHandler(@Nullable focusedHandler: EventHandler<FocusedVisibleEvent>): T

open fun foreground(@Nullable foreground: Drawable): T

Set the foreground of this component.

open fun foregroundAttr(@AttrRes resId: Int): T

open fun foregroundAttr(@AttrRes resId: Int, @DrawableRes defaultResId: Int): T

foregroundColor

open fun foregroundColor(value: DynamicValue<Integer>): T

open fun foregroundColor(@ColorInt foregroundColor: Int): T

open fun foregroundRes(@DrawableRes resId: Int): T

fullImpressionHandler

open fun fullImpressionHandler(@Nullable fullImpressionHandler: EventHandler<FullImpressionVisibleEvent>): T

open fun getContext(): ComponentContext

abstract fun getThis(): T

open fun handle(@Nullable handle: Handle): T

hasBackgroundSet

open fun ~~hasBackgroundSet~~(): Boolean

hasClickHandlerSet

open fun hasClickHandlerSet(): Boolean

open fun heightAttr(@AttrRes resId: Int): T

open fun heightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun heightDip(@Dimension(unit = 0) height: Float): T

open fun heightPercent(percent: Float): T

Sets the height of the Component to be a percentage of its parent's height.

open fun heightPx(@Px height: Int): T

Specifies the height of the element's content area.

open fun heightRes(@DimenRes resId: Int): T

importantForAccessibility

open fun importantForAccessibility(importantForAccessibility: Int): T

interceptTouchHandler

open fun interceptTouchHandler(@Nullable interceptTouchHandler: EventHandler<InterceptTouchEvent>): T

invisibleHandler

open fun invisibleHandler(@Nullable invisibleHandler: EventHandler<InvisibleEvent>): T

isReferenceBaseline

open fun isReferenceBaseline(isReferenceBaseline: Boolean): T

open fun key(@Nullable key: String): T

Set a key on the component that is local to its parent.

keyboardNavigationCluster

open fun keyboardNavigationCluster(isKeyboardNavigationCluster: Boolean): T

fun <T : Component.Builder<T>> Component.Builder<T>.kotlinStyle(style: Style?): T

Backwards compatibility for a Kotlin Component to accept a Style and apply it to a Java Spec Component. Using this builder method is the equivalent of setting all common props the Style defines.

open fun layerType(type: Int, @Nullable paint: Paint): T

layoutDirection

open fun layoutDirection(direction: YogaDirection): T

The RTL/LTR direction of components and text.

longClickHandler

open fun longClickHandler(@Nullable longClickHandler: EventHandler<LongClickEvent>): T

open fun marginAttr(edge: YogaEdge, @AttrRes resId: Int): T

open fun marginAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun marginAuto(edge: YogaEdge): T

open fun marginDip(edge: YogaEdge, @Dimension(unit = 0) margin: Float): T

open fun marginPercent(edge: YogaEdge, percent: Float): T

open fun marginPx(edge: YogaEdge, @Px margin: Int): T

Effects the spacing around the outside of a node.

open fun marginRes(edge: YogaEdge, @DimenRes resId: Int): T

open fun maxHeightAttr(@AttrRes resId: Int): T

open fun maxHeightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun maxHeightDip(@Dimension(unit = 0) maxHeight: Float): T

maxHeightPercent

open fun maxHeightPercent(percent: Float): T

open fun maxHeightPx(@Px maxHeight: Int): T

open fun maxHeightRes(@DimenRes resId: Int): T

open fun maxWidthAttr(@AttrRes resId: Int): T

open fun maxWidthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun maxWidthDip(@Dimension(unit = 0) maxWidth: Float): T

maxWidthPercent

open fun maxWidthPercent(percent: Float): T

open fun maxWidthPx(@Px maxWidth: Int): T

open fun maxWidthRes(@DimenRes resId: Int): T

open fun minHeightAttr(@AttrRes resId: Int): T

open fun minHeightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun minHeightDip(@Dimension(unit = 0) minHeight: Float): T

minHeightPercent

open fun minHeightPercent(percent: Float): T

open fun minHeightPx(@Px minHeight: Int): T

open fun minHeightRes(@DimenRes resId: Int): T

open fun minWidthAttr(@AttrRes resId: Int): T

open fun minWidthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun minWidthDip(@Dimension(unit = 0) minWidth: Float): T

minWidthPercent

open fun minWidthPercent(percent: Float): T

open fun minWidthPx(@Px minWidth: Int): T

This property has higher priority than all other properties and will always be respected.

open fun minWidthRes(@DimenRes resId: Int): T

onInitializeAccessibilityEventHandler

open fun onInitializeAccessibilityEventHandler(@Nullable onInitializeAccessibilityEventHandler: EventHandler<OnInitializeAccessibilityEventEvent>): T

onInitializeAccessibilityNodeInfoHandler

open fun onInitializeAccessibilityNodeInfoHandler(@Nullable onInitializeAccessibilityNodeInfoHandler: EventHandler<OnInitializeAccessibilityNodeInfoEvent>): T

onPerformActionForVirtualViewHandler

open fun onPerformActionForVirtualViewHandler(@Nullable onPerformActionForVirtualViewHandler: EventHandler<PerformActionForVirtualViewEvent>): T

onPopulateAccessibilityEventHandler

open fun onPopulateAccessibilityEventHandler(@Nullable onPopulateAccessibilityEventHandler: EventHandler<OnPopulateAccessibilityEventEvent>): T

onRequestSendAccessibilityEventHandler

open fun onRequestSendAccessibilityEventHandler(@Nullable onRequestSendAccessibilityEventHandler: EventHandler<OnRequestSendAccessibilityEventEvent>): T

onVirtualViewKeyboardFocusChangedHandler

open fun onVirtualViewKeyboardFocusChangedHandler(@Nullable onVirtualViewKeyboardFocusChangedHandler: EventHandler<VirtualViewKeyboardFocusChangedEvent>): T

outlineProvider

open fun outlineProvider(@Nullable outlineProvider: ViewOutlineProvider): T

open fun paddingAttr(edge: YogaEdge, @AttrRes resId: Int): T

open fun paddingAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun paddingDip(edge: YogaEdge, @Dimension(unit = 0) padding: Float): T

open fun paddingPercent(edge: YogaEdge, percent: Float): T

open fun paddingPx(edge: YogaEdge, @Px padding: Int): T

Affects the size of the node it is applied to.

open fun paddingRes(edge: YogaEdge, @DimenRes resId: Int): T

performAccessibilityActionHandler

open fun performAccessibilityActionHandler(@Nullable performAccessibilityActionHandler: EventHandler<PerformAccessibilityActionEvent>): T

open fun positionAttr(edge: YogaEdge, @AttrRes resId: Int): T

open fun positionAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun positionDip(edge: YogaEdge, @Dimension(unit = 0) position: Float): T

positionPercent

open fun positionPercent(edge: YogaEdge, percent: Float): T

open fun positionPx(edge: YogaEdge, @Px position: Int): T

When used in combination with positionType of ABSOLUTE, allows the component to specify how it should be positioned within its parent.

open fun positionRes(edge: YogaEdge, @DimenRes resId: Int): T

open fun positionType(positionType: YogaPositionType): T

Controls how this component will be positioned within its parent.

open fun rotation(@Nullable rotation: DynamicValue<Float>): T

Links a DynamicValue object to the rotation value for this Component

open fun rotation(rotation: Float): T

Sets the degree that this component is rotated around the pivot point.

open fun rotationX(@Nullable rotationX: DynamicValue<Float>): T

Links a DynamicValue object to the rotationX value for this Component

open fun rotationX(rotationX: Float): T

Sets the degree that this component is rotated around the horizontal axis through the pivot point.

open fun rotationY(@Nullable rotationY: DynamicValue<Float>): T

Links a DynamicValue object to the rotationY value for this Component

open fun rotationY(rotationY: Float): T

Sets the degree that this component is rotated around the vertical axis through the pivot point.

open fun scale(scale: Float): T

Sets the scale (scaleX and scaleY) on this component.

open fun scaleX(value: DynamicValue<Float>): T

Links a DynamicValue object to the scaleX value for this Component

open fun scaleY(value: DynamicValue<Float>): T

Links a DynamicValue object to the scaleY value for this Component

screenReaderFocusable

open fun screenReaderFocusable(isFocusable: Boolean): T

open fun selected(isSelected: Boolean): T

sendAccessibilityEventHandler

open fun sendAccessibilityEventHandler(@Nullable sendAccessibilityEventHandler: EventHandler<SendAccessibilityEventEvent>): T

sendAccessibilityEventUncheckedHandler

open fun sendAccessibilityEventUncheckedHandler(@Nullable sendAccessibilityEventUncheckedHandler: EventHandler<SendAccessibilityEventUncheckedEvent>): T

shadowElevation

open fun shadowElevation(value: DynamicValue<Float>): T

Links a DynamicValue object to the elevation value for this Component

shadowElevationAttr

open fun shadowElevationAttr(@AttrRes resId: Int): T

open fun shadowElevationAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

shadowElevationDip

open fun shadowElevationDip(@Dimension(unit = 0) shadowElevation: Float): T

shadowElevationPx

open fun shadowElevationPx(shadowElevation: Float): T

shadowElevationRes

open fun shadowElevationRes(@DimenRes resId: Int): T

stateListAnimator

open fun stateListAnimator(@Nullable stateListAnimator: StateListAnimator): T

Ports setStateListAnimator into components world.

stateListAnimatorRes

open fun stateListAnimatorRes(@DrawableRes resId: Int): T

Ports setStateListAnimator into components world.

open fun testKey(@Nullable testKey: String): T

open fun tooltipText(@Nullable tooltipText: String): T

touchExpansionAttr

open fun touchExpansionAttr(edge: YogaEdge, @AttrRes resId: Int): T

open fun touchExpansionAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): T

touchExpansionDip

open fun touchExpansionDip(edge: YogaEdge, @Dimension(unit = 0) touchExpansion: Float): T

touchExpansionPx

open fun touchExpansionPx(edge: YogaEdge, @Px touchExpansion: Int): T

touchExpansionRes

open fun touchExpansionRes(edge: YogaEdge, @DimenRes resId: Int): T

open fun touchHandler(@Nullable touchHandler: EventHandler<TouchEvent>): T

open fun transitionKey(@Nullable key: String): T

transitionKeyType

open fun transitionKeyType(type: Transition.TransitionKeyType): T

open fun transitionName(@Nullable transitionName: String): T

open fun translationX(value: DynamicValue<Float>): T

Links a DynamicValue object to the translationX value for this Component

open fun translationY(value: DynamicValue<Float>): T

Links a DynamicValue object to the translationY value for this Component

open fun translationZ(value: DynamicValue<Float>): T

Links a DynamicValue object to the translationZ value for this Component

unfocusedHandler

open fun unfocusedHandler(@Nullable unfocusedHandler: EventHandler<UnfocusedVisibleEvent>): T

useHeightAsBaseline

open fun useHeightAsBaseline(useHeightAsBaseline: Boolean): T

When set to true, overrides the default behaviour of baseline calculation and uses height of component as baseline.

open fun viewId(id: Int): T

open fun viewTag(@Nullable viewTag: Any): T

open fun viewTags(@Nullable viewTags: SparseArray<Any>): T

visibilityChangedHandler

open fun visibilityChangedHandler(@Nullable visibilityChangedHandler: EventHandler<VisibilityChangedEvent>): T

visibilityOutputTag

open fun ~~visibilityOutputTag~~(@Nullable visibilityOutputTag: String): T

open fun visibleHandler(@Nullable visibleHandler: EventHandler<VisibleEvent>): T

visibleHeightRatio

open fun visibleHeightRatio(visibleHeightRatio: Float): T

visibleWidthRatio

open fun visibleWidthRatio(visibleWidthRatio: Float): T

open fun widthAttr(@AttrRes resId: Int): T

open fun widthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): T

open fun widthDip(@Dimension(unit = 0) width: Float): T

open fun widthPercent(percent: Float): T

Sets the width of the Component to be a percentage of its parent's width.

open fun widthPx(@Px width: Int): T

Specifies the width of the element's content area.

open fun widthRes(@DimenRes resId: Int): T

open fun wrapInView(): T