HelperReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

class HelperReference : ConstraintReference, Facade

kotlin.Any
↳	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

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

Public functions
`HelperReference!`	`add(objects: Array<Any!>!)`
`Unit`	`apply()`
`Unit`	`applyBase()` Allows the derived classes to invoke the apply method in the ConstraintReference
`ConstraintWidget!`	`getConstraintWidget()`
`HelperWidget!`	`getHelperWidget()`
`State.Helper!`	`getType()`
`Unit`	`setHelperWidget(helperWidget: HelperWidget!)`

Protected properties
`State!`	`mHelperState`
`ArrayList<Any!>!`	`mReferences`

Inherited functions

From androidx.constraintlayout.core.state.ConstraintReference

`Unit`	`addCustomColor(name: String!, color: Int)`
`Unit`	`addCustomFloat(name: String!, value: Float)`
`ConstraintReference!`	`alpha(alpha: Float)`
`Unit`	`applyWidgetConstraints()` apply all the constraints attributes of the mConstraintWidget
`ConstraintReference!`	`baseline()`
`ConstraintReference!`	`baselineToBaseline(reference: Any!)`
`ConstraintReference!`	`baselineToBottom(reference: Any!)`
`ConstraintReference!`	`baselineToTop(reference: Any!)`
`ConstraintReference!`	`bias(value: Float)`
`ConstraintReference!`	`bottom()`
`ConstraintReference!`	`bottomToBottom(reference: Any!)`
`ConstraintReference!`	`bottomToTop(reference: Any!)`
`ConstraintReference!`	`centerHorizontally(reference: Any!)`
`ConstraintReference!`	`centerVertically(reference: Any!)`
`ConstraintReference!`	`circularConstraint(reference: Any!, angle: Float, distance: Float)`
`ConstraintReference!`	`clear()`
`ConstraintReference!`	`clearAll()` Clears all constraints.
`ConstraintReference!`	`clearHorizontal()`
`ConstraintReference!`	`clearVertical()`
`ConstraintWidget!`	`createConstraintWidget()`
`ConstraintReference!`	`end()`
`ConstraintReference!`	`endToEnd(reference: Any!)`
`ConstraintReference!`	`endToStart(reference: Any!)`
`Float`	`getAlpha()`
`Facade!`	`getFacade()`
`Dimension!`	`getHeight()`
`Int`	`getHorizontalChainStyle()`
`Float`	`getHorizontalChainWeight()`
`Any!`	`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(chainStyle: Int)`
`Float`	`getVerticalChainWeight()`
`Any!`	`getView()`
`Dimension!`	`getWidth()`
`ConstraintReference!`	`height(dimension: Dimension!)`
`ConstraintReference!`	`horizontalBias(value: Float)`
`ConstraintReference!`	`left()`
`ConstraintReference!`	`leftToLeft(reference: Any!)`
`ConstraintReference!`	`leftToRight(reference: Any!)`
`ConstraintReference!`	`margin(marginValue: Any!)`
`ConstraintReference!`	`margin(value: Int)`
`ConstraintReference!`	`marginGone(marginGoneValue: Any!)`
`ConstraintReference!`	`marginGone(value: Int)`
`ConstraintReference!`	`pivotX(x: Float)`
`ConstraintReference!`	`pivotY(y: Float)`
`ConstraintReference!`	`right()`
`ConstraintReference!`	`rightToLeft(reference: Any!)`
`ConstraintReference!`	`rightToRight(reference: Any!)`
`ConstraintReference!`	`rotationX(x: Float)`
`ConstraintReference!`	`rotationY(y: Float)`
`ConstraintReference!`	`rotationZ(z: Float)`
`ConstraintReference!`	`scaleX(x: Float)`
`ConstraintReference!`	`scaleY(y: Float)`
`Unit`	`setConstraintWidget(widget: ConstraintWidget!)`
`Unit`	`setFacade(facade: Facade!)`
`ConstraintReference!`	`setHeight(dimension: Dimension!)`
`Unit`	`setHorizontalChainStyle(chainStyle: Int)`
`Unit`	`setHorizontalChainWeight(weight: Float)`
`Unit`	`setKey(key: Any!)`
`Unit`	`setTag(tag: String!)`
`Unit`	`setVerticalChainStyle(chainStyle: Int)`
`Unit`	`setVerticalChainWeight(weight: Float)`
`Unit`	`setView(view: Any!)`
`ConstraintReference!`	`setWidth(dimension: Dimension!)`
`ConstraintReference!`	`start()`
`ConstraintReference!`	`startToEnd(reference: Any!)`
`ConstraintReference!`	`startToStart(reference: Any!)`
`ConstraintReference!`	`top()`
`ConstraintReference!`	`topToBottom(reference: Any!)`
`ConstraintReference!`	`topToTop(reference: Any!)`
`ConstraintReference!`	`translationX(x: Float)`
`ConstraintReference!`	`translationY(y: Float)`
`ConstraintReference!`	`translationZ(z: Float)`
`Unit`	`validate()` Validate the constraints
`ConstraintReference!`	`verticalBias(value: Float)`
`ConstraintReference!`	`visibility(visibility: Int)`
`ConstraintReference!`	`width(dimension: Dimension!)`

Inherited properties

From androidx.constraintlayout.core.state.ConstraintReference

`Any!`	`mBottomToBottom`
`Any!`	`mBottomToTop`
`Any!`	`mEndToEnd`
`Any!`	`mEndToStart`
`Float`	`mHorizontalBias`
`Any!`	`mLeftToLeft`
`Any!`	`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`
`Any!`	`mRightToLeft`
`Any!`	`mRightToRight`
`Any!`	`mStartToEnd`
`Any!`	`mStartToStart`
`Any!`	`mTopToBottom`
`Any!`	`mTopToTop`
`Float`	`mVerticalBias`

Public constructors

HelperReference

Added in 1.1.0

HelperReference(state: State!, type: State.Helper!)

Public functions

add

fun add(objects: Array<Any!>!): HelperReference!

apply

fun apply(): Unit

applyBase

Added in 1.1.0

fun applyBase(): Unit

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

getConstraintWidget

fun getConstraintWidget(): ConstraintWidget!

getHelperWidget

Added in 1.1.0

fun getHelperWidget(): HelperWidget!

getType

Added in 1.1.0

fun getType(): State.Helper!

setHelperWidget

Added in 1.1.0

fun setHelperWidget(helperWidget: HelperWidget!): Unit

Protected properties

mHelperState

Added in 1.1.0

protected val mHelperState: State!

mReferences

Added in 1.1.0

protected val mReferences: ArrayList<Any!>!