Package androidx.constraintlayout.core.dsl

Class Constraint

java.lang.Object

androidx.constraintlayout.core.dsl.Constraint

public class Constraint
extends java.lang.Object

Provides the API for creating a Constraint Object for use in the Core ConstraintLayout & MotionLayout system

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Constraint.Anchor
static class	Constraint.Behaviour
static class	Constraint.ChainMode
class	Constraint.HAnchor
static class	Constraint.HSide
static class	Constraint.Side
class	Constraint.VAnchor
static class	Constraint.VSide

Field Summary

Fields

Modifier and Type	Field	Description
static Constraint	PARENT

Constructor Summary

Constructors

Constructor	Description
Constraint(java.lang.String id)

Method Summary

Modifier and Type	Method	Description
protected void	append(java.lang.StringBuilder builder, java.lang.String name, float value)
java.lang.String	convertStringArrayToString(java.lang.String[] str)	convert a String array into a String representation
Constraint.VAnchor	getBaseline()	get baseline anchor
Constraint.VAnchor	getBottom()	get bottom anchor
float	getCircleAngle()	get circleAngle
java.lang.String	getCircleConstraint()	get circleConstraint
int	getCircleRadius()	get circleRadius
java.lang.String	getDimensionRatio()	get dimensionRatio
int	getEditorAbsoluteX()	get editorAbsoluteX
int	getEditorAbsoluteY()	get editorAbsoluteY
Constraint.HAnchor	getEnd()	get end anchor
int	getHeight()	get height
Constraint.Behaviour	getHeightDefault()	get heightDefault
int	getHeightMax()	get heightMax
int	getHeightMin()	get heightMin
float	getHeightPercent()	get heightPercent
float	getHorizontalBias()	get horizontalBias
Constraint.ChainMode	getHorizontalChainStyle()	get horizontalChainStyle
float	getHorizontalWeight()	get horizontalWeight
Constraint.HAnchor	getLeft()	get left anchor
java.lang.String[]	getReferenceIds()	get referenceIds
Constraint.HAnchor	getRight()	get right anchor
Constraint.HAnchor	getStart()	get start anchor
Constraint.VAnchor	getTop()	get top anchor
float	getVerticalBias()	get verticalBias
Constraint.ChainMode	getVerticalChainStyle()	get verticalChainStyle
float	getVerticalWeight()	get verticalWeight
int	getWidth()	get width
Constraint.Behaviour	getWidthDefault()	get widthDefault
int	getWidthMax()	get widthMax
int	getWidthMin()	get widthMin
float	getWidthPercent()	get widthPercent
boolean	isConstrainedHeight()	is constrainedHeight
boolean	isConstrainedWidth()	is constrainedWidth
void	linkToBaseline(Constraint.VAnchor anchor)	Connect anchor to Baseline
void	linkToBaseline(Constraint.VAnchor anchor, int margin)	Connect anchor to Baseline
void	linkToBaseline(Constraint.VAnchor anchor, int margin, int goneMargin)	Connect anchor to Baseline
void	linkToBottom(Constraint.VAnchor anchor)	Connect anchor to Bottom
void	linkToBottom(Constraint.VAnchor anchor, int margin)	Connect anchor to Bottom
void	linkToBottom(Constraint.VAnchor anchor, int margin, int goneMargin)	Connect anchor to Bottom
void	linkToEnd(Constraint.HAnchor anchor)	Connect anchor to End
void	linkToEnd(Constraint.HAnchor anchor, int margin)	Connect anchor to End
void	linkToEnd(Constraint.HAnchor anchor, int margin, int goneMargin)	Connect anchor to End
void	linkToLeft(Constraint.HAnchor anchor)	Connect anchor to Left
void	linkToLeft(Constraint.HAnchor anchor, int margin)	Connect anchor to Left
void	linkToLeft(Constraint.HAnchor anchor, int margin, int goneMargin)	Connect anchor to Left
void	linkToRight(Constraint.HAnchor anchor)	Connect anchor to Right
void	linkToRight(Constraint.HAnchor anchor, int margin)	Connect anchor to Right
void	linkToRight(Constraint.HAnchor anchor, int margin, int goneMargin)	Connect anchor to Right
void	linkToStart(Constraint.HAnchor anchor)	Connect anchor to Start
void	linkToStart(Constraint.HAnchor anchor, int margin)	Connect anchor to Start
void	linkToStart(Constraint.HAnchor anchor, int margin, int goneMargin)	Connect anchor to Start
void	linkToTop(Constraint.VAnchor anchor)	Connect anchor to Top
void	linkToTop(Constraint.VAnchor anchor, int margin)	Connect anchor to Top
void	linkToTop(Constraint.VAnchor anchor, int margin, int goneMargin)	Connect anchor to Top
void	setCircleAngle(float circleAngle)	set circleAngle
void	setCircleConstraint(java.lang.String circleConstraint)	set circleConstraint
void	setCircleRadius(int circleRadius)	set circleRadius
void	setConstrainedHeight(boolean constrainedHeight)	set constrainedHeight
void	setConstrainedWidth(boolean constrainedWidth)	set constrainedWidth
void	setDimensionRatio(java.lang.String dimensionRatio)	set dimensionRatio
void	setEditorAbsoluteX(int editorAbsoluteX)	set editorAbsoluteX
void	setEditorAbsoluteY(int editorAbsoluteY)	set editorAbsoluteY
void	setHeight(int height)	set height
void	setHeightDefault(Constraint.Behaviour heightDefault)	set heightDefault
void	setHeightMax(int heightMax)	set heightMax
void	setHeightMin(int heightMin)	set heightMin
void	setHeightPercent(float heightPercent)	set heightPercent
void	setHorizontalBias(float horizontalBias)	set horizontalBias
void	setHorizontalChainStyle(Constraint.ChainMode horizontalChainStyle)	set horizontalChainStyle
void	setHorizontalWeight(float horizontalWeight)	set horizontalWeight
void	setReferenceIds(java.lang.String[] referenceIds)	set referenceIds
void	setVerticalBias(float verticalBias)	set verticalBias
void	setVerticalChainStyle(Constraint.ChainMode verticalChainStyle)	set verticalChainStyle
void	setVerticalWeight(float verticalWeight)	set verticalWeight
void	setWidth(int width)	set width
void	setWidthDefault(Constraint.Behaviour widthDefault)	set widthDefault
void	setWidthMax(int widthMax)	set widthMax
void	setWidthMin(int widthMin)	set widthMin
void	setWidthPercent(float widthPercent)	set widthPercent
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARENT

