ConstraintReference

Artifact: androidx.constraintlayout:constraintlayout-core

View Source

Added in 1.1.2

---

Kotlin |Java

class ConstraintReference : Reference

Known direct subclasses

HelperReference

HelperReference

Known indirect subclasses

AlignHorizontallyReference, AlignVerticallyReference, BarrierReference, ChainReference, FlowReference, GridReference, HorizontalChainReference, VerticalChainReference

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
HorizontalChainReference
VerticalChainReference

---

Summary

Nested types
interface ConstraintReference.ConstraintReferenceFactory

Public constructors
ConstraintReference(state: State!)

Public functions
Unit	addCustomColor(name: String!, color: Int)
Unit	addCustomFloat(name: String!, value: Float)
ConstraintReference!	alpha(alpha: Float)
Unit	apply()
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()
ConstraintWidget!	getConstraintWidget()
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!)

Protected properties
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

ConstraintReference

Added in 1.1.2

ConstraintReference(state: State!)

Public functions

addCustomColor

Added in 1.1.2

fun addCustomColor(name: String!, color: Int): Unit

addCustomFloat

Added in 1.1.2

fun addCustomFloat(name: String!, value: Float): Unit

alpha

Added in 1.1.2

fun alpha(alpha: Float): ConstraintReference!

apply

Added in 1.1.2

fun apply(): Unit

applyWidgetConstraints

Added in 1.1.2

fun applyWidgetConstraints(): Unit

apply all the constraints attributes of the mConstraintWidget

baseline

Added in 1.1.2

fun baseline(): ConstraintReference!

baselineToBaseline

Added in 1.1.2

fun baselineToBaseline(reference: Any!): ConstraintReference!

baselineToBottom

Added in 1.1.2

fun baselineToBottom(reference: Any!): ConstraintReference!

baselineToTop

Added in 1.1.2

fun baselineToTop(reference: Any!): ConstraintReference!

bias

Added in 1.1.2

fun bias(value: Float): ConstraintReference!

bottom

Added in 1.1.2

fun bottom(): ConstraintReference!

bottomToBottom

Added in 1.1.2

fun bottomToBottom(reference: Any!): ConstraintReference!

bottomToTop

Added in 1.1.2

fun bottomToTop(reference: Any!): ConstraintReference!

centerHorizontally

Added in 1.1.2

fun centerHorizontally(reference: Any!): ConstraintReference!

centerVertically

Added in 1.1.2

fun centerVertically(reference: Any!): ConstraintReference!

circularConstraint

Added in 1.1.2

fun circularConstraint(reference: Any!, angle: Float, distance: Float): ConstraintReference!

clear

Added in 1.1.2

fun clear(): ConstraintReference!

clearAll

Added in 1.1.2

fun clearAll(): ConstraintReference!

Clears all constraints.

clearHorizontal

Added in 1.1.2

fun clearHorizontal(): ConstraintReference!

clearVertical

Added in 1.1.2

fun clearVertical(): ConstraintReference!

createConstraintWidget

Added in 1.1.2

fun createConstraintWidget(): ConstraintWidget!

end

Added in 1.1.2

fun end(): ConstraintReference!

endToEnd

Added in 1.1.2

fun endToEnd(reference: Any!): ConstraintReference!

endToStart

Added in 1.1.2

fun endToStart(reference: Any!): ConstraintReference!

getAlpha

Added in 1.1.2

fun getAlpha(): Float

getConstraintWidget

Added in 1.1.2

fun getConstraintWidget(): ConstraintWidget!

getFacade

Added in 1.1.2

fun getFacade(): Facade!

getHeight

Added in 1.1.2

fun getHeight(): Dimension!

getHorizontalChainStyle

Added in 1.1.2

fun getHorizontalChainStyle(): Int

getHorizontalChainWeight

Added in 1.1.2

fun getHorizontalChainWeight(): Float

getKey

Added in 1.1.2

fun getKey(): Any!

getPivotX

Added in 1.1.2

fun getPivotX(): Float

getPivotY

Added in 1.1.2

fun getPivotY(): Float

getRotationX

Added in 1.1.2

fun getRotationX(): Float

getRotationY

Added in 1.1.2

fun getRotationY(): Float

getRotationZ

Added in 1.1.2

fun getRotationZ(): Float

getScaleX

Added in 1.1.2

fun getScaleX(): Float

getScaleY

Added in 1.1.2

fun getScaleY(): Float

getTag

Added in 1.1.2

fun getTag(): String!

getTranslationX

Added in 1.1.2

fun getTranslationX(): Float

getTranslationY

Added in 1.1.2

fun getTranslationY(): Float

getTranslationZ

Added in 1.1.2

fun getTranslationZ(): Float

getVerticalChainStyle

Added in 1.1.2

fun getVerticalChainStyle(chainStyle: Int): Int

getVerticalChainWeight

Added in 1.1.2

fun getVerticalChainWeight(): Float

getView

Added in 1.1.2

fun getView(): Any!

getWidth

Added in 1.1.2

fun getWidth(): Dimension!

height

Added in 1.1.2

fun height(dimension: Dimension!): ConstraintReference!

horizontalBias

Added in 1.1.2

fun horizontalBias(value: Float): ConstraintReference!

left

Added in 1.1.2

fun left(): ConstraintReference!

leftToLeft

Added in 1.1.2

fun leftToLeft(reference: Any!): ConstraintReference!

leftToRight

Added in 1.1.2

fun leftToRight(reference: Any!): ConstraintReference!

margin

Added in 1.1.2

fun margin(marginValue: Any!): ConstraintReference!

margin

Added in 1.1.2

