litho-core/com.facebook.litho/CommonProps

CommonProps

class CommonProps : LayoutProps, Equivalence<CommonProps?>

Internal class that holds props that are common to all Components.

Constructors

CommonProps

constructor()

Types

Companion

object Companion

DefaultLayoutProps

class DefaultLayoutProps : LayoutProps, Equivalence<CommonProps.DefaultLayoutProps?>

Properties

alpha

val alpha: Float?

background

var background: Drawable?

clickHandler

val clickHandler: EventHandler<ClickEvent>?

commonDynamicProps

val commonDynamicProps: SparseArray<DynamicValue<*>>?

componentTag

var componentTag: Any?

contentDescription

val contentDescription: CharSequence?

defStyleAttr

@AttrRes

var defStyleAttr: Int

defStyleRes

@StyleRes

var defStyleRes: Int

focusable

val focusable: Boolean

focusChangeHandler

val focusChangeHandler: EventHandler<FocusChangedEvent>?

interceptTouchHandler

val interceptTouchHandler: EventHandler<InterceptTouchEvent>?

isEnabled

val isEnabled: Boolean

isKeyboardNavigationCluster

val isKeyboardNavigationCluster: Boolean

longClickHandler

val longClickHandler: EventHandler<LongClickEvent>?

mountBinders

val mountBinders: Map<Class<*>, RenderUnit.DelegateBinder<Any, Any, Any>>?

nodeInfo

val nodeInfo: NodeInfo?

paddingFromBackground

var paddingFromBackground: Rect?

screenReaderFocusable

val screenReaderFocusable: Boolean

testKey

val testKey: String?

touchHandler

val touchHandler: EventHandler<TouchEvent>?

viewBinders

val viewBinders: Map<Class<*>, RenderUnit.DelegateBinder<Any, Any, Any>>?

visibility

val visibility: Visibility?

Functions

accessibilityHeading

fun accessibilityHeading(isHeading: Boolean)

accessibilityRole

fun accessibilityRole(role: String?)

accessibilityRoleDescription

fun accessibilityRoleDescription(roleDescription: CharSequence?)

addSystemGestureExclusionZone

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

alignSelf

open override fun alignSelf(alignSelf: YogaAlign)

alpha

fun alpha(alpha: Float)

ambientShadowColor

fun ambientShadowColor(@ColorInt ambientShadowColor: Int)

aspectRatio

open override fun aspectRatio(aspectRatio: Float)

background

fun background(background: Drawable?)

border

fun border(border: Border?)

clickable

fun clickable(isClickable: Boolean)

clickHandler

fun clickHandler(clickHandler: EventHandler<ClickEvent>?)

clipChildren

fun clipChildren(clipChildren: Boolean)

clipToOutline

fun clipToOutline(clipToOutline: Boolean)

componentTag

fun componentTag(componentTag: Any?)

containerTitle

fun containerTitle(containerTitle: CharSequence?)

contentDescription

fun contentDescription(contentDescription: CharSequence?)

copyInto

fun copyInto(c: ComponentContext, node: LithoNode)

copyLayoutProps

fun copyLayoutProps(layoutProps: LayoutProps)

delegateMountViewBinder

fun delegateMountViewBinder(binder: RenderUnit.DelegateBinder<Any, Any, Any>)

dispatchPopulateAccessibilityEventHandler

fun dispatchPopulateAccessibilityEventHandler(dispatchPopulateAccessibilityEventHandler: EventHandler<DispatchPopulateAccessibilityEventEvent>?)

duplicateChildrenStates

fun duplicateChildrenStates(duplicateChildrenStates: Boolean)

duplicateParentState

fun duplicateParentState(duplicateParentState: Boolean)

enabled

fun enabled(isEnabled: Boolean)

flex

open override fun flex(flex: Float)

flexBasisPercent

open override fun flexBasisPercent(percent: Float)

flexBasisPx

open override fun flexBasisPx(@Px flexBasis: Int)

flexGrow

open override fun flexGrow(flexGrow: Float)

flexShrink

open override fun flexShrink(flexShrink: Float)