public static final Constraint PARENT

Constructor Detail

Constraint

public Constraint(java.lang.String id)

Method Detail

getLeft

public Constraint.HAnchor getLeft()

get left anchor

Returns:

left anchor

getRight

public Constraint.HAnchor getRight()

get right anchor

Returns:

right anchor

getTop

public Constraint.VAnchor getTop()

get top anchor

Returns:

top anchor

getBottom

public Constraint.VAnchor getBottom()

get bottom anchor

Returns:

bottom anchor

getStart

public Constraint.HAnchor getStart()

get start anchor

Returns:

start anchor

getEnd

public Constraint.HAnchor getEnd()

get end anchor

Returns:

end anchor

getBaseline

public Constraint.VAnchor getBaseline()

get baseline anchor

Returns:

baseline anchor

getHorizontalBias

public float getHorizontalBias()

get horizontalBias

Returns:

horizontalBias

setHorizontalBias

public void setHorizontalBias(float horizontalBias)

set horizontalBias

Parameters:

horizontalBias -

getVerticalBias

public float getVerticalBias()

get verticalBias

Returns:

verticalBias

setVerticalBias

public void setVerticalBias(float verticalBias)

set verticalBias

Parameters:

verticalBias -

getDimensionRatio

public java.lang.String getDimensionRatio()

get dimensionRatio

Returns:

dimensionRatio

setDimensionRatio

public void setDimensionRatio(java.lang.String dimensionRatio)

set dimensionRatio

Parameters:

dimensionRatio -

getCircleConstraint

public java.lang.String getCircleConstraint()

get circleConstraint

Returns:

circleConstraint

setCircleConstraint

public void setCircleConstraint(java.lang.String circleConstraint)

