FlowReference (core 1.1.0-alpha04 API)

java.lang.Object
- androidx.constraintlayout.core.state.ConstraintReference
- - androidx.constraintlayout.core.state.HelperReference
  - - androidx.constraintlayout.core.state.helpers.FlowReference

All Implemented Interfaces:

Facade, Reference
```
public class FlowReference
extends HelperReference
```
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.

Nested Class Summary
- Nested classes/interfaces inherited from class androidx.constraintlayout.core.state.ConstraintReference
  ConstraintReference.ConstraintReferenceFactory

Field Summary

Fields
Modifier and Type	Field	Description
`protected float`	`mFirstHorizontalBias`
`protected int`	`mFirstHorizontalStyle`
`protected float`	`mFirstVerticalBias`
`protected int`	`mFirstVerticalStyle`
`protected Flow`	`mFlow`
`protected int`	`mHorizontalAlign`
`protected int`	`mHorizontalGap`
`protected int`	`mHorizontalStyle`
`protected float`	`mLastHorizontalBias`
`protected int`	`mLastHorizontalStyle`
`protected float`	`mLastVerticalBias`
`protected int`	`mLastVerticalStyle`
`protected java.util.HashMap<java.lang.String,java.lang.Float>`	`mMapPostMargin`
`protected java.util.HashMap<java.lang.String,java.lang.Float>`	`mMapPreMargin`
`protected java.util.HashMap<java.lang.String,java.lang.Float>`	`mMapWeights`
`protected int`	`mMaxElementsWrap`
`protected int`	`mOrientation`
`protected int`	`mPaddingBottom`
`protected int`	`mPaddingLeft`
`protected int`	`mPaddingRight`
`protected int`	`mPaddingTop`
`protected int`	`mVerticalAlign`
`protected int`	`mVerticalGap`
`protected int`	`mVerticalStyle`
`protected int`	`mWrapMode`

Fields inherited from class androidx.constraintlayout.core.state.HelperReference
mHelperState, mReferences

Fields inherited from class androidx.constraintlayout.core.state.ConstraintReference
mBottomToBottom, mBottomToTop, mEndToEnd, mEndToStart, mHorizontalBias, mLeftToLeft, mLeftToRight, mMarginBottom, mMarginBottomGone, mMarginEnd, mMarginEndGone, mMarginLeft, mMarginLeftGone, mMarginRight, mMarginRightGone, mMarginStart, mMarginStartGone, mMarginTop, mMarginTopGone, mRightToLeft, mRightToRight, mStartToEnd, mStartToStart, mTopToBottom, mTopToTop, mVerticalBias

Constructor Summary

Constructors
Constructor Description

FlowReference(State state, State.Helper type)

Constructors
Constructor	Description
`FlowReference(State state, State.Helper type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addFlowElement(java.lang.String id, float weight, float preMargin, float postMargin)`	Relate widgets to the FlowReference
`void`	`apply()`
`float`	`getFirstHorizontalBias()`	Get first horizontal bias
`int`	`getFirstHorizontalStyle()`	Get first horizontal style
`float`	`getFirstVerticalBias()`	Get first vertical bias
`int`	`getFirstVerticalStyle()`	Get first vertical style
`HelperWidget`	`getHelperWidget()`
`int`	`getHorizontalAlign()`	Get horizontal align
`float`	`getHorizontalBias()`	Get horizontal bias
`int`	`getHorizontalGap()`	Get horizontal gap
`int`	`getHorizontalStyle()`	Get horizontal style
`float`	`getLastHorizontalBias()`	Get last horizontal bias
`int`	`getLastHorizontalStyle()`	Get last horizontal style
`float`	`getLastVerticalBias()`	Get last vertical bias
`int`	`getLastVerticalStyle()`	Get last vertical style
`int`	`getMaxElementsWrap()`	Get max element wrap
`int`	`getOrientation()`	Get the orientation of a Flow
`int`	`getPaddingBottom()`	Get paddingBottom
`int`	`getPaddingLeft()`	Get paddingLeft
`int`	`getPaddingRight()`	Get paddingRight
`int`	`getPaddingTop()`	Get paddingTop
`protected float`	`getPostMargin(java.lang.String id)`	Get the post margin of a widget
`protected float`	`getPreMargin(java.lang.String id)`	Get the pre margin of a widget
`int`	`getVerticalAlign()`	Get vertical align
`float`	`getVerticalBias()`	Get vertical bias
`int`	`getVerticalGap()`	Get vertical gap
`int`	`getVerticalStyle()`	Get vertical style
`protected float`	`getWeight(java.lang.String id)`	Get the weight of a widget
`int`	`getWrapMode()`	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`	`setHelperWidget(HelperWidget widget)`
`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

