Class State
- java.lang.Object
-
- androidx.constraintlayout.core.state.State
-
public class State extends java.lang.ObjectRepresents a full state of a ConstraintLayout
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classState.Chainstatic classState.Constraintstatic classState.Directionstatic classState.Helperstatic classState.Wrap
-
Field Summary
Fields Modifier and Type Field Description protected java.util.HashMap<java.lang.Object,HelperReference>mHelperReferencesConstraintReferencemParentprotected java.util.HashMap<java.lang.Object,Reference>mReferencesstatic java.lang.IntegerPARENT
-
Constructor Summary
Constructors Constructor Description State()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapply(ConstraintWidgetContainer container)BarrierReferencebarrier(java.lang.Object key, State.Direction direction)voidbaselineNeededFor(java.lang.Object id)Baseline is needed for this objectAlignHorizontallyReferencecenterHorizontally(java.lang.Object... references)AlignVerticallyReferencecenterVertically(java.lang.Object... references)ConstraintReferenceconstraints(java.lang.Object key)intconvertDimension(java.lang.Object value)Implements a conversion function for values, returning int.ConstraintReferencecreateConstraintReference(java.lang.Object key)Create a new reference given a key.voiddirectMapping()FlowReferencegetFlow(java.lang.Object key, boolean vertical)Gets a reference to a Flow object.FlowReferencegetHorizontalFlow()Get a HorizontalFlowReferenceFlowReferencegetHorizontalFlow(java.lang.Object... references)Get a HorizontalFlowReference and add it to referencesjava.util.ArrayList<java.lang.String>getIdsForTag(java.lang.String tag)FlowReferencegetVerticalFlow()Get a VerticalFlowReferenceFlowReferencegetVerticalFlow(java.lang.Object... references)Get a VerticalFlowReference and add it to referencesGuidelineReferenceguideline(java.lang.Object key, int orientation)Stateheight(Dimension dimension)HelperReferencehelper(java.lang.Object key, State.Helper type)HorizontalChainReferencehorizontalChain()HorizontalChainReferencehorizontalChain(java.lang.Object... references)GuidelineReferencehorizontalGuideline(java.lang.Object key)booleanisBaselineNeeded(ConstraintWidget constraintWidget)Does this constraintWidget need a baselinevoidmap(java.lang.Object key, java.lang.Object view)voidreset()Clear the statebooleansameFixedHeight(int height)booleansameFixedWidth(int width)voidsetDpToPixel(CorePixelDp dpToPixel)Set the function that converts dp to PixelsStatesetHeight(Dimension dimension)voidsetTag(java.lang.String key, java.lang.String tag)StatesetWidth(Dimension dimension)VerticalChainReferenceverticalChain()VerticalChainReferenceverticalChain(java.lang.Object... references)GuidelineReferenceverticalGuideline(java.lang.Object key)Statewidth(Dimension dimension)
-
-
-
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
-
-
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)
-
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)
-
getFlow
public FlowReference getFlow(java.lang.Object key, boolean vertical)
Gets a reference to a Flow object. Creating it if needed.- Parameters:
key- id of the referencevertical- is it a vertical or horizontal flow- Returns:
- a FlowReference
-
verticalChain
public VerticalChainReference verticalChain()
-
verticalChain
public VerticalChainReference verticalChain(java.lang.Object... references)
-
horizontalChain
public HorizontalChainReference horizontalChain()
-
horizontalChain
public HorizontalChainReference horizontalChain(java.lang.Object... references)
-
getVerticalFlow
public FlowReference getVerticalFlow()
Get a VerticalFlowReference- Returns:
- a VerticalFlowReference
-
getVerticalFlow
public FlowReference getVerticalFlow(java.lang.Object... references)
Get a VerticalFlowReference and add it to references- Parameters:
references- where we add the VerticalFlowReference- Returns:
- a VerticalFlowReference
-
getHorizontalFlow
public FlowReference getHorizontalFlow()
Get a HorizontalFlowReference- Returns:
- a HorizontalFlowReference
-
getHorizontalFlow
public FlowReference getHorizontalFlow(java.lang.Object... references)
Get a HorizontalFlowReference and add it to references- Parameters:
references- references where we the HorizontalFlowReference- Returns:
- a HorizontalFlowReference
-
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
-
-