public class FlowReference extends HelperReference

java.lang.Object
   ↳ androidx.constraintlayout.core.state.ConstraintReference
     ↳ androidx.constraintlayout.core.state.HelperReference
       ↳ androidx.constraintlayout.core.state.helpers.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.

Summary

Protected fields
float
int
float
int
Flow
int
int
int
float
int
float
int
HashMap<String, Float>
HashMap<String, Float>
HashMap<String, Float>
int
int
int
int
int
int
int
int
int
int

Public constructors

Public methods
void
addFlowElement(
    String id,
    float weight,
    float preMargin,
    float postMargin
)

Relate widgets to the FlowReference
void
float

Get first horizontal bias
int

Get first horizontal style
float

Get first vertical bias
int

Get first vertical style
HelperWidget
int

Get horizontal align
float

Get horizontal bias
int

Get horizontal gap
int

Get horizontal style
float

Get last horizontal bias
int

Get last horizontal style
float

Get last vertical bias
int

Get last vertical style
int

Get max element wrap
int

Get the orientation of a Flow
int

Get paddingBottom
int

Get paddingLeft
int

Get paddingRight
int

Get paddingTop
int

Get vertical align
float

Get vertical bias
int

Get vertical gap
int

Get vertical style
int

Get wrap mode
void
setFirstHorizontalBias(float firstHorizontalBias)

Set first horizontal bias
void
setFirstHorizontalStyle(int firstHorizontalStyle)

Set first horizontal style
void
setFirstVerticalBias(float firstVerticalBias)

Set first vertical bias
void
setFirstVerticalStyle(int firstVerticalStyle)

Set first vertical style
void
void
setHorizontalAlign(int horizontalAlign)

Set horizontal align
void
setHorizontalGap(int horizontalGap)

Set horizontal gap
void
setHorizontalStyle(int horizontalStyle)

Set horizontal style
void
setLastHorizontalBias(float lastHorizontalBias)

Set last horizontal bias
void
setLastHorizontalStyle(int lastHorizontalStyle)

Set last horizontal style
void
setLastVerticalBias(float lastVerticalBias)

Set last vertical bias
void
setLastVerticalStyle(int lastVerticalStyle)

Set last vertical style
void
setMaxElementsWrap(int maxElementsWrap)

Set max element wrap
void
setOrientation(int mOrientation)

Set the orientation of a Flow
void
setPaddingBottom(int padding)

Set padding
void
setPaddingLeft(int padding)

Set paddingLeft
void
setPaddingRight(int padding)

Set paddingRight
void
setPaddingTop(int padding)

Set paddingTop
void
setVerticalAlign(int verticalAlign)

Set vertical align
void
setVerticalGap(int verticalGap)

Set vertical gap
void
setVerticalStyle(int verticalStyle)

set vertical style
void
setWrapMode(int wrap)

Set wrap Mode

Protected methods
float

Get the post margin of a widget
float

Get the pre margin of a widget
float

Get the weight of a widget

Inherited fields
From androidx.constraintlayout.core.state.ConstraintReference
Object
Object
Object
Object
float
Object
Object
int
int
int
int
int
int
int
int
int
int
int
int
Object
Object
Object
Object
Object
Object
float
From androidx.constraintlayout.core.state.HelperReference
final State
ArrayList<Object>

Inherited methods
From androidx.constraintlayout.core.state.ConstraintReference
void
addCustomColor(String name, int color)
void
addCustomFloat(String name, float value)
ConstraintReference
alpha(float alpha)
void

apply all the constraints attributes of the mConstraintWidget
ConstraintReference
ConstraintReference
ConstraintReference
ConstraintReference
baselineToTop(Object reference)
ConstraintReference
bias(float value)
ConstraintReference
ConstraintReference
ConstraintReference
bottomToTop(Object reference)
ConstraintReference
ConstraintReference
ConstraintReference
circularConstraint(Object reference, float angle, float distance)
ConstraintReference
ConstraintReference

Clears all constraints.
ConstraintReference
ConstraintReference
ConstraintWidget
ConstraintReference
end()
ConstraintReference
endToEnd(Object reference)
ConstraintReference
endToStart(Object reference)
float
Facade
Dimension
int
float
Object
float
float
float
float
float
float
float
String
float
float
float
int
getVerticalChainStyle(int chainStyle)
float
Object
Dimension
ConstraintReference
height(Dimension dimension)
ConstraintReference
horizontalBias(float value)
ConstraintReference
ConstraintReference
leftToLeft(Object reference)
ConstraintReference
leftToRight(Object reference)
ConstraintReference
margin(Object marginValue)
ConstraintReference
margin(int value)
ConstraintReference
marginGone(Object marginGoneValue)
ConstraintReference
marginGone(int value)
ConstraintReference
pivotX(float x)
ConstraintReference
pivotY(float y)
ConstraintReference
ConstraintReference
rightToLeft(Object reference)
ConstraintReference
rightToRight(Object reference)
ConstraintReference
rotationX(float x)
ConstraintReference
rotationY(float y)
ConstraintReference
rotationZ(float z)
ConstraintReference
scaleX(float x)
ConstraintReference
scaleY(float y)
void
void
setFacade(Facade facade)
ConstraintReference
setHeight(Dimension dimension)
void
setHorizontalChainStyle(int chainStyle)
void
void
void
void
setVerticalChainStyle(int chainStyle)
void
setVerticalChainWeight(float weight)
void
ConstraintReference
setWidth(Dimension dimension)
ConstraintReference
ConstraintReference
startToEnd(Object reference)
ConstraintReference
startToStart(Object reference)
ConstraintReference
top()
ConstraintReference
topToBottom(Object reference)
ConstraintReference
topToTop(Object reference)
ConstraintReference
translationX(float x)
ConstraintReference
translationY(float y)
ConstraintReference
translationZ(float z)
void

