ChainReference

Artifact: androidx.constraintlayout:constraintlayout-core

Kotlin |Java

class ChainReference : HelperReference

kotlin.Any
↳	androidx.constraintlayout.core.state.ConstraintReference
	↳	androidx.constraintlayout.core.state.HelperReference
		↳	androidx.constraintlayout.core.state.helpers.ChainReference

Known direct subclasses

HorizontalChainReference, VerticalChainReference

`HorizontalChainReference`
`VerticalChainReference`

HelperReference for Chains. Elements should be added with addChainElement

Summary

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

Public functions
`Unit`	`addChainElement( id: String, weight: Float, preMargin: Float, postMargin: Float )` Adds the element by the given id to the Chain.
`ChainReference`	`bias(bias: Float)`
`Float`	`getBias()`
`State.Chain`	`getStyle()`
`ChainReference`	`style(style: State.Chain)` Sets the `style`.

Protected functions
`Float`	`getPostMargin(id: String)`
`Float`	`getPreMargin(id: String)`
`Float`	`getWeight(id: String)`

Protected properties
`Float`	`mBias`
`HashMap<String!, Float!>`	`mMapPostMargin` This property is deprecated. Unintended visibility, use `getPostMargin` instead
`HashMap<String!, Float!>`	`mMapPreMargin` This property is deprecated. Unintended visibility, use `getPreMargin` instead
`HashMap<String!, Float!>`	`mMapWeights` This property is deprecated. Unintended visibility, use `getWeight` instead
`State.Chain`	`mStyle`

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!`	`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!)`

From androidx.constraintlayout.core.state.HelperReference

`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!)`

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`

From androidx.constraintlayout.core.state.HelperReference

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

Public constructors

ChainReference

Added in 1.1.0-alpha13

ChainReference(state: State, type: State.Helper)

Public functions

addChainElement

Added in 1.1.0-alpha13

fun addChainElement(
    id: String,
    weight: Float,
    preMargin: Float,
    postMargin: Float
): Unit

Adds the element by the given id to the Chain. The order in which the elements are added is important. It will represent the element's position in the Chain.

Parameters
`id: String`	Id of the element to add
`weight: Float`	Weight used to distribute remaining space to each element
`preMargin: Float`	Additional space in pixels between the added element and the previous one (if any)
`postMargin: Float`	Additional space in pixels between the added element and the next one (if any)

bias

Added in 1.1.0-alpha13

fun bias(bias: Float): ChainReference

getBias

Added in 1.1.0-alpha13

fun getBias(): Float

getStyle

Added in 1.1.0-alpha13

fun getStyle(): State.Chain

style

Added in 1.1.0-alpha13

fun style(style: State.Chain): ChainReference

Sets the style.

Parameters
`style: State.Chain`	Defines the way the chain will lay out its elements

Returns
`ChainReference`	This same instance

Protected functions

getPostMargin

Added in 1.1.0-alpha13

protected fun getPostMargin(id: String): Float

getPreMargin

Added in 1.1.0-alpha13

protected fun getPreMargin(id: String): Float

getWeight

Added in 1.1.0-alpha13

protected fun getWeight(id: String): Float

Protected properties

mBias

Added in 1.1.0-alpha13

protected val mBias: Float

mMapPostMargin

Added in 1.1.0-alpha13

Deprecated in 1.1.0-alpha13

protected val mMapPostMargin: HashMap<String!, Float!>

mMapPreMargin

Added in 1.1.0-alpha13

Deprecated in 1.1.0-alpha13

protected val mMapPreMargin: HashMap<String!, Float!>

mMapWeights

Added in 1.1.0-alpha13

Deprecated in 1.1.0-alpha13

protected val mMapWeights: HashMap<String!, Float!>

mStyle

Added in 1.1.0-alpha13

protected val mStyle: State.Chain