fun margin(value: Int): ConstraintReference!

marginGone

Added in 1.1.2

fun marginGone(marginGoneValue: Any!): ConstraintReference!

marginGone

Added in 1.1.2

fun marginGone(value: Int): ConstraintReference!

pivotX

Added in 1.1.2

fun pivotX(x: Float): ConstraintReference!

pivotY

Added in 1.1.2

fun pivotY(y: Float): ConstraintReference!

right

Added in 1.1.2

fun right(): ConstraintReference!

rightToLeft

Added in 1.1.2

fun rightToLeft(reference: Any!): ConstraintReference!

rightToRight

Added in 1.1.2

fun rightToRight(reference: Any!): ConstraintReference!

rotationX

Added in 1.1.2

fun rotationX(x: Float): ConstraintReference!

rotationY

Added in 1.1.2

fun rotationY(y: Float): ConstraintReference!

rotationZ

Added in 1.1.2

fun rotationZ(z: Float): ConstraintReference!

scaleX

Added in 1.1.2

fun scaleX(x: Float): ConstraintReference!

scaleY

Added in 1.1.2

fun scaleY(y: Float): ConstraintReference!

setConstraintWidget

Added in 1.1.2

fun setConstraintWidget(widget: ConstraintWidget!): Unit

setFacade

Added in 1.1.2

fun setFacade(facade: Facade!): Unit

setHeight

Added in 1.1.2

fun setHeight(dimension: Dimension!): ConstraintReference!

setHorizontalChainStyle

Added in 1.1.2

fun setHorizontalChainStyle(chainStyle: Int): Unit

setHorizontalChainWeight

Added in 1.1.2

fun setHorizontalChainWeight(weight: Float): Unit

setKey

Added in 1.1.2

fun setKey(key: Any!): Unit

setTag

Added in 1.1.2

fun setTag(tag: String!): Unit

setVerticalChainStyle

Added in 1.1.2

fun setVerticalChainStyle(chainStyle: Int): Unit

setVerticalChainWeight

Added in 1.1.2

fun setVerticalChainWeight(weight: Float): Unit

setView

Added in 1.1.2

fun setView(view: Any!): Unit

setWidth

Added in 1.1.2

fun setWidth(dimension: Dimension!): ConstraintReference!

start

Added in 1.1.2

fun start(): ConstraintReference!

startToEnd

Added in 1.1.2

fun startToEnd(reference: Any!): ConstraintReference!

startToStart

Added in 1.1.2

fun startToStart(reference: Any!): ConstraintReference!

top

Added in 1.1.2

fun top(): ConstraintReference!

topToBottom

Added in 1.1.2

fun topToBottom(reference: Any!): ConstraintReference!

topToTop

Added in 1.1.2

fun topToTop(reference: Any!): ConstraintReference!

translationX

Added in 1.1.2

fun translationX(x: Float): ConstraintReference!

translationY

Added in 1.1.2

fun translationY(y: Float): ConstraintReference!

translationZ

Added in 1.1.2

fun translationZ(z: Float): ConstraintReference!

validate

Added in 1.1.2

fun validate(): Unit

Validate the constraints

Throws
androidx.constraintlayout.core.state.ConstraintReference.IncorrectConstraintException

verticalBias

Added in 1.1.2

fun verticalBias(value: Float): ConstraintReference!

visibility

Added in 1.1.2

fun visibility(visibility: Int): ConstraintReference!

width

Added in 1.1.2

fun width(dimension: Dimension!): ConstraintReference!

Protected properties

mBottomToBottom

Added in 1.1.2

protected val mBottomToBottom: Any!

mBottomToTop

Added in 1.1.2

protected val mBottomToTop: Any!

mEndToEnd

Added in 1.1.2

protected val mEndToEnd: Any!

mEndToStart

Added in 1.1.2

protected val mEndToStart: Any!

mHorizontalBias

Added in 1.1.2

protected val mHorizontalBias: Float

mLeftToLeft

Added in 1.1.2

protected val mLeftToLeft: Any!

mLeftToRight

Added in 1.1.2

protected val mLeftToRight: Any!

mMarginBottom

Added in 1.1.2

protected val mMarginBottom: Int

mMarginBottomGone

Added in 1.1.2

protected val mMarginBottomGone: Int

mMarginEnd

Added in 1.1.2

protected val mMarginEnd: Int

mMarginEndGone

Added in 1.1.2

protected val mMarginEndGone: Int

mMarginLeft

Added in 1.1.2

protected val mMarginLeft: Int

mMarginLeftGone

Added in 1.1.2

protected val mMarginLeftGone: Int

mMarginRight

Added in 1.1.2

protected val mMarginRight: Int

mMarginRightGone

Added in 1.1.2

protected val mMarginRightGone: Int

mMarginStart

Added in 1.1.2

protected val mMarginStart: Int

mMarginStartGone

Added in 1.1.2

protected val mMarginStartGone: Int

mMarginTop

Added in 1.1.2

protected val mMarginTop: Int

mMarginTopGone

Added in 1.1.2

protected val mMarginTopGone: Int

mRightToLeft

Added in 1.1.2

protected val mRightToLeft: Any!

mRightToRight

Added in 1.1.2

protected val mRightToRight: Any!

mStartToEnd

Added in 1.1.2

protected val mStartToEnd: Any!

mStartToStart

Added in 1.1.2

protected val mStartToStart: Any!

mTopToBottom

Added in 1.1.2

protected val mTopToBottom: Any!

mTopToTop

Added in 1.1.2

protected val mTopToTop: Any!

mVerticalBias

Added in 1.1.2

protected val mVerticalBias: Float