Methods inherited from class androidx.constraintlayout.core.state.HelperReference
add, applyBase, getConstraintWidget, getType

Methods inherited from class androidx.constraintlayout.core.state.ConstraintReference
addCustomColor, addCustomFloat, alpha, applyWidgetConstraints, baseline, baselineToBaseline, baselineToBottom, baselineToTop, bias, bottom, bottomToBottom, bottomToTop, centerHorizontally, centerVertically, circularConstraint, clear, clearAll, clearHorizontal, clearVertical, createConstraintWidget, end, endToEnd, endToStart, getAlpha, getFacade, getHeight, getHorizontalChainStyle, getHorizontalChainWeight, getKey, getPivotX, getPivotY, getRotationX, getRotationY, getRotationZ, getScaleX, getScaleY, getTag, getTranslationX, getTranslationY, getTranslationZ, getVerticalChainStyle, getVerticalChainWeight, getView, getWidth, height, horizontalBias, left, leftToLeft, leftToRight, margin, margin, marginGone, marginGone, pivotX, pivotY, right, rightToLeft, rightToRight, rotationX, rotationY, rotationZ, scaleX, scaleY, setConstraintWidget, setFacade, setHeight, setHorizontalChainStyle, setHorizontalChainWeight, setKey, setTag, setVerticalChainStyle, setVerticalChainWeight, setView, setWidth, start, startToEnd, startToStart, top, topToBottom, topToTop, translationX, translationY, translationZ, validate, verticalBias, visibility, width

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

- Field Detail
  - mFlow
```
protected Flow mFlow
```
  - mMapWeights
```
protected java.util.HashMap<java.lang.String,java.lang.Float> mMapWeights
```
  - mMapPreMargin
```
protected java.util.HashMap<java.lang.String,java.lang.Float> mMapPreMargin
```
  - mMapPostMargin
```
protected java.util.HashMap<java.lang.String,java.lang.Float> mMapPostMargin
```
  - mWrapMode
```
protected int mWrapMode
```
  - mVerticalStyle
```
protected int mVerticalStyle
```
  - mFirstVerticalStyle
```
protected int mFirstVerticalStyle
```
  - mLastVerticalStyle
```
protected int mLastVerticalStyle
```
  - mHorizontalStyle
```
protected int mHorizontalStyle
```
  - mFirstHorizontalStyle
```
protected int mFirstHorizontalStyle
```
  - mLastHorizontalStyle
```
protected int mLastHorizontalStyle
```
  - mVerticalAlign
```
protected int mVerticalAlign
```
  - mHorizontalAlign
```
protected int mHorizontalAlign
```
  - mVerticalGap
```
protected int mVerticalGap
```
  - mHorizontalGap
```
protected int mHorizontalGap
```
  - mPaddingLeft
```
protected int mPaddingLeft
```
  - mPaddingRight
```
protected int mPaddingRight
```
  - mPaddingTop
```
protected int mPaddingTop
```
  - mPaddingBottom
```
protected int mPaddingBottom
```
  - mMaxElementsWrap
```
protected int mMaxElementsWrap
```
  - mOrientation
```
protected int mOrientation
```
  - mFirstVerticalBias
```
protected float mFirstVerticalBias
```
  - mLastVerticalBias
```
protected float mLastVerticalBias
```
  - mFirstHorizontalBias
```
protected float mFirstHorizontalBias
```
  - mLastHorizontalBias
```
protected float mLastHorizontalBias
```
- Constructor Detail
  - FlowReference
```
public FlowReference(State state,
                     State.Helper type)
```
- Method Detail
  - addFlowElement
```
public void addFlowElement(java.lang.String id,
                           float weight,
                           float preMargin,
                           float postMargin)
```
    Relate widgets to the FlowReference
    
    Parameters:
    
    id - id of a widget
    
    weight - weight of a widget
    
    preMargin - preMargin of a widget
    
    postMargin - postMargin of a widget
  - getWeight
```
protected float getWeight(java.lang.String id)
```
    Get the weight of a widget
    
    Parameters:
    
    id - id of a widget
    
    Returns:
    
    the weight of a widget
  - getPostMargin
```
protected float getPostMargin(java.lang.String id)
```
    Get the post margin of a widget
    
    Parameters:
    
    id - id id of a widget
    
    Returns:
    
    the post margin of a widget
  - getPreMargin
```
protected float getPreMargin(java.lang.String id)
```
    Get the pre margin of a widget
    
    Parameters:
    
    id - id id of a widget
    
    Returns:
    
    the pre margin of a widget
  - getWrapMode
```
public int getWrapMode()
```
    Get wrap mode
    
    Returns:
    
    wrap mode
  - setWrapMode
