ChainReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

public class ChainReference extends HelperReference

java.lang.Object
↳	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

Protected fields
`float`	`mBias`
`@NonNull HashMap<String, Float>`	`mMapPostMargin` This field is deprecated. Unintended visibility, use `getPostMargin` instead
`@NonNull HashMap<String, Float>`	`mMapPreMargin` This field is deprecated. Unintended visibility, use `getPreMargin` instead
`@NonNull HashMap<String, Float>`	`mMapWeights` This field is deprecated. Unintended visibility, use `getWeight` instead
`@NonNull State.Chain`	`mStyle`

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

Public methods
`void`	`addChainElement( @NonNull String id, float weight, float preMargin, float postMargin )` Adds the element by the given id to the Chain.
`@NonNull ChainReference`	`bias(float bias)`
`float`	`getBias()`
`@NonNull State.Chain`	`getStyle()`
`@NonNull ChainReference`	`style(@NonNull State.Chain style)` Sets the `style`.

Protected methods
`float`	`getPostMargin(@NonNull String id)`
`float`	`getPreMargin(@NonNull String id)`
`float`	`getWeight(@NonNull String id)`

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`

From androidx.constraintlayout.core.state.HelperReference

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

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

From androidx.constraintlayout.core.state.HelperReference

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

Protected fields

mBias

Added in 1.1.0

protected float mBias

mMapPostMargin

Added in 1.1.0

Deprecated in 1.1.0

protected @NonNull HashMap<String, Float> mMapPostMargin

mMapPreMargin

Added in 1.1.0

Deprecated in 1.1.0

protected @NonNull HashMap<String, Float> mMapPreMargin

mMapWeights

Added in 1.1.0

Deprecated in 1.1.0

protected @NonNull HashMap<String, Float> mMapWeights

mStyle

Added in 1.1.0

protected @NonNull State.Chain mStyle

Public constructors

ChainReference

Added in 1.1.0

public ChainReference(@NonNull State state, @NonNull State.Helper type)

Public methods

addChainElement

Added in 1.1.0

public void addChainElement(
    @NonNull String id,
    float weight,
    float preMargin,
    float postMargin
)

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
`@NonNull String id`	Id of the element to add
`float weight`	Weight used to distribute remaining space to each element
`float preMargin`	Additional space in pixels between the added element and the previous one (if any)
`float postMargin`	Additional space in pixels between the added element and the next one (if any)

bias

Added in 1.1.0

public @NonNull ChainReference bias(float bias)

getBias

Added in 1.1.0

public float getBias()

getStyle

Added in 1.1.0

public @NonNull State.Chain getStyle()

style

Added in 1.1.0

public @NonNull ChainReference style(@NonNull State.Chain style)

Sets the style.

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

Returns
`@NonNull ChainReference`	This same instance

Protected methods

getPostMargin

Added in 1.1.0

protected float getPostMargin(@NonNull String id)

getPreMargin

Added in 1.1.0

protected float getPreMargin(@NonNull String id)

getWeight

Added in 1.1.0

protected float getWeight(@NonNull String id)