com.facebook.litho

Class Component.Builder<T extends Component.Builder<T>>

java.lang.Object

com.facebook.litho.Component.Builder<T>

Type 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.

Direct Known Subclasses:

Button.Builder, Card.Builder, CardClip.Builder, CardShadow.Builder, Component.ContainerBuilder, EditText.Builder, HorizontalScroll.Builder, Image.Builder, Progress.Builder, Recycler.Builder, RecyclerCollectionComponent.Builder, SizeSpecMountWrapperComponent.Builder, SolidColor.Builder, Spinner.Builder, TestDrawableComponent.Builder, TestLayoutComponent.Builder, TestSizeDependentComponent.Builder, TestTransitionComponent.Builder, TestViewComponent.Builder, Text.Builder, TextInput.Builder, TouchableFeedback.Builder, TransparencyEnabledCard.Builder, TransparencyEnabledCardClip.Builder, VerticalScroll.Builder, ViewCompatComponent.Builder, ViewPagerComponent.Builder, Wrapper.Builder

Enclosing class:

Component

public abstract static class Component.Builder<T extends Component.Builder<T>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceResolver	mResourceResolver

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(ComponentContext c, int defStyleAttr, int defStyleRes, Component component)

Method Summary

Modifier and Type	Method and Description
T	accessibilityHeading(boolean isHeading) Ports androidx.core.view.ViewCompat#setAccessibilityHeading into components world.
T	accessibilityRole(java.lang.String role)
T	accessibilityRoleDescription(java.lang.CharSequence roleDescription)
T	accessibilityRoleDescription(int stringId)
T	accessibilityRoleDescription(int stringId, java.lang.Object... formatArgs)
T	alignSelf(YogaAlign alignSelf) Controls how a child aligns in the cross direction, overriding the alignItems of the parent.
T	alpha(DynamicValue<java.lang.Float> value) Links a DynamicValue object ot the alpha value for this Component
T	alpha(float alpha) Sets the alpha (opacity) of this component.
T	aspectRatio(float aspectRatio) Defined as the ratio between the width and the height of a node.
T	background(Drawable background) Set the background of this component.
T	backgroundAttr(int resId)
T	backgroundAttr(int resId, int defaultResId)
T	backgroundColor(DynamicValue<java.lang.Integer> value) Links a DynamicValue object to the background color value for this Component
T	backgroundColor(int backgroundColor)
T	backgroundDynamicDrawable(DynamicValue<? extends Drawable> value) Links a DynamicValue object to the background drawable for this Component
T	backgroundRes(int resId)
T	border(Border border)
abstract Component	build()
protected static void	checkArgs(int requiredPropsCount, java.util.BitSet required, java.lang.String[] requiredPropsNames) Checks that all the required props are supplied, and if not throws a useful exception
T	clickable(boolean isClickable)
T	clickHandler(EventHandler<ClickEvent> clickHandler)
T	clipChildren(boolean clipChildren) Ports android.view.ViewGroup#setClipChildren(boolean) into components world.
T	clipToOutline(boolean clipToOutline)
T	componentTag(java.lang.Object componentTag)
T	contentDescription(java.lang.CharSequence contentDescription)
T	contentDescription(int stringId)
T	contentDescription(int stringId, java.lang.Object... formatArgs)
T	dispatchPopulateAccessibilityEventHandler(EventHandler<DispatchPopulateAccessibilityEventEvent> dispatchPopulateAccessibilityEventHandler)
T	duplicateChildrenStates(boolean duplicateChildrenStates) If true, component applies all of its children's drawable states (focused, pressed, etc.) to itself.
T	duplicateParentState(boolean duplicateParentState) If true, component duplicates its drawable state (focused, pressed, etc.) from the direct parent.
T	enabled(boolean isEnabled)
T	flex(float flex) Sets flexGrow, flexShrink, and flexBasis at the same time.
T	flexBasisAttr(int resId)
T	flexBasisAttr(int resId, int defaultResId)
T	flexBasisDip(float flexBasis)
T	flexBasisPercent(float percent)
T	flexBasisPx(int flexBasis) The FlexBasis property is an axis-independent way of providing the default size of an item on the main axis.
T	flexBasisRes(int resId)
T	flexGrow(float flexGrow) If the sum of childrens' main axis dimensions is less than the minimum size, how much should this component grow? This value represents the "flex grow factor" and determines how much this component should grow along the main axis in relation to any other flexible children.
T	flexShrink(float flexShrink) 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.
T	focusable(boolean isFocusable)
T	focusChangeHandler(EventHandler<FocusChangedEvent> focusChangeHandler)
T	focusedHandler(EventHandler<FocusedVisibleEvent> focusedHandler)
T	foreground(Drawable foreground) Set the foreground of this component.
T	foregroundAttr(int resId)
T	foregroundAttr(int resId, int defaultResId)
T	foregroundColor(DynamicValue<java.lang.Integer> value)
T	foregroundColor(int foregroundColor)
T	foregroundRes(int resId)
T	fullImpressionHandler(EventHandler<FullImpressionVisibleEvent> fullImpressionHandler)
ComponentContext	getContext()
abstract T	getThis()
T	handle(Handle handle)
boolean	hasBackgroundSet() Deprecated.
boolean	hasClickHandlerSet()
T	heightAttr(int resId)
T	heightAttr(int resId, int defaultResId)
T	heightDip(float height)
T	heightPercent(float percent) Sets the height of the Component to be a percentage of its parent's height.
T	heightPx(int height) Specifies the height of the element's content area.
T	heightRes(int resId)
T	importantForAccessibility(int importantForAccessibility)
T	interceptTouchHandler(EventHandler<InterceptTouchEvent> interceptTouchHandler)
T	invisibleHandler(EventHandler<InvisibleEvent> invisibleHandler)
T	isReferenceBaseline(boolean isReferenceBaseline)
T	key(java.lang.String key) Set a key on the component that is local to its parent.
T	layerType(int type, Paint paint)
T	layoutDirection(YogaDirection layoutDirection) The RTL/LTR direction of components and text.
T	longClickHandler(EventHandler<LongClickEvent> longClickHandler)
T	marginAttr(YogaEdge edge, int resId)
T	marginAttr(YogaEdge edge, int resId, int defaultResId)
T	marginAuto(YogaEdge edge)
T	marginDip(YogaEdge edge, float margin)
T	marginPercent(YogaEdge edge, float percent)
T	marginPx(YogaEdge edge, int margin) Effects the spacing around the outside of a node.
T	marginRes(YogaEdge edge, int resId)
T	maxHeightAttr(int resId)
T	maxHeightAttr(int resId, int defaultResId)
T	maxHeightDip(float maxHeight)
T	maxHeightPercent(float percent)
T	maxHeightPx(int maxHeight)
T	maxHeightRes(int resId)
T	maxWidthAttr(int resId)
T	maxWidthAttr(int resId, int defaultResId)
T	maxWidthDip(float maxWidth)
T	maxWidthPercent(float percent)
T	maxWidthPx(int maxWidth)
T	maxWidthRes(int resId)
<K,V> T	metadata(K key, V value) Links a DynamicValue object to a Key for this Component
T	minHeightAttr(int resId)
T	minHeightAttr(int resId, int defaultResId)
T	minHeightDip(float minHeight)
T	minHeightPercent(float percent)
T	minHeightPx(int minHeight)
T	minHeightRes(int resId)
T	minWidthAttr(int resId)
T	minWidthAttr(int resId, int defaultResId)
T	minWidthDip(float minWidth)
T	minWidthPercent(float percent)
T	minWidthPx(int minWidth) This property has higher priority than all other properties and will always be respected.
T	minWidthRes(int resId)
T	onInitializeAccessibilityEventHandler(EventHandler<OnInitializeAccessibilityEventEvent> onInitializeAccessibilityEventHandler)
T	onInitializeAccessibilityNodeInfoHandler(EventHandler<OnInitializeAccessibilityNodeInfoEvent> onInitializeAccessibilityNodeInfoHandler)
T	onPopulateAccessibilityEventHandler(EventHandler<OnPopulateAccessibilityEventEvent> onPopulateAccessibilityEventHandler)
T	onRequestSendAccessibilityEventHandler(EventHandler<OnRequestSendAccessibilityEventEvent> onRequestSendAccessibilityEventHandler)
T	outlineProvider(ViewOutlineProvider outlineProvider)
T	paddingAttr(YogaEdge edge, int resId)
T	paddingAttr(YogaEdge edge, int resId, int defaultResId)
T	paddingDip(YogaEdge edge, float padding)
T	paddingPercent(YogaEdge edge, float percent)
T	paddingPx(YogaEdge edge, int padding) Affects the size of the node it is applied to.
T	paddingRes(YogaEdge edge, int resId)
T	performAccessibilityActionHandler(EventHandler<PerformAccessibilityActionEvent> performAccessibilityActionHandler)
T	positionAttr(YogaEdge edge, int resId)
T	positionAttr(YogaEdge edge, int resId, int defaultResId)
T	positionDip(YogaEdge edge, float position)
T	positionPercent(YogaEdge edge, float percent)
T	positionPx(YogaEdge edge, int position) When used in combination with positionType(com.facebook.yoga.YogaPositionType) of YogaPositionType.ABSOLUTE, allows the component to specify how it should be positioned within its parent.
T	positionRes(YogaEdge edge, int resId)
T	positionType(YogaPositionType positionType) Controls how this component will be positioned within its parent.
T	rotation(DynamicValue<java.lang.Float> rotation) Links a DynamicValue object to the rotation value for this Component
T	rotation(float rotation) Sets the degree that this component is rotated around the pivot point.
T	rotationX(float rotationX) Sets the degree that this component is rotated around the horizontal axis through the pivot point.
T	rotationY(float rotationY) Sets the degree that this component is rotated around the vertical axis through the pivot point.
T	scale(float scale) Sets the scale (scaleX and scaleY) on this component.
T	scaleX(DynamicValue<java.lang.Float> value) Links a DynamicValue object to the scaleX value for this Component
T	scaleY(DynamicValue<java.lang.Float> value) Links a DynamicValue object to the scaleY value for this Component
T	selected(boolean isSelected)
T	sendAccessibilityEventHandler(EventHandler<SendAccessibilityEventEvent> sendAccessibilityEventHandler)
T	sendAccessibilityEventUncheckedHandler(EventHandler<SendAccessibilityEventUncheckedEvent> sendAccessibilityEventUncheckedHandler)
protected abstract void	setComponent(Component component)
T	shadowElevation(DynamicValue<java.lang.Float> value) Links a DynamicValue object to the elevation value for this Component
T	shadowElevationAttr(int resId)
T	shadowElevationAttr(int resId, int defaultResId)
T	shadowElevationDip(float shadowElevation)
T	shadowElevationPx(float shadowElevation) Shadow elevation and outline provider methods are only functional on android.os.Build.VERSION_CODES#LOLLIPOP and above.
T	shadowElevationRes(int resId)
T	stateListAnimator(StateListAnimator stateListAnimator) Ports android.view.View#setStateListAnimator(android.animation.StateListAnimator) into components world.
T	stateListAnimatorRes(int resId) Ports android.view.View#setStateListAnimator(android.animation.StateListAnimator) into components world.
T	testKey(java.lang.String testKey)
T	touchExpansionAttr(YogaEdge edge, int resId)
T	touchExpansionAttr(YogaEdge edge, int resId, int defaultResId)
T	touchExpansionDip(YogaEdge edge, float touchExpansion)
T	touchExpansionPx(YogaEdge edge, int touchExpansion)
T	touchExpansionRes(YogaEdge edge, int resId)
T	touchHandler(EventHandler<TouchEvent> touchHandler)
T	transitionKey(java.lang.String key)
T	transitionKeyType(Transition.TransitionKeyType type)
T	transitionName(java.lang.String transitionName)
T	translationX(DynamicValue<java.lang.Float> value) Links a DynamicValue object to the translationX value for this Component
T	translationY(DynamicValue<java.lang.Float> value) Links a DynamicValue object to the translationY value for this Component
T	unfocusedHandler(EventHandler<UnfocusedVisibleEvent> unfocusedHandler)
T	useHeightAsBaseline(boolean useHeightAsBaseline) When set to true, overrides the default behaviour of baseline calculation and uses height of component as baseline.
T	viewTag(java.lang.Object viewTag)
T	viewTags(<any> viewTags)
T	visibilityChangedHandler(EventHandler<VisibilityChangedEvent> visibilityChangedHandler)
T	visibleHandler(EventHandler<VisibleEvent> visibleHandler)
T	visibleHeightRatio(float visibleHeightRatio)
T	visibleWidthRatio(float visibleWidthRatio)
T	widthAttr(int resId)
T	widthAttr(int resId, int defaultResId)
T	widthDip(float width)
T	widthPercent(float percent) Sets the width of the Component to be a percentage of its parent's width.
T	widthPx(int width) Specifies the width of the element's content area.
T	widthRes(int resId)
T	wrapInView()

