ConstraintReference (core 1.1.0-alpha04 API)

java.lang.Object
- androidx.constraintlayout.core.state.ConstraintReference

All Implemented Interfaces:: Reference

Direct Known Subclasses:: HelperReference

public class ConstraintReference
extends java.lang.Object
implements Reference

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ConstraintReference.ConstraintReferenceFactory

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ConstraintReference.ConstraintReferenceFactory`

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.Object`	`mBottomToBottom`
`protected java.lang.Object`	`mBottomToTop`
`protected java.lang.Object`	`mEndToEnd`
`protected java.lang.Object`	`mEndToStart`
`protected float`	`mHorizontalBias`
`protected java.lang.Object`	`mLeftToLeft`
`protected java.lang.Object`	`mLeftToRight`
`protected int`	`mMarginBottom`
`protected int`	`mMarginBottomGone`
`protected int`	`mMarginEnd`
`protected int`	`mMarginEndGone`
`protected int`	`mMarginLeft`
`protected int`	`mMarginLeftGone`
`protected int`	`mMarginRight`
`protected int`	`mMarginRightGone`
`protected int`	`mMarginStart`
`protected int`	`mMarginStartGone`
`protected int`	`mMarginTop`
`protected int`	`mMarginTopGone`
`protected java.lang.Object`	`mRightToLeft`
`protected java.lang.Object`	`mRightToRight`
`protected java.lang.Object`	`mStartToEnd`
`protected java.lang.Object`	`mStartToStart`
`protected java.lang.Object`	`mTopToBottom`
`protected java.lang.Object`	`mTopToTop`
`protected float`	`mVerticalBias`

Constructor Summary

Constructors
Constructor Description

ConstraintReference(State state)