```
public void setWrapMode(int wrap)
```
    Set wrap Mode
    
    Parameters:
    
    wrap - wrap Mode
  - getPaddingLeft
```
public int getPaddingLeft()
```
    Get paddingLeft
    
    Returns:
    
    paddingLeft value
  - setPaddingLeft
```
public void setPaddingLeft(int padding)
```
    Set paddingLeft
    
    Parameters:
    
    padding - paddingLeft value
  - getPaddingTop
```
public int getPaddingTop()
```
    Get paddingTop
    
    Returns:
    
    paddingTop value
  - setPaddingTop
```
public void setPaddingTop(int padding)
```
    Set paddingTop
    
    Parameters:
    
    padding - paddingTop value
  - getPaddingRight
```
public int getPaddingRight()
```
    Get paddingRight
    
    Returns:
    
    paddingRight value
  - setPaddingRight
```
public void setPaddingRight(int padding)
```
    Set paddingRight
    
    Parameters:
    
    padding - paddingRight value
  - getPaddingBottom
```
public int getPaddingBottom()
```
    Get paddingBottom
    
    Returns:
    
    paddingBottom value
  - setPaddingBottom
```
public void setPaddingBottom(int padding)
```
    Set padding
    
    Parameters:
    
    padding - paddingBottom value
  - getVerticalStyle
```
public int getVerticalStyle()
```
    Get vertical style
    
    Returns:
    
    vertical style
  - setVerticalStyle
```
public void setVerticalStyle(int verticalStyle)
```
    set vertical style
    
    Parameters:
    
    verticalStyle - Flow vertical style
  - getFirstVerticalStyle
```
public int getFirstVerticalStyle()
```
    Get first vertical style
    
    Returns:
    
    first vertical style
  - setFirstVerticalStyle
```
public void setFirstVerticalStyle(int firstVerticalStyle)
```
    Set first vertical style
    
    Parameters:
    
    firstVerticalStyle - Flow first vertical style
  - getLastVerticalStyle
```
public int getLastVerticalStyle()
```
    Get last vertical style
    
    Returns:
    
    last vertical style
  - setLastVerticalStyle
```
public void setLastVerticalStyle(int lastVerticalStyle)
```
    Set last vertical style
    
    Parameters:
    
    lastVerticalStyle - Flow last vertical style
  - getHorizontalStyle
```
public int getHorizontalStyle()
```
    Get horizontal style
    
    Returns:
    
    horizontal style
  - setHorizontalStyle
```
public void setHorizontalStyle(int horizontalStyle)
```
    Set horizontal style
    
    Parameters:
    
    horizontalStyle - Flow horizontal style
  - getFirstHorizontalStyle
```
public int getFirstHorizontalStyle()
```
    Get first horizontal style
    
    Returns:
    
    first horizontal style
  - setFirstHorizontalStyle
```
public void setFirstHorizontalStyle(int firstHorizontalStyle)
```
    Set first horizontal style
    
    Parameters:
    
    firstHorizontalStyle - Flow first horizontal style
  - getLastHorizontalStyle
```
public int getLastHorizontalStyle()
```
    Get last horizontal style
    
    Returns:
    
    last horizontal style
  - setLastHorizontalStyle
```
public void setLastHorizontalStyle(int lastHorizontalStyle)
```
    Set last horizontal style
    
    Parameters:
    
    lastHorizontalStyle - Flow last horizontal style
  - getVerticalAlign
```
public int getVerticalAlign()
```
    Get vertical align
    
    Returns:
    
    vertical align value
  - setVerticalAlign
```
public void setVerticalAlign(int verticalAlign)
```
    Set vertical align
    
    Parameters:
    
    verticalAlign - vertical align value
  - getHorizontalAlign
```
public int getHorizontalAlign()
```
    Get horizontal align
    
    Returns:
    
    horizontal align value
  - setHorizontalAlign
```
public void setHorizontalAlign(int horizontalAlign)
```
    Set horizontal align
    
    Parameters:
    
    horizontalAlign - horizontal align value
  - getVerticalGap
```
public int getVerticalGap()
```
    Get vertical gap
    
    Returns:
    
    vertical gap value
  - setVerticalGap
```
public void setVerticalGap(int verticalGap)
```
    Set vertical gap
    
    Parameters:
    
    verticalGap - vertical gap value
  - getHorizontalGap
```
public int getHorizontalGap()
```
    Get horizontal gap
    
    Returns:
    
    horizontal gap value
  - setHorizontalGap
```
public void setHorizontalGap(int horizontalGap)
```
    Set horizontal gap
    
    Parameters:
    
    horizontalGap - horizontal gap value
  - getMaxElementsWrap
```
public int getMaxElementsWrap()
```
    Get max element wrap
    
    Returns:
    
    max element wrap value
  - setMaxElementsWrap