Methods inherited from class java.lang.Object

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

Field Detail

mResourceResolver

protected final ResourceResolver mResourceResolver

Constructor Detail

Builder

protected Builder(ComponentContext c,
                  int defStyleAttr,
                  int defStyleRes,
                  Component component)

Method Detail

build

public abstract Component build()

getThis

public abstract T getThis()

setComponent

protected abstract void setComponent(Component component)

accessibilityHeading

public T accessibilityHeading(boolean isHeading)

Ports androidx.core.view.ViewCompat#setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See androidx.core.view.accessibility.AccessibilityNodeInfoCompat#setHeading for more information.

Default: false

accessibilityRole

public T accessibilityRole(java.lang.String role)

accessibilityRoleDescription

public T accessibilityRoleDescription(java.lang.CharSequence roleDescription)

accessibilityRoleDescription

public T accessibilityRoleDescription(int stringId)

accessibilityRoleDescription

public T accessibilityRoleDescription(int stringId,
                                      java.lang.Object... formatArgs)

alignSelf

public T alignSelf(YogaAlign alignSelf)

Controls how a child aligns in the cross direction, overriding the alignItems of the parent. See https://yogalayout.dev/docs/align-items for more information.

Default: YogaAlign.AUTO

alpha

public T alpha(float alpha)

