Package androidx.constraintlayout.core.state

Class State

java.lang.Object

androidx.constraintlayout.core.state.State

public class State
extends java.lang.Object

Represents a full state of a ConstraintLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	State.Chain
static class	State.Constraint
static class	State.Direction
static class	State.Helper

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.HashMap<java.lang.Object,HelperReference>	mHelperReferences
ConstraintReference	mParent
protected java.util.HashMap<java.lang.Object,Reference>	mReferences
static java.lang.Integer	PARENT

Constructor Summary

Constructors

Constructor	Description
State()

Method Summary

Modifier and Type	Method	Description
void	apply(ConstraintWidgetContainer container)
BarrierReference	barrier(java.lang.Object key, State.Direction direction)
void	baselineNeededFor(java.lang.Object id)	Baseline is needed for this object
AlignHorizontallyReference	centerHorizontally(java.lang.Object... references)
AlignVerticallyReference	centerVertically(java.lang.Object... references)
ConstraintReference	constraints(java.lang.Object key)
int	convertDimension(java.lang.Object value)	Implements a conversion function for values, returning int.
ConstraintReference	createConstraintReference(java.lang.Object key)	Create a new reference given a key.
void	directMapping()
java.util.ArrayList<java.lang.String>	getIdsForTag(java.lang.String tag)
GuidelineReference	guideline(java.lang.Object key, int orientation)
State	height(Dimension dimension)
HelperReference	helper(java.lang.Object key, State.Helper type)
HorizontalChainReference	horizontalChain()
HorizontalChainReference	horizontalChain(java.lang.Object... references)
GuidelineReference	horizontalGuideline(java.lang.Object key)
boolean	isBaselineNeeded(ConstraintWidget constraintWidget)	Does this constraintWidget need a baseline
void	map(java.lang.Object key, java.lang.Object view)
void	reset()	Clear the state
boolean	sameFixedHeight(int height)
boolean	sameFixedWidth(int width)
void	setDpToPixel(CorePixelDp dpToPixel)	Set the function that converts dp to Pixels
State	setHeight(Dimension dimension)
void	setTag(java.lang.String key, java.lang.String tag)
State	setWidth(Dimension dimension)
VerticalChainReference	verticalChain()
VerticalChainReference	verticalChain(java.lang.Object... references)
GuidelineReference	verticalGuideline(java.lang.Object key)
State	width(Dimension dimension)

Methods inherited from class java.lang.Object

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

Field Detail

mReferences

protected java.util.HashMap<java.lang.Object,Reference> mReferences

mHelperReferences

protected java.util.HashMap<java.lang.Object,HelperReference> mHelperReferences

PARENT

public static final java.lang.Integer PARENT

mParent

public final ConstraintReference mParent

Constructor Detail

State

public State()

Method Detail

setDpToPixel

public void setDpToPixel(CorePixelDp dpToPixel)

Set the function that converts dp to Pixels

reset

public void reset()

Clear the state

convertDimension

public int convertDimension(java.lang.Object value)

Implements a conversion function for values, returning int. This can be used in case values (e.g. margins) are represented via an object, not directly an int.

Parameters:

value - the object to convert from

createConstraintReference

public ConstraintReference createConstraintReference(java.lang.Object key)

Create a new reference given a key.

sameFixedWidth

public boolean sameFixedWidth(int width)

sameFixedHeight

public boolean sameFixedHeight(int height)

width

public State width(Dimension dimension)

height

public State height(Dimension dimension)

setWidth

public State setWidth(Dimension dimension)

setHeight

public State setHeight(Dimension dimension)

constraints

public ConstraintReference constraints(java.lang.Object key)

helper

public HelperReference helper(java.lang.Object key,
                              State.Helper type)

horizontalGuideline

public GuidelineReference horizontalGuideline(java.lang.Object key)

verticalGuideline

public GuidelineReference verticalGuideline(java.lang.Object key)

guideline

public GuidelineReference guideline(java.lang.Object key,
                                    int orientation)

barrier

public BarrierReference barrier(java.lang.Object key,
                                State.Direction direction)

verticalChain

public VerticalChainReference verticalChain()

verticalChain

public VerticalChainReference verticalChain(java.lang.Object... references)

horizontalChain

public HorizontalChainReference horizontalChain()

horizontalChain

public HorizontalChainReference horizontalChain(java.lang.Object... references)

centerHorizontally

public AlignHorizontallyReference centerHorizontally(java.lang.Object... references)

centerVertically

public AlignVerticallyReference centerVertically(java.lang.Object... references)

directMapping

public void directMapping()

map

public void map(java.lang.Object key,
                java.lang.Object view)

setTag

public void setTag(java.lang.String key,
                   java.lang.String tag)

getIdsForTag

public java.util.ArrayList<java.lang.String> getIdsForTag(java.lang.String tag)

apply

public void apply(ConstraintWidgetContainer container)

baselineNeededFor

public void baselineNeededFor(java.lang.Object id)

Baseline is needed for this object

isBaselineNeeded

public boolean isBaselineNeeded(ConstraintWidget constraintWidget)

Does this constraintWidget need a baseline

Returns:

true if the constraintWidget needs a baseline