set circleConstraint

Parameters:

circleConstraint -

getCircleRadius

public int getCircleRadius()

get circleRadius

Returns:

circleRadius

setCircleRadius

public void setCircleRadius(int circleRadius)

set circleRadius

Parameters:

circleRadius -

getCircleAngle

public float getCircleAngle()

get circleAngle

Returns:

circleAngle

setCircleAngle

public void setCircleAngle(float circleAngle)

set circleAngle

Parameters:

circleAngle -

getEditorAbsoluteX

public int getEditorAbsoluteX()

get editorAbsoluteX

Returns:

editorAbsoluteX

setEditorAbsoluteX

public void setEditorAbsoluteX(int editorAbsoluteX)

set editorAbsoluteX

Parameters:

editorAbsoluteX -

getEditorAbsoluteY

public int getEditorAbsoluteY()

get editorAbsoluteY

Returns:

editorAbsoluteY

setEditorAbsoluteY

public void setEditorAbsoluteY(int editorAbsoluteY)

set editorAbsoluteY

Parameters:

editorAbsoluteY -

getVerticalWeight

public float getVerticalWeight()

get verticalWeight

Returns:

verticalWeight

setVerticalWeight

public void setVerticalWeight(float verticalWeight)

set verticalWeight

Parameters:

verticalWeight -

getHorizontalWeight

public float getHorizontalWeight()

get horizontalWeight

Returns:

horizontalWeight

setHorizontalWeight

public void setHorizontalWeight(float horizontalWeight)

set horizontalWeight

Parameters:

horizontalWeight -

getHorizontalChainStyle

public Constraint.ChainMode getHorizontalChainStyle()

get horizontalChainStyle

Returns:

horizontalChainStyle

setHorizontalChainStyle

public void setHorizontalChainStyle(Constraint.ChainMode horizontalChainStyle)

set horizontalChainStyle

Parameters:

horizontalChainStyle -

getVerticalChainStyle

public Constraint.ChainMode getVerticalChainStyle()

get verticalChainStyle

Returns:

verticalChainStyle

setVerticalChainStyle

public void setVerticalChainStyle(Constraint.ChainMode verticalChainStyle)

set verticalChainStyle

Parameters:

verticalChainStyle -

getWidthDefault

public Constraint.Behaviour getWidthDefault()

get widthDefault

Returns:

widthDefault

setWidthDefault

public void setWidthDefault(Constraint.Behaviour widthDefault)

set widthDefault

Parameters:

widthDefault -

getHeightDefault

public Constraint.Behaviour getHeightDefault()

get heightDefault

Returns:

heightDefault

setHeightDefault

public void setHeightDefault(Constraint.Behaviour heightDefault)

set heightDefault

Parameters:

heightDefault -

getWidthMax

public int getWidthMax()

get widthMax

Returns:

widthMax

setWidthMax

public void setWidthMax(int widthMax)

set widthMax

Parameters:

widthMax -

getHeightMax

public int getHeightMax()

get heightMax

Returns:

heightMax

setHeightMax

public void setHeightMax(int heightMax)

set heightMax

Parameters:

heightMax -

getWidthMin

public int getWidthMin()

get widthMin

Returns:

widthMin

setWidthMin

public void setWidthMin(int widthMin)

set widthMin

Parameters:

widthMin -

getHeightMin

public int getHeightMin()

get heightMin

Returns:

heightMin

setHeightMin

public void setHeightMin(int heightMin)

set heightMin

Parameters:

heightMin -

getWidthPercent

public float getWidthPercent()

get widthPercent

Returns:

setWidthPercent

public void setWidthPercent(float widthPercent)

set widthPercent

Parameters:

widthPercent -

getHeightPercent

public float getHeightPercent()

get heightPercent

Returns:

heightPercent

setHeightPercent

public void setHeightPercent(float heightPercent)

set heightPercent

Parameters:

heightPercent -

getReferenceIds

public java.lang.String[] getReferenceIds()

get referenceIds

Returns:

referenceIds

setReferenceIds

public void setReferenceIds(java.lang.String[] referenceIds)

set referenceIds

Parameters:

referenceIds -