Sets the alpha (opacity) of this component.

alpha

public T alpha(DynamicValue<java.lang.Float> value)

Links a DynamicValue object ot the alpha value for this Component

Parameters:

value - controller for the alpha value

aspectRatio

public T aspectRatio(float aspectRatio)

Defined as the ratio between the width and the height of a node. See https://yogalayout.dev/docs/aspect-ratio for more information

background

public T background(Drawable background)

Set the background of this component. The background drawable can implement ComparableDrawable for more efficient diffing while when drawables are remounted or updated.

See Also:

ComparableDrawable

backgroundAttr

public T backgroundAttr(int resId,
                        int defaultResId)

backgroundAttr

public T backgroundAttr(int resId)

backgroundColor

public T backgroundColor(int backgroundColor)

backgroundColor

public T backgroundColor(DynamicValue<java.lang.Integer> value)

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

Parameters:

value - controller for the background color value

backgroundDynamicDrawable

public T backgroundDynamicDrawable(DynamicValue<? extends Drawable> value)

Links a DynamicValue object to the background drawable for this Component

Parameters:

value - controller for the background drawable

backgroundRes

public T backgroundRes(int resId)

border

public T border(Border border)

clickHandler

public T clickHandler(EventHandler<ClickEvent> clickHandler)

clickable