focusable

fun focusable(isFocusable: Boolean)

focusChangeHandler

fun focusChangeHandler(focusChangeHandler: EventHandler<FocusChangedEvent>?)

focusedHandler

fun focusedHandler(focusedHandler: EventHandler<FocusedVisibleEvent>?)

focusOrder

fun focusOrder(focusOrder: FocusOrderModel)

foreground

fun foreground(foreground: Drawable?)

fullImpressionHandler

fun fullImpressionHandler(fullImpressionHandler: EventHandler<FullImpressionVisibleEvent>?)

gap

open override fun gap(gutter: YogaGutter, length: Int)

getOrCreateDynamicProps

fun getOrCreateDynamicProps(): SparseArray<DynamicValue<*>>

getTransitionKey

fun getTransitionKey(): String?

getTransitionKeyType

fun getTransitionKeyType(): Transition.TransitionKeyType?

hasCommonDynamicProps

fun hasCommonDynamicProps(): Boolean

heightPercent

open override fun heightPercent(percent: Float)

heightPx

open override fun heightPx(@Px height: Int)

importantForAccessibility

fun importantForAccessibility(importantForAccessibility: Int)

interceptTouchHandler

fun interceptTouchHandler(interceptTouchHandler: EventHandler<InterceptTouchEvent>?)

invisibleHandler

fun invisibleHandler(invisibleHandler: EventHandler<InvisibleEvent>?)

isEquivalentTo

open override fun isEquivalentTo(other: CommonProps?): Boolean

isReferenceBaseline

open override fun isReferenceBaseline(isReferenceBaseline: Boolean)

keyboardNavigationCluster

fun keyboardNavigationCluster(isKeyboardNavigationCluster: Boolean)

layerType

fun layerType(type: Int, paint: Paint?)

layoutDirection

open override fun layoutDirection(direction: LayoutDirection)

longClickHandler

fun longClickHandler(longClickHandler: EventHandler<LongClickEvent>?)

marginAuto

open override fun marginAuto(edge: YogaEdge)

marginPercent

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

marginPx

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

maxHeightPercent

open override fun maxHeightPercent(percent: Float)

maxHeightPx

open override fun maxHeightPx(@Px maxHeight: Int)

maxWidthPercent

open override fun maxWidthPercent(percent: Float)

maxWidthPx

open override fun maxWidthPx(@Px maxWidth: Int)

minHeightPercent

open override fun minHeightPercent(percent: Float)

minHeightPx

open override fun minHeightPx(@Px minHeight: Int)

minWidthPercent

open override fun minWidthPercent(percent: Float)

minWidthPx

open override fun minWidthPx(@Px minWidth: Int)

mountBinder

fun mountBinder(binder: RenderUnit.DelegateBinder<Any, Any, Any>)

onInitializeAccessibilityEventHandler

fun onInitializeAccessibilityEventHandler(onInitializeAccessibilityEventHandler: EventHandler<OnInitializeAccessibilityEventEvent>?)

onInitializeAccessibilityNodeInfoHandler

fun onInitializeAccessibilityNodeInfoHandler(onInitializeAccessibilityNodeInfoHandler: EventHandler<OnInitializeAccessibilityNodeInfoEvent>?)

onPerformActionForVirtualViewHandler

fun onPerformActionForVirtualViewHandler(onPerformActionForVirtualViewHandler: EventHandler<PerformActionForVirtualViewEvent>?)

onPopulateAccessibilityEventHandler

fun onPopulateAccessibilityEventHandler(onPopulateAccessibilityEventHandler: EventHandler<OnPopulateAccessibilityEventEvent>?)

onPopulateAccessibilityNodeHandler

fun onPopulateAccessibilityNodeHandler(onPopulateAccessibilityNodeHandler: EventHandler<OnPopulateAccessibilityNodeEvent>?)

onRequestSendAccessibilityEventHandler

fun onRequestSendAccessibilityEventHandler(onRequestSendAccessibilityEventHandler: EventHandler<OnRequestSendAccessibilityEventEvent>?)