```
public void setMaxElementsWrap(int maxElementsWrap)
```
    Set max element wrap
    
    Parameters:
    
    maxElementsWrap - max element wrap value
  - getOrientation
```
public int getOrientation()
```
    Get the orientation of a Flow
    
    Returns:
    
    orientation value
  - setOrientation
```
public void setOrientation(int mOrientation)
```
    Set the orientation of a Flow
    
    Parameters:
    
    mOrientation - orientation value
  - getVerticalBias
```
public float getVerticalBias()
```
    Get vertical bias
    
    Returns:
    
    vertical bias value
  - getFirstVerticalBias
```
public float getFirstVerticalBias()
```
    Get first vertical bias
    
    Returns:
    
    first vertical bias value
  - setFirstVerticalBias
```
public void setFirstVerticalBias(float firstVerticalBias)
```
    Set first vertical bias
    
    Parameters:
    
    firstVerticalBias - first vertical bias value
  - getLastVerticalBias
```
public float getLastVerticalBias()
```
    Get last vertical bias
    
    Returns:
    
    last vertical bias
  - setLastVerticalBias
```
public void setLastVerticalBias(float lastVerticalBias)
```
    Set last vertical bias
    
    Parameters:
    
    lastVerticalBias - last vertical bias value
  - getHorizontalBias
```
public float getHorizontalBias()
```
    Get horizontal bias
    
    Returns:
    
    horizontal bias value
  - getFirstHorizontalBias
```
public float getFirstHorizontalBias()
```
    Get first horizontal bias
    
    Returns:
    
    first horizontal bias
  - setFirstHorizontalBias
```
public void setFirstHorizontalBias(float firstHorizontalBias)
```
    Set first horizontal bias
    
    Parameters:
    
    firstHorizontalBias - first horizontal bias value
  - getLastHorizontalBias
```
public float getLastHorizontalBias()
```
    Get last horizontal bias
    
    Returns:
    
    last horizontal bias value
  - setLastHorizontalBias
```
public void setLastHorizontalBias(float lastHorizontalBias)
```
    Set last horizontal bias
    
    Parameters:
    
    lastHorizontalBias - last horizontal bias value
  - getHelperWidget
```
public HelperWidget getHelperWidget()
```
    Overrides:
    
    getHelperWidget in class HelperReference
  - setHelperWidget
```
public void setHelperWidget(HelperWidget widget)
```
    Overrides:
    
    setHelperWidget in class HelperReference
  - apply
```
public void apply()
```
    Specified by:
    
    apply in interface Facade
    
    Specified by:
    
    apply in interface Reference
    
    Overrides:
    
    apply in class HelperReference

Class FlowReference

Nested Class Summary

Nested classes/interfaces inherited from class androidx.constraintlayout.core.state.ConstraintReference

Field Summary

Fields inherited from class androidx.constraintlayout.core.state.HelperReference

Fields inherited from class androidx.constraintlayout.core.state.ConstraintReference

Constructor Summary

Method Summary

Methods inherited from class androidx.constraintlayout.core.state.HelperReference

Methods inherited from class androidx.constraintlayout.core.state.ConstraintReference

Methods inherited from class java.lang.Object

Field Detail

mFlow

mMapWeights

mMapPreMargin

mMapPostMargin

mWrapMode

mVerticalStyle

mFirstVerticalStyle

mLastVerticalStyle

mHorizontalStyle

mFirstHorizontalStyle

mLastHorizontalStyle

mVerticalAlign

mHorizontalAlign

mVerticalGap

mHorizontalGap

mPaddingLeft

mPaddingRight

mPaddingTop

mPaddingBottom

mMaxElementsWrap

mOrientation

mFirstVerticalBias

mLastVerticalBias

mFirstHorizontalBias

mLastHorizontalBias

Constructor Detail

FlowReference

Method Detail

addFlowElement

getWeight

getPostMargin

getPreMargin

getWrapMode

setWrapMode

getPaddingLeft

setPaddingLeft

getPaddingTop

setPaddingTop

getPaddingRight

setPaddingRight

getPaddingBottom

setPaddingBottom

getVerticalStyle

setVerticalStyle

getFirstVerticalStyle

setFirstVerticalStyle

getLastVerticalStyle

setLastVerticalStyle

getHorizontalStyle

setHorizontalStyle

getFirstHorizontalStyle

setFirstHorizontalStyle

getLastHorizontalStyle

setLastHorizontalStyle

getVerticalAlign

setVerticalAlign

getHorizontalAlign

setHorizontalAlign

getVerticalGap

setVerticalGap

getHorizontalGap

setHorizontalGap

getMaxElementsWrap

setMaxElementsWrap

getOrientation

setOrientation

getVerticalBias

getFirstVerticalBias