public T clickable(boolean isClickable)

clipChildren

public T clipChildren(boolean clipChildren)

Ports android.view.ViewGroup#setClipChildren(boolean) into components world. However, there is no guarantee that child of this component would be translated into direct view child in the resulting view hierarchy.

Parameters:

clipChildren - true to clip children to their bounds. False allows each child to draw outside of its own bounds within the parent, it doesn't allow children to draw outside of the parent itself.

clipToOutline

public T clipToOutline(boolean clipToOutline)

contentDescription

public T contentDescription(java.lang.CharSequence contentDescription)

contentDescription

public T contentDescription(int stringId)

contentDescription

public T contentDescription(int stringId,
                            java.lang.Object... formatArgs)

dispatchPopulateAccessibilityEventHandler

public T dispatchPopulateAccessibilityEventHandler(EventHandler<DispatchPopulateAccessibilityEventEvent> dispatchPopulateAccessibilityEventHandler)

duplicateParentState

public T duplicateParentState(boolean duplicateParentState)

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

In the following example, when Row gets pressed state, its child OtherStatefulDrawable will get that pressed state within itself too:

 Row.create(c)
     .drawable(stateListDrawable)
     .clickable(true)
     .child(
         OtherStatefulDrawable.create(c)
             .duplicateParentState(true))
 

See Also:

android.view.View#setDuplicateParentStateEnabled(boolean)

duplicateChildrenStates

public T duplicateChildrenStates(boolean duplicateChildrenStates)

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

In the following example, when OtherStatefulDrawable gets pressed state, its parent Row will also get that pressed state within itself:

 Row.create(c)
     .drawable(stateListDrawable)
     .duplicateChildrenStates(true)
     .child(
         OtherStatefulDrawable.create(c)
             .clickable(true))
 

See Also:

android.view.ViewGroup#setAddStatesFromChildren

enabled

public T enabled(boolean isEnabled)

flex

public T flex(float flex)

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