Validate the constraints
ConstraintReference
verticalBias(float value)
ConstraintReference
visibility(int visibility)
ConstraintReference
width(Dimension dimension)
From androidx.constraintlayout.core.state.HelperReference
HelperReference
add(Object[] objects)
void

Allows the derived classes to invoke the apply method in the ConstraintReference
ConstraintWidget
State.Helper

Protected fields

mFirstHorizontalBias

Added in 1.1.1
protected float mFirstHorizontalBias

mFirstHorizontalStyle

Added in 1.1.1
protected int mFirstHorizontalStyle

mFirstVerticalBias

Added in 1.1.1
protected float mFirstVerticalBias

mFirstVerticalStyle

Added in 1.1.1
protected int mFirstVerticalStyle

mFlow

Added in 1.1.1
protected Flow mFlow

mHorizontalAlign

Added in 1.1.1
protected int mHorizontalAlign

mHorizontalGap

Added in 1.1.1
protected int mHorizontalGap

mHorizontalStyle

Added in 1.1.1
protected int mHorizontalStyle

mLastHorizontalBias

Added in 1.1.1
protected float mLastHorizontalBias

mLastHorizontalStyle

Added in 1.1.1
protected int mLastHorizontalStyle

mLastVerticalBias

Added in 1.1.1
protected float mLastVerticalBias

mLastVerticalStyle

Added in 1.1.1
protected int mLastVerticalStyle

mMapPostMargin

Added in 1.1.1
protected HashMap<String, Float> mMapPostMargin

mMapPreMargin

Added in 1.1.1
protected HashMap<String, Float> mMapPreMargin

mMapWeights

Added in 1.1.1
protected HashMap<String, Float> mMapWeights

mMaxElementsWrap

Added in 1.1.1
protected int mMaxElementsWrap

mOrientation

Added in 1.1.1
protected int mOrientation

mPaddingBottom

Added in 1.1.1
protected int mPaddingBottom

mPaddingLeft

Added in 1.1.1
protected int mPaddingLeft

mPaddingRight

Added in 1.1.1
protected int mPaddingRight

mPaddingTop

Added in 1.1.1
protected int mPaddingTop

mVerticalAlign

Added in 1.1.1
protected int mVerticalAlign

mVerticalGap

Added in 1.1.1
protected int mVerticalGap

mVerticalStyle

Added in 1.1.1
protected int mVerticalStyle

mWrapMode

Added in 1.1.1
protected int mWrapMode

Public constructors

FlowReference

Added in 1.1.1
public FlowReference(State state, State.Helper type)

Public methods

addFlowElement

Added in 1.1.1
public void addFlowElement(
    String id,
    float weight,
    float preMargin,
    float postMargin
)

Relate widgets to the FlowReference

Parameters
String id

id of a widget
float weight

weight of a widget
float preMargin

preMargin of a widget
float postMargin

postMargin of a widget

apply

public void apply()

getFirstHorizontalBias

Added in 1.1.1
public float getFirstHorizontalBias()

Get first horizontal bias

Returns
float

first horizontal bias

getFirstHorizontalStyle

Added in 1.1.1
public int getFirstHorizontalStyle()

Get first horizontal style

Returns
int

first horizontal style

getFirstVerticalBias

Added in 1.1.1
public float getFirstVerticalBias()

Get first vertical bias

Returns
float

first vertical bias value

getFirstVerticalStyle

Added in 1.1.1
public int getFirstVerticalStyle()

Get first vertical style

Returns
int

first vertical style

getHelperWidget

public HelperWidget getHelperWidget()

getHorizontalAlign

Added in 1.1.1
public int getHorizontalAlign()

Get horizontal align

Returns
int

horizontal align value

getHorizontalBias

Added in 1.1.1
public float getHorizontalBias()

Get horizontal bias

Returns
float

horizontal bias value

getHorizontalGap

Added in 1.1.1
public int getHorizontalGap()

Get horizontal gap

Returns
int

horizontal gap value

getHorizontalStyle

Added in 1.1.1
public int getHorizontalStyle()

Get horizontal style

Returns
int

horizontal style

getLastHorizontalBias

Added in 1.1.1
public float getLastHorizontalBias()

Get last horizontal bias

Returns
float

last horizontal bias value

getLastHorizontalStyle

Added in 1.1.1
public int getLastHorizontalStyle()

Get last horizontal style

Returns
int

last horizontal style

getLastVerticalBias

Added in 1.1.1
public float getLastVerticalBias()

Get last vertical bias

Returns
float

last vertical bias

getLastVerticalStyle

Added in 1.1.1
public int getLastVerticalStyle()

Get last vertical style

Returns
int

last vertical style

getMaxElementsWrap

Added in 1.1.1
public int getMaxElementsWrap()

Get max element wrap

Returns
int

max element wrap value

</