Constructors
Constructor	Description
`ConstraintReference(State state)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCustomColor(java.lang.String name, int color)`
`void`	`addCustomFloat(java.lang.String name, float value)`
`ConstraintReference`	`alpha(float alpha)`
`void`	`apply()`
`void`	`applyWidgetConstraints()`	apply all the constraints attributes of the mConstraintWidget
`ConstraintReference`	`baseline()`
`ConstraintReference`	`baselineToBaseline(java.lang.Object reference)`
`ConstraintReference`	`baselineToBottom(java.lang.Object reference)`
`ConstraintReference`	`baselineToTop(java.lang.Object reference)`
`ConstraintReference`	`bias(float value)`
`ConstraintReference`	`bottom()`
`ConstraintReference`	`bottomToBottom(java.lang.Object reference)`
`ConstraintReference`	`bottomToTop(java.lang.Object reference)`
`ConstraintReference`	`centerHorizontally(java.lang.Object reference)`
`ConstraintReference`	`centerVertically(java.lang.Object reference)`
`ConstraintReference`	`circularConstraint(java.lang.Object reference, float angle, float distance)`
`ConstraintReference`	`clear()`
`ConstraintReference`	`clearAll()`	Clears all constraints.
`ConstraintReference`	`clearHorizontal()`
`ConstraintReference`	`clearVertical()`
`ConstraintWidget`	`createConstraintWidget()`
`ConstraintReference`	`end()`
`ConstraintReference`	`endToEnd(java.lang.Object reference)`
`ConstraintReference`	`endToStart(java.lang.Object reference)`
`float`	`getAlpha()`
`ConstraintWidget`	`getConstraintWidget()`
`Facade`	`getFacade()`
`Dimension`	`getHeight()`
`int`	`getHorizontalChainStyle()`
`float`	`getHorizontalChainWeight()`
`java.lang.Object`	`getKey()`
`float`	`getPivotX()`
`float`	`getPivotY()`
`float`	`getRotationX()`
`float`	`getRotationY()`
`float`	`getRotationZ()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`java.lang.String`	`getTag()`
`float`	`getTranslationX()`
`float`	`getTranslationY()`
`float`	`getTranslationZ()`
`int`	`getVerticalChainStyle(int chainStyle)`
`float`	`getVerticalChainWeight()`
`java.lang.Object`	`getView()`
`Dimension`	`getWidth()`
`ConstraintReference`	`height(Dimension dimension)`
`ConstraintReference`	`horizontalBias(float value)`
`ConstraintReference`	`left()`
`ConstraintReference`	`leftToLeft(java.lang.Object reference)`
`ConstraintReference`	`leftToRight(java.lang.Object reference)`
`ConstraintReference`	`margin(int value)`
`ConstraintReference`	`margin(java.lang.Object marginValue)`
`ConstraintReference`	`marginGone(int value)`
`ConstraintReference`	`marginGone(java.lang.Object marginGoneValue)`
`ConstraintReference`	`pivotX(float x)`
`ConstraintReference`	`pivotY(float y)`
`ConstraintReference`	`right()`
`ConstraintReference`	`rightToLeft(java.lang.Object reference)`
`ConstraintReference`	`rightToRight(java.lang.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(java.lang.Object key)`
`void`	`setTag(java.lang.String tag)`
`void`	`setVerticalChainStyle(int chainStyle)`
`void`	`setVerticalChainWeight(float weight)`
`void`	`setView(java.lang.Object view)`
`ConstraintReference`	`setWidth(Dimension dimension)`
`ConstraintReference`	`start()`
`ConstraintReference`	`startToEnd(java.lang.Object reference)`
`ConstraintReference`	`startToStart(java.lang.Object reference)`
`ConstraintReference`	`top()`
`ConstraintReference`	`topToBottom(java.lang.Object reference)`
`ConstraintReference`	`topToTop(java.lang.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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mHorizontalBias
```
protected float mHorizontalBias
```

mVerticalBias
```
protected float mVerticalBias
```

mMarginLeft
```
protected int mMarginLeft
```

mMarginRight
```
protected int mMarginRight
```

mMarginStart
```
protected int mMarginStart
```

mMarginEnd
```
protected int mMarginEnd
```

mMarginTop
```
protected int mMarginTop
```

mMarginBottom
```
protected int mMarginBottom
```

mMarginLeftGone
```
protected int mMarginLeftGone
```

mMarginRightGone
```
protected int mMarginRightGone
```

mMarginStartGone
```
protected int mMarginStartGone
```

mMarginEndGone
```
protected int mMarginEndGone
```

mMarginTopGone
```
protected int mMarginTopGone
```

mMarginBottomGone
```
protected int mMarginBottomGone
```

mLeftToLeft
```
protected java.lang.Object mLeftToLeft
```

mLeftToRight

protected java.lang.Object mLeftToRight

mRightToLeft

protected java.lang.Object mRightToLeft

mRightToRight

protected java.lang.Object mRightToRight

mStartToStart

protected java.lang.Object mStartToStart

mStartToEnd
```
protected java.lang.Object mStartToEnd
```

mEndToStart
```
protected java.lang.Object mEndToStart
```

mEndToEnd
```
protected java.lang.Object mEndToEnd
```

mTopToTop
```
protected java.lang.Object mTopToTop
```

mTopToBottom

protected java.lang.Object mTopToBottom

mBottomToTop

protected java.lang.Object mBottomToTop

mBottomToBottom

protected java.lang.Object mBottomToBottom

Constructor Detail

ConstraintReference

public ConstraintReference(State state)

Method Detail

setKey

public void setKey(java.lang.Object key)

Specified by:: setKey in interface Reference

getKey
```
public java.lang.Object getKey()
```
Specified by:

getKey in interface Reference

setTag

public void setTag(java.lang.String tag)

getTag
```
public java.lang.String getTag()
```

setView

public void setView(java.lang.Object view)

getView
```
public java.lang.Object getView()
```

setFacade

public void setFacade(Facade facade)

getFacade
```
public Facade getFacade()
```
Specified by:

getFacade in interface Reference

setConstraintWidget
```
public void setConstraintWidget(ConstraintWidget widget)
```
Specified by:

setConstraintWidget in interface Reference

getConstraintWidget
```
public ConstraintWidget getConstraintWidget()
```
Specified by:

getConstraintWidget in interface Reference

createConstraintWidget

public ConstraintWidget createConstraintWidget()

validate

public void validate()
              throws androidx.constraintlayout.core.state.ConstraintReference.IncorrectConstraintException

Validate the constraints

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

setHorizontalChainStyle

public void setHorizontalChainStyle(int chainStyle)

getHorizontalChainStyle
```
public int getHorizontalChainStyle()
```

setVerticalChainStyle

public void setVerticalChainStyle(int chainStyle)

getVerticalChainStyle

public int getVerticalChainStyle(int chainStyle)

getHorizontalChainWeight

public float getHorizontalChainWeight()

setHorizontalChainWeight

public void setHorizontalChainWeight(float weight)

getVerticalChainWeight
```
public float getVerticalChainWeight()
```

setVerticalChainWeight

public void setVerticalChainWeight(float weight)

clearVertical

public ConstraintReference clearVertical()

clearHorizontal

public ConstraintReference clearHorizontal()

getTranslationX
```
public float getTranslationX()
```

getTranslationY
```
public float getTranslationY()
```

getTranslationZ
```
public float getTranslationZ()
```

getScaleX
```
public float getScaleX()
```

getScaleY
```
public float getScaleY()
```

getAlpha
```
public float getAlpha()
```

getPivotX
```
public float getPivotX()
```

getPivotY
```
public float getPivotY()
```

getRotationX
```
public float getRotationX()
```

getRotationY
```
public float getRotationY()
```

getRotationZ
```
public float getRotationZ()
```

pivotX

public ConstraintReference pivotX(float x)

pivotY

public ConstraintReference pivotY(float y)

rotationX

public ConstraintReference rotationX(float x)

rotationY

public ConstraintReference rotationY(float y)

rotationZ

public ConstraintReference rotationZ(float z)

translationX

public ConstraintReference translationX(float x)

translationY

public ConstraintReference translationY(float y)

translationZ

public ConstraintReference translationZ(float z)

scaleX

public ConstraintReference scaleX(float x)

scaleY

public ConstraintReference scaleY(float y)

alpha

public ConstraintReference alpha(float alpha)

visibility

public ConstraintReference visibility(int visibility)

left
```
public ConstraintReference left()
```

right
```
public ConstraintReference right()
```

start
```
public ConstraintReference start()
```

end
```
public ConstraintReference end()
```

top
```
public ConstraintReference top()
```

bottom
```
public ConstraintReference bottom()
```

baseline
```
public ConstraintReference baseline()
```

addCustomColor

public void addCustomColor(java.lang.String name,
                           int color)

addCustomFloat

public void addCustomFloat(java.lang.String name,
                           float value)

leftToLeft

public ConstraintReference leftToLeft(java.lang.Object reference)

leftToRight

public ConstraintReference leftToRight(java.lang.Object reference)

rightToLeft

public ConstraintReference rightToLeft(java.lang.Object reference)

rightToRight

public ConstraintReference rightToRight(java.lang.Object reference)

startToStart

public ConstraintReference startToStart(java.lang.Object reference)

startToEnd

public ConstraintReference startToEnd(java.lang.Object reference)

endToStart

public ConstraintReference endToStart(java.lang.Object reference)

endToEnd

public ConstraintReference endToEnd(java.lang.Object reference)

topToTop

public ConstraintReference topToTop(java.lang.Object reference)

topToBottom

public ConstraintReference topToBottom(java.lang.Object reference)

bottomToTop

public ConstraintReference bottomToTop(java.lang.Object reference)

bottomToBottom

public ConstraintReference bottomToBottom(java.lang.Object reference)

baselineToBaseline

public ConstraintReference baselineToBaseline(java.lang.Object reference)

baselineToTop

public ConstraintReference baselineToTop(java.lang.Object reference)

baselineToBottom

public ConstraintReference baselineToBottom(java.lang.Object reference)

centerHorizontally

public ConstraintReference centerHorizontally(java.lang.Object reference)

centerVertically

public ConstraintReference centerVertically(java.lang.Object reference)

circularConstraint

public ConstraintReference circularConstraint(java.lang.Object reference,
                                              float angle,
                                              float distance)

width

public ConstraintReference width(Dimension dimension)

height

public ConstraintReference height(Dimension dimension)

getWidth
```
public Dimension getWidth()
```

setWidth

public ConstraintReference setWidth(Dimension dimension)

getHeight
```
public Dimension getHeight()
```

setHeight

public ConstraintReference setHeight(Dimension dimension)

margin

public ConstraintReference margin(java.lang.Object marginValue)

marginGone

public ConstraintReference marginGone(java.lang.Object marginGoneValue)

margin

public ConstraintReference margin(int value)

marginGone

public ConstraintReference marginGone(int value)

horizontalBias

public ConstraintReference horizontalBias(float value)

verticalBias

public ConstraintReference verticalBias(float value)

bias

public ConstraintReference bias(float value)

clearAll
```
public ConstraintReference clearAll()
```
Clears all constraints.

clear
```
public ConstraintReference clear()
```

applyWidgetConstraints
```
public void applyWidgetConstraints()
```
apply all the constraints attributes of the mConstraintWidget

apply
```
public void apply()
```
Specified by:

apply in interface Reference

Class ConstraintReference

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mHorizontalBias

mVerticalBias

mMarginLeft

mMarginRight

mMarginStart

mMarginEnd

mMarginTop

mMarginBottom

mMarginLeftGone

mMarginRightGone

mMarginStartGone

mMarginEndGone

mMarginTopGone

mMarginBottomGone

mLeftToLeft

mLeftToRight

mRightToLeft

mRightToRight

mStartToStart

mStartToEnd

mEndToStart

mEndToEnd

mTopToTop

mTopToBottom

mBottomToTop

mBottomToBottom

Constructor Detail

ConstraintReference

Method Detail

setKey

getKey

setTag

getTag

setView

getView

setFacade

getFacade

setConstraintWidget

getConstraintWidget

createConstraintWidget

validate

setHorizontalChainStyle

getHorizontalChainStyle

setVerticalChainStyle

getVerticalChainStyle

getHorizontalChainWeight

setHorizontalChainWeight

getVerticalChainWeight

setVerticalChainWeight

clearVertical

clearHorizontal

getTranslationX

getTranslationY

getTranslationZ

getScaleX

getScaleY

getAlpha

getPivotX

getPivotY

getRotationX

getRotationY

getRotationZ

pivotX

pivotY

rotationX

rotationY

rotationZ

translationX

translationY

translationZ

scaleX

scaleY

alpha