HelperReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

public class HelperReference extends ConstraintReference implements Facade

java.lang.Object
↳	androidx.constraintlayout.core.state.ConstraintReference
	↳	androidx.constraintlayout.core.state.HelperReference

Known direct subclasses

AlignHorizontallyReference, AlignVerticallyReference, BarrierReference, ChainReference, FlowReference, GridReference

`AlignHorizontallyReference`
`AlignVerticallyReference`
`BarrierReference`
`ChainReference`	`HelperReference` for Chains.
`FlowReference`	The FlowReference class can be used to store the relevant properties of a Flow Helper when parsing the Flow Helper information in a JSON representation.
`GridReference`	A HelperReference of a Grid Helper that helps enable Grid in Compose

Known indirect subclasses

HorizontalChainReference, VerticalChainReference

`HorizontalChainReference`
`VerticalChainReference`

Summary

Protected fields
`final State`	`mHelperState`
`ArrayList<Object>`	`mReferences`

Public constructors
`HelperReference(State state, State.Helper type)`

Public methods
`HelperReference`	`add(Object[] objects)`
`void`	`apply()`
`void`	`applyBase()` Allows the derived classes to invoke the apply method in the ConstraintReference
`ConstraintWidget`	`getConstraintWidget()`
`HelperWidget`	`getHelperWidget()`
`State.Helper`	`getType()`
`void`	`setHelperWidget(HelperWidget helperWidget)`

Inherited fields

From androidx.constraintlayout.core.state.ConstraintReference

`Object`	`mBottomToBottom`
`Object`	`mBottomToTop`
`Object`	`mEndToEnd`
`Object`	`mEndToStart`
`float`	`mHorizontalBias`
`Object`	`mLeftToLeft`
`Object`	`mLeftToRight`
`int`	`mMarginBottom`
`int`	`mMarginBottomGone`
`int`	`mMarginEnd`
`int`	`mMarginEndGone`
`int`	`mMarginLeft`
`int`	`mMarginLeftGone`
`int`	`mMarginRight`
`int`	`mMarginRightGone`
`int`	`mMarginStart`
`int`	`mMarginStartGone`
`int`	`mMarginTop`
`int`	`mMarginTopGone`
`Object`	`mRightToLeft`
`Object`	`mRightToRight`
`Object`	`mStartToEnd`
`Object`	`mStartToStart`
`Object`	`mTopToBottom`
`Object`	`mTopToTop`
`float`	`mVerticalBias`

Inherited methods

From androidx.constraintlayout.core.state.ConstraintReference

`void`	`addCustomColor(String name, int color)`
`void`	`addCustomFloat(String name, float value)`
`ConstraintReference`	`alpha(float alpha)`
`void`	`applyWidgetConstraints()` apply all the constraints attributes of the mConstraintWidget
`ConstraintReference`	`baseline()`
`ConstraintReference`	`baselineToBaseline(Object reference)`
`ConstraintReference`	`baselineToBottom(Object reference)`
`ConstraintReference`	`baselineToTop(Object reference)`
`ConstraintReference`	`bias(float value)`
`ConstraintReference`	`bottom()`
`ConstraintReference`	`bottomToBottom(Object reference)`
`ConstraintReference`	`bottomToTop(Object reference)`
`ConstraintReference`	`centerHorizontally(Object reference)`
`ConstraintReference`	`centerVertically(Object reference)`
`ConstraintReference`	`circularConstraint(Object reference, float angle, float distance)`
`ConstraintReference`	`clear()`
`ConstraintReference`	`clearAll()` Clears all constraints.
`ConstraintReference`	`clearHorizontal()`
`ConstraintReference`	`clearVertical()`
`ConstraintWidget`	`createConstraintWidget()`
`ConstraintReference`	`end()`
`ConstraintReference`	`endToEnd(Object reference)`
`ConstraintReference`	`endToStart(Object reference)`
`float`	`getAlpha()`
`Facade`	`getFacade()`
`Dimension`	`getHeight()`
`int`	`getHorizontalChainStyle()`
`float`	`getHorizontalChainWeight()`
`Object`	`getKey()`
`float`	`getPivotX()`
`float`	`getPivotY()`
`float`	`getRotationX()`
`float`	`getRotationY()`
`float`	`getRotationZ()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`String`	`getTag()`
`float`	`getTranslationX()`
`float`	`getTranslationY()`
`float`	`getTranslationZ()`
`int`	`getVerticalChainStyle(int chainStyle)`
`float`	`getVerticalChainWeight()`
`Object`	`getView()`
`Dimension`	`getWidth()`
`ConstraintReference`	`height(Dimension dimension)`
`ConstraintReference`	`horizontalBias(float value)`
`ConstraintReference`	`left()`
`ConstraintReference`	`leftToLeft(Object reference)`
`ConstraintReference`	`leftToRight(Object reference)`
`ConstraintReference`	`margin(Object marginValue)`
`ConstraintReference`	`margin(int value)`
`ConstraintReference`	`marginGone(Object marginGoneValue)`
`ConstraintReference`	`marginGone(int value)`
`ConstraintReference`	`pivotX(float x)`
`ConstraintReference`	`pivotY(float y)`
`ConstraintReference`	`right()`
`ConstraintReference`	`rightToLeft(Object reference)`
`ConstraintReference`	`rightToRight(Object reference)`
`ConstraintReference`	`rotationX(float x)`
`ConstraintReference`	`rotationY(float y)`
`ConstraintReference`	`rotationZ(float z)`
`ConstraintReference`	`scaleX(float x)`
`ConstraintReference`	`scaleY(float y)`
`void`	`setConstraintWidget(ConstraintWidget widget)`
`void`	`setFacade(Facade facade)`
`ConstraintReference`	`setHeight(Dimension dimension)`
`void`	`setHorizontalChainStyle(int chainStyle)`
`void`	`setHorizontalChainWeight(float weight)`
`void`	`setKey(Object key)`
`void`	`setTag(String tag)`
`void`	`setVerticalChainStyle(int chainStyle)`
`void`	`setVerticalChainWeight(float weight)`
`void`	`setView(Object view)`
`ConstraintReference`	`setWidth(Dimension dimension)`
`ConstraintReference`	`start()`
`ConstraintReference`	`startToEnd(Object reference)`
`ConstraintReference`	`startToStart(Object reference)`
`ConstraintReference`	`top()`
`ConstraintReference`	`topToBottom(Object reference)`
`ConstraintReference`	`topToTop(Object reference)`
`ConstraintReference`	`translationX(float x)`
`ConstraintReference`	`translationY(float y)`
`ConstraintReference`	`translationZ(float z)`
`void`	`validate()` Validate the constraints
`ConstraintReference`	`verticalBias(float value)`
`ConstraintReference`	`visibility(int visibility)`
`ConstraintReference`	`width(Dimension dimension)`

Protected fields

mHelperState

Added in 1.1.0

protected final State mHelperState

mReferences

Added in 1.1.0

protected ArrayList<Object> mReferences

Public constructors

HelperReference

Added in 1.1.0

public HelperReference(State state, State.Helper type)

Public methods

add

public HelperReference add(Object[] objects)

apply

public void apply()

applyBase

Added in 1.1.0

public void applyBase()

Allows the derived classes to invoke the apply method in the ConstraintReference

getConstraintWidget

public ConstraintWidget getConstraintWidget()

getHelperWidget

Added in 1.1.0

public HelperWidget getHelperWidget()

getType

Added in 1.1.0

public State.Helper getType()

setHelperWidget

Added in 1.1.0

public void setHelperWidget(HelperWidget helperWidget)