onVirtualViewKeyboardFocusChangedHandler

fun onVirtualViewKeyboardFocusChangedHandler(onVirtualViewKeyboardFocusChangedHandler: EventHandler<VirtualViewKeyboardFocusChangedEvent>?)

outlineProvider

fun outlineProvider(outlineProvider: ViewOutlineProvider?)

paddingPercent

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

paddingPx

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

performAccessibilityActionHandler

fun performAccessibilityActionHandler(performAccessibilityActionHandler: EventHandler<PerformAccessibilityActionEvent>?)

positionPercent

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

positionPx

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

positionType

open override fun positionType(positionType: YogaPositionType)

requestInitialAccessibilityFocus

fun requestInitialAccessibilityFocus(requestInitialAccessibilityFocus: Boolean)

rotation

fun rotation(rotation: Float)

rotationX

fun rotationX(rotationX: Float)

rotationY

fun rotationY(rotationY: Float)

scale

fun scale(scale: Float)

screenReaderFocusable

fun screenReaderFocusable(isFocusable: Boolean)

selected

fun selected(isSelected: Boolean)

sendAccessibilityEventHandler

fun sendAccessibilityEventHandler(sendAccessibilityEventHandler: EventHandler<SendAccessibilityEventEvent>?)

sendAccessibilityEventUncheckedHandler

fun sendAccessibilityEventUncheckedHandler(sendAccessibilityEventUncheckedHandler: EventHandler<SendAccessibilityEventUncheckedEvent>?)

setAccessibilityPaneTitle

fun setAccessibilityPaneTitle(accessibilityPaneTitle: CharSequence?)

setBorderWidth

open override fun setBorderWidth(edge: YogaEdge, borderWidth: Float)

Used by DebugLayoutNodeEditor

setLabeledBy

fun setLabeledBy(viewTag: Any?)

setLiveRegion

fun setLiveRegion(mode: Int)

setMinDurationBetweenContentChangesMillis

fun setMinDurationBetweenContentChangesMillis(duration: Long)

setStyle

fun setStyle(@AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int)

setVisibility

fun setVisibility(visibility: Visibility)

shadowElevationPx

fun shadowElevationPx(shadowElevation: Float)

spotShadowColor

fun spotShadowColor(@ColorInt spotShadowColor: Int)

stateDescription

fun stateDescription(stateDescription: CharSequence?)

stateListAnimator

fun stateListAnimator(stateListAnimator: StateListAnimator?)

stateListAnimatorRes

fun stateListAnimatorRes(@DrawableRes resId: Int)

testKey

fun testKey(testKey: String?)

tooltipText

fun tooltipText(tooltipText: String?)

touchExpansionPx

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

touchHandler

fun touchHandler(touchHandler: EventHandler<TouchEvent>?)

transitionKey

fun transitionKey(key: String?, ownerKey: String?)

transitionKeyType

fun transitionKeyType(type: Transition.TransitionKeyType?)

transitionName

fun transitionName(transitionName: String?)

unfocusedHandler

fun unfocusedHandler(unfocusedHandler: EventHandler<UnfocusedVisibleEvent>?)

useHeightAsBaseline

open override fun useHeightAsBaseline(useHeightAsBaseline: Boolean)

viewId

fun viewId(@IdRes id: Int)

viewTag

fun viewTag(viewTag: Any?)

viewTags

fun viewTags(viewTags: SparseArray<Any>?)

visibilityChangedHandler

fun visibilityChangedHandler(visibilityChangedHandler: EventHandler<VisibilityChangedEvent>?)

visibilityOutputTag

fun visibilityOutputTag(visibilityOutputTag: String?)

visibleHandler

fun visibleHandler(visibleHandler: EventHandler<VisibleEvent>?)

visibleHeightRatio

fun visibleHeightRatio(visibleHeightRatio: Float)

visibleWidthRatio

fun visibleWidthRatio(visibleWidthRatio: Float)

widthPercent

open override fun widthPercent(percent: Float)

widthPx

open override fun widthPx(@Px width: Int)

wrapInView

fun wrapInView()