isConstrainedWidth

public boolean isConstrainedWidth()

is constrainedWidth

Returns:

true if width constrained

setConstrainedWidth

public void setConstrainedWidth(boolean constrainedWidth)

set constrainedWidth

Parameters:

constrainedWidth -

isConstrainedHeight

public boolean isConstrainedHeight()

is constrainedHeight

Returns:

true if height constrained

setConstrainedHeight

public void setConstrainedHeight(boolean constrainedHeight)

set constrainedHeight

Parameters:

constrainedHeight -

getWidth

public int getWidth()

get width

Returns:

width

setWidth

public void setWidth(int width)

set width

Parameters:

width -

getHeight

public int getHeight()

get height

Returns:

height

setHeight

public void setHeight(int height)

set height

Parameters:

height -

linkToTop

public void linkToTop(Constraint.VAnchor anchor)

Connect anchor to Top

Parameters:

anchor - anchor to be connected

linkToLeft

public void linkToLeft(Constraint.HAnchor anchor)

Connect anchor to Left

Parameters:

anchor - anchor to be connected

linkToRight

public void linkToRight(Constraint.HAnchor anchor)

Connect anchor to Right

Parameters:

anchor - anchor to be connected

linkToStart

public void linkToStart(Constraint.HAnchor anchor)

Connect anchor to Start

Parameters:

anchor - anchor to be connected

linkToEnd

public void linkToEnd(Constraint.HAnchor anchor)

Connect anchor to End

Parameters:

anchor - anchor to be connected

linkToBottom

public void linkToBottom(Constraint.VAnchor anchor)

Connect anchor to Bottom

Parameters:

anchor - anchor to be connected

linkToBaseline

public void linkToBaseline(Constraint.VAnchor anchor)

Connect anchor to Baseline

Parameters:

anchor - anchor to be connected

linkToTop

public void linkToTop(Constraint.VAnchor anchor,
                      int margin)

Connect anchor to Top

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToLeft

public void linkToLeft(Constraint.HAnchor anchor,
                       int margin)

Connect anchor to Left

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToRight

public void linkToRight(Constraint.HAnchor anchor,
                        int margin)

Connect anchor to Right

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToStart

public void linkToStart(Constraint.HAnchor anchor,
                        int margin)

Connect anchor to Start

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToEnd

public void linkToEnd(Constraint.HAnchor anchor,
                      int margin)

Connect anchor to End

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToBottom

public void linkToBottom(Constraint.VAnchor anchor,
                         int margin)

Connect anchor to Bottom

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToBaseline

public void linkToBaseline(Constraint.VAnchor anchor,
                           int margin)

Connect anchor to Baseline

Parameters:

anchor - anchor to be connected

margin - value of the margin

linkToTop

public void linkToTop(Constraint.VAnchor anchor,
                      int margin,
                      int goneMargin)

Connect anchor to Top

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToLeft

public void linkToLeft(Constraint.HAnchor anchor,
                       int margin,
                       int goneMargin)

Connect anchor to Left

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToRight

public void linkToRight(Constraint.HAnchor anchor,
                        int margin,
                        int goneMargin)

Connect anchor to Right

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToStart

public void linkToStart(Constraint.HAnchor anchor,
                        int margin,
                        int goneMargin)

Connect anchor to Start

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToEnd

public void linkToEnd(Constraint.HAnchor anchor,
                      int margin,
                      int goneMargin)

Connect anchor to End

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToBottom

public void linkToBottom(Constraint.VAnchor anchor,
                         int margin,
                         int goneMargin)

Connect anchor to Bottom

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

linkToBaseline

public void linkToBaseline(Constraint.VAnchor anchor,
                           int margin,
                           int goneMargin)

Connect anchor to Baseline

Parameters:

anchor - anchor to be connected

margin - value of the margin

goneMargin - value of the goneMargin

convertStringArrayToString

public java.lang.String convertStringArrayToString(java.lang.String[] str)

convert a String array into a String representation

Parameters:

str - String array to be converted

Returns:

a String representation of the input array.

append

protected void append(java.lang.StringBuilder builder,
                      java.lang.String name,
                      float value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object