When flex is a positive number, it makes the component flexible and it will be sized proportional to its flex value. So a component with flex set to 2 will take twice the space as a component with flex set to 1.

When flex is 0, the component is sized according to width and height and it is inflexible.

When flex is -1, the component is normally sized according width and height. However, if there's not enough space, the component will shrink to its minWidth and minHeight.

See https://yogalayout.dev/docs/flex for more information.

Default: 0

flexBasisAttr

public T flexBasisAttr(int resId,
                       int defaultResId)

See Also:

flexBasisPx(int)

flexBasisAttr

public T flexBasisAttr(int resId)

See Also:

flexBasisPx(int)

flexBasisDip

public T flexBasisDip(float flexBasis)

See Also:

flexBasisPx(int)

flexBasisPercent

public T flexBasisPercent(float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

flexBasisPx(int)

flexBasisPx

public T flexBasisPx(int flexBasis)

The FlexBasis property is an axis-independent way of providing the default size of an item on the main axis. Setting the FlexBasis of a child is similar to setting the Width of that child if its parent is a container with FlexDirection = row or setting the Height of a child if its parent is a container with FlexDirection = column. The FlexBasis of an item is the default size of that item, the size of the item before any FlexGrow and FlexShrink calculations are performed. See https://yogalayout.dev/docs/flex for more information.

Default: 0

flexBasisRes

public T flexBasisRes(int resId)

See Also:

flexBasisPx(int)

flexGrow

public T flexGrow(float flexGrow)

If the sum of childrens' main axis dimensions is less than the minimum size, how much should this component grow? This value represents the "flex grow factor" and determines how much this component should grow along the main axis in relation to any other flexible children. See https://yogalayout.dev/docs/flex for more information.

Default: 0

flexShrink

public T flexShrink(float flexShrink)

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. See https://yogalayout.dev/docs/flex for more information.

Default: 1

focusChangeHandler

public T focusChangeHandler(EventHandler<FocusChangedEvent> focusChangeHandler)

focusable

public T focusable(boolean isFocusable)

focusedHandler

public T focusedHandler(EventHandler<FocusedVisibleEvent> focusedHandler)

foreground

public T foreground(Drawable foreground)

Set the foreground of this component. The foreground drawable must extend ComparableDrawable for more efficient diffing while when drawables are remounted or updated. If the drawable does not extend ComparableDrawable then create a new class which extends ComparableDrawable and implement the ComparableDrawable.isEquivalentTo(ComparableDrawable).

See Also:

ComparableDrawable

foregroundAttr

public T foregroundAttr(int resId,
                        int defaultResId)

foregroundAttr

public T foregroundAttr(int resId)

foregroundColor

public T foregroundColor(int foregroundColor)

foregroundColor

public T foregroundColor(DynamicValue<java.lang.Integer> value)

foregroundRes

public T foregroundRes(int resId)

fullImpressionHandler

public T fullImpressionHandler(EventHandler<FullImpressionVisibleEvent> fullImpressionHandler)

getContext

public ComponentContext getContext()

Returns:

the ComponentContext for this Component.Builder, useful for Kotlin DSL. Will be null if the Builder was already used to build() a component.

handle

public T handle(Handle handle)

hasBackgroundSet

@Deprecated
public boolean hasBackgroundSet()

Deprecated.

hasClickHandlerSet

public boolean hasClickHandlerSet()

heightAttr

public T heightAttr(int resId,
                    int defaultResId)

See Also:

heightPx(int)

heightAttr

public T heightAttr(int resId)

See Also:

heightPx(int)

heightDip

public T heightDip(float height)

See Also:

heightPx(int)

heightPercent

public T heightPercent(float percent)

Sets the height of the Component to be a percentage of its parent's height. Note that if the parent has unspecified height (e.g. it is a RecyclerView), then setting this will have no effect.

Parameters:

percent - a value between 0 and 100.

See Also:

heightPx(int)

heightPx

public T heightPx(int height)

Specifies the height of the element's content area. See https://yogalayout.dev/docs/width-height for more information

heightRes

public T heightRes(int resId)

See Also:

heightPx(int)

importantForAccessibility

public T importantForAccessibility(int importantForAccessibility)

interceptTouchHandler

public T interceptTouchHandler(EventHandler<InterceptTouchEvent> interceptTouchHandler)

invisibleHandler

public T invisibleHandler(EventHandler<InvisibleEvent> invisibleHandler)

isReferenceBaseline

public T isReferenceBaseline(boolean isReferenceBaseline)

key

public T key(java.lang.String key)

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

layoutDirection

public T layoutDirection(YogaDirection layoutDirection)

The RTL/LTR direction of components and text. Determines whether YogaEdge.START and YogaEdge.END will resolve to the left or right side, among other things. INHERIT indicates this setting will be inherited from this component's parent.

Default: YogaDirection.INHERIT

longClickHandler

public T longClickHandler(EventHandler<LongClickEvent> longClickHandler)

marginAttr

public T marginAttr(YogaEdge edge,
                    int resId,
                    int defaultResId)

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

marginAttr

public T marginAttr(YogaEdge edge,
                    int resId)

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

marginAuto

public T marginAuto(YogaEdge edge)

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

marginDip

public T marginDip(YogaEdge edge,
                   float margin)

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

marginPercent

public T marginPercent(YogaEdge edge,
                       float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

marginPx

public T marginPx(YogaEdge edge,
                  int margin)

Effects the spacing around the outside of a node. A node with margin will offset itself from the bounds of its parent but also offset the location of any siblings. See https://yogalayout.dev/docs/margins-paddings-borders for more information

marginRes

public T marginRes(YogaEdge edge,
                   int resId)

See Also:

marginPx(com.facebook.yoga.YogaEdge, int)

maxHeightAttr

public T maxHeightAttr(int resId,
                       int defaultResId)

See Also:

minWidthPx(int)

maxHeightAttr

public T maxHeightAttr(int resId)

See Also:

minWidthPx(int)

maxHeightDip

public T maxHeightDip(float maxHeight)

See Also:

minWidthPx(int)

maxHeightPercent

public T maxHeightPercent(float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

minWidthPx(int)

maxHeightPx

public T maxHeightPx(int maxHeight)

See Also:

minWidthPx(int)

maxHeightRes

public T maxHeightRes(int resId)

See Also:

minWidthPx(int)

maxWidthAttr

public T maxWidthAttr(int resId,
                      int defaultResId)

See Also:

minWidthPx(int)

maxWidthAttr

public T maxWidthAttr(int resId)

See Also:

minWidthPx(int)

maxWidthDip

public T maxWidthDip(float maxWidth)

See Also:

minWidthPx(int)

maxWidthPercent

public T maxWidthPercent(float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

minWidthPx(int)

maxWidthPx

public T maxWidthPx(int maxWidth)

See Also:

minWidthPx(int)

maxWidthRes

public T maxWidthRes(int resId)

See Also:

minWidthPx(int)

minHeightAttr

public T minHeightAttr(int resId,
                       int defaultResId)

See Also:

minWidthPx(int)

minHeightAttr

public T minHeightAttr(int resId)

See Also:

minWidthPx(int)

minHeightDip

public T minHeightDip(float minHeight)

See Also:

minWidthPx(int)

minHeightPercent

public T minHeightPercent(float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

minWidthPx(int)

minHeightPx

public T minHeightPx(int minHeight)

See Also:

minWidthPx(int)

minHeightRes

public T minHeightRes(int resId)

See Also:

minWidthPx(int)

minWidthAttr

public T minWidthAttr(int resId,
                      int defaultResId)

See Also:

minWidthPx(int)

minWidthAttr

public T minWidthAttr(int resId)

See Also:

minWidthPx(int)

minWidthDip

public T minWidthDip(float minWidth)

See Also:

minWidthPx(int)

minWidthPercent

public T minWidthPercent(float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

minWidthPx(int)

minWidthPx

public T minWidthPx(int minWidth)

This property has higher priority than all other properties and will always be respected. See https://yogalayout.dev/docs/min-max/ for more information

minWidthRes

public T minWidthRes(int resId)

See Also:

minWidthPx(int)

onInitializeAccessibilityEventHandler

public T onInitializeAccessibilityEventHandler(EventHandler<OnInitializeAccessibilityEventEvent> onInitializeAccessibilityEventHandler)

onInitializeAccessibilityNodeInfoHandler

public T onInitializeAccessibilityNodeInfoHandler(EventHandler<OnInitializeAccessibilityNodeInfoEvent> onInitializeAccessibilityNodeInfoHandler)

onPopulateAccessibilityEventHandler

public T onPopulateAccessibilityEventHandler(EventHandler<OnPopulateAccessibilityEventEvent> onPopulateAccessibilityEventHandler)

onRequestSendAccessibilityEventHandler

public T onRequestSendAccessibilityEventHandler(EventHandler<OnRequestSendAccessibilityEventEvent> onRequestSendAccessibilityEventHandler)

outlineProvider

public T outlineProvider(ViewOutlineProvider outlineProvider)

paddingAttr

public T paddingAttr(YogaEdge edge,
                     int resId,
                     int defaultResId)

See Also:

paddingPx(com.facebook.yoga.YogaEdge, int)

paddingAttr

public T paddingAttr(YogaEdge edge,
                     int resId)

See Also:

paddingPx(com.facebook.yoga.YogaEdge, int)

paddingDip

public T paddingDip(YogaEdge edge,
                    float padding)

See Also:

paddingPx(com.facebook.yoga.YogaEdge, int)

paddingPercent

public T paddingPercent(YogaEdge edge,
                        float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

paddingPx(com.facebook.yoga.YogaEdge, int)

paddingPx

public T paddingPx(YogaEdge edge,
                   int padding)

Affects the size of the node it is applied to. Padding will not add to the total size of an element if it has an explicit size set. See https://yogalayout.dev/docs/margins-paddings-borders for more information

paddingRes

public T paddingRes(YogaEdge edge,
                    int resId)

See Also:

paddingPx(com.facebook.yoga.YogaEdge, int)

performAccessibilityActionHandler

public T performAccessibilityActionHandler(EventHandler<PerformAccessibilityActionEvent> performAccessibilityActionHandler)

positionAttr

public T positionAttr(YogaEdge edge,
                      int resId,
                      int defaultResId)

See Also:

positionPx(com.facebook.yoga.YogaEdge, int)

positionAttr

public T positionAttr(YogaEdge edge,
                      int resId)

See Also:

positionPx(com.facebook.yoga.YogaEdge, int)

positionDip

public T positionDip(YogaEdge edge,
                     float position)

See Also:

positionPx(com.facebook.yoga.YogaEdge, int)

positionPercent

public T positionPercent(YogaEdge edge,
                         float percent)

Parameters:

percent - a value between 0 and 100.

See Also:

positionPx(com.facebook.yoga.YogaEdge, int)

positionPx

public T positionPx(YogaEdge edge,
                    int position)

When used in combination with positionType(com.facebook.yoga.YogaPositionType) of YogaPositionType.ABSOLUTE, allows the component to specify how it should be positioned within its parent. See https://yogalayout.dev/docs/absolute-relative-layout for more information.

positionRes

public T positionRes(YogaEdge edge,
                     int resId)

See Also:

positionPx(com.facebook.yoga.YogaEdge, int)

positionType

public T positionType(YogaPositionType positionType)

Controls how this component will be positioned within its parent. See https://yogalayout.dev/docs/absolute-relative-layout for more details.

Default: YogaPositionType.RELATIVE

rotation

public T rotation(float rotation)

Sets the degree that this component is rotated around the pivot point. Increasing the value results in clockwise rotation. By default, the pivot point is centered on the component.

rotation

public T rotation(DynamicValue<java.lang.Float> rotation)

Links a DynamicValue object to the rotation value for this Component

Parameters:

rotation - controller for the rotation value

rotationX

public T rotationX(float rotationX)

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

rotationY

public T rotationY(float rotationY)

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

scale

public T scale(float scale)

Sets the scale (scaleX and scaleY) on this component. This is mostly relevant for animations and being able to animate size changes. Otherwise for non-animation usecases, you should use the standard layout properties to control the size of your component.

scaleX

public T scaleX(DynamicValue<java.lang.Float> value)

Links a DynamicValue object to the scaleX value for this Component

Parameters:

value - controller for the scaleX value

scaleY

public T scaleY(DynamicValue<java.lang.Float> value)

Links a DynamicValue object to the scaleY value for this Component

Parameters:

value - controller for the scaleY value

selected

public T selected(boolean isSelected)

sendAccessibilityEventHandler

public T sendAccessibilityEventHandler(EventHandler<SendAccessibilityEventEvent> sendAccessibilityEventHandler)

sendAccessibilityEventUncheckedHandler

public T sendAccessibilityEventUncheckedHandler(EventHandler<SendAccessibilityEventUncheckedEvent> sendAccessibilityEventUncheckedHandler)

shadowElevationAttr

public T shadowElevationAttr(int resId,
                             int defaultResId)

shadowElevationAttr

public T shadowElevationAttr(int resId)

shadowElevationDip

public T shadowElevationDip(float shadowElevation)

shadowElevationPx

public T shadowElevationPx(float shadowElevation)

Shadow elevation and outline provider methods are only functional on android.os.Build.VERSION_CODES#LOLLIPOP and above.

shadowElevationRes

public T shadowElevationRes(int resId)

shadowElevation

public T shadowElevation(DynamicValue<java.lang.Float> value)

Links a DynamicValue object to the elevation value for this Component

Parameters:

value - controller for the elevation value

stateListAnimator

public T stateListAnimator(StateListAnimator stateListAnimator)

Ports android.view.View#setStateListAnimator(android.animation.StateListAnimator) into components world. However, since the aforementioned view's method is available only on API 21 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being wrapped into a view

stateListAnimatorRes

public T stateListAnimatorRes(int resId)

Ports android.view.View#setStateListAnimator(android.animation.StateListAnimator) into components world. However, since the aforementioned view's method is available only on API 21 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being wrapped into a view

testKey

public T testKey(java.lang.String testKey)

componentTag

public T componentTag(java.lang.Object componentTag)

touchExpansionAttr

public T touchExpansionAttr(YogaEdge edge,
                            int resId,
                            int defaultResId)

touchExpansionAttr

public T touchExpansionAttr(YogaEdge edge,
                            int resId)

touchExpansionDip

public T touchExpansionDip(YogaEdge edge,
                           float touchExpansion)

touchExpansionPx

public T touchExpansionPx(YogaEdge edge,
                          int touchExpansion)

touchExpansionRes

public T touchExpansionRes(YogaEdge edge,
                           int resId)

touchHandler

public T touchHandler(EventHandler<TouchEvent> touchHandler)

transitionKey

public T transitionKey(java.lang.String key)

transitionName

public T transitionName(java.lang.String transitionName)

transitionKeyType

public T transitionKeyType(Transition.TransitionKeyType type)

translationX

public T translationX(DynamicValue<java.lang.Float> value)

Links a DynamicValue object to the translationX value for this Component

Parameters:

value - controller for the translationY value

translationY

public T translationY(DynamicValue<java.lang.Float> value)

Links a DynamicValue object to the translationY value for this Component

Parameters:

value - controller for the translationY value

metadata

public <K,V> T metadata(K key,
                        V value)

Links a DynamicValue object to a Key for this Component

Parameters:

key - to access metadata for the object

value - value stored at key

unfocusedHandler

public T unfocusedHandler(EventHandler<UnfocusedVisibleEvent> unfocusedHandler)

useHeightAsBaseline

public T useHeightAsBaseline(boolean useHeightAsBaseline)

When set to true, overrides the default behaviour of baseline calculation and uses height of component as baseline. By default the baseline of a component is the baseline of first child of component (If the component does not have any child then baseline is height of the component)

viewTag

public T viewTag(java.lang.Object viewTag)

viewTags

public T viewTags(<any> viewTags)

visibilityChangedHandler

public T visibilityChangedHandler(EventHandler<VisibilityChangedEvent> visibilityChangedHandler)

visibleHandler

public T visibleHandler(EventHandler<VisibleEvent> visibleHandler)

visibleHeightRatio

public T visibleHeightRatio(float visibleHeightRatio)

visibleWidthRatio

public T visibleWidthRatio(float visibleWidthRatio)

widthAttr

public T widthAttr(int resId,
                   int defaultResId)

See Also:

widthPx(int)

widthAttr

public T widthAttr(int resId)

See Also:

widthPx(int)

widthDip

public T widthDip(float width)

See Also:

widthPx(int)

widthPercent

public T widthPercent(float percent)

Sets the width of the Component to be a percentage of its parent's width. Note that if the parent has unspecified width (e.g. it is an HScroll), then setting this will have no effect.

Parameters:

percent - a value between 0 and 100.

See Also:

widthPx(int)

widthPx

public T widthPx(int width)

Specifies the width of the element's content area. See https://yogalayout.dev/docs/width-height for more information

widthRes

public T widthRes(int resId)

See Also:

widthPx(int)

wrapInView

public T wrapInView()

layerType

public T layerType(int type,
                   Paint paint)

checkArgs

protected static void checkArgs(int requiredPropsCount,
                                java.util.BitSet required,
                                java.lang.String[] requiredPropsNames)

Checks that all the required props are supplied, and if not throws a useful exception

Parameters:

requiredPropsCount - expected number of props

required - the bit set that identifies which props have been supplied

requiredPropsNames - the names of all props used for a useful error message