FlowReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.1

Kotlin |Java

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`	`mFirstHorizontalBias`
`int`	`mFirstHorizontalStyle`
`float`	`mFirstVerticalBias`
`int`	`mFirstVerticalStyle`
`Flow`	`mFlow`
`int`	`mHorizontalAlign`
`int`	`mHorizontalGap`
`int`	`mHorizontalStyle`
`float`	`mLastHorizontalBias`
`int`	`mLastHorizontalStyle`
`float`	`mLastVerticalBias`
`int`	`mLastVerticalStyle`
`HashMap<String, Float>`	`mMapPostMargin`
`HashMap<String, Float>`	`mMapPreMargin`
`HashMap<String, Float>`	`mMapWeights`
`int`	`mMaxElementsWrap`
`int`	`mOrientation`
`int`	`mPaddingBottom`
`int`	`mPaddingLeft`
`int`	`mPaddingRight`
`int`	`mPaddingTop`
`int`	`mVerticalAlign`
`int`	`mVerticalGap`
`int`	`mVerticalStyle`
`int`	`mWrapMode`

Public constructors
`FlowReference(State state, State.Helper type)`

Public methods
`void`	`addFlowElement( 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
`int`	`getVerticalAlign()` Get vertical align
`float`	`getVerticalBias()` Get vertical bias
`int`	`getVerticalGap()` Get vertical gap
`int`	`getVerticalStyle()` Get vertical style
`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

Protected methods
`float`	`getPostMargin(String id)` Get the post margin of a widget
`float`	`getPreMargin(String id)` Get the pre margin of a widget
`float`	`getWeight(String id)` Get the weight of a widget

Inherited fields

From androidx.constraintlayout.core.state.ConstraintReference

`Object`	`mBottomToBottom`
`Object`	`mBottomToTop`
`Object`	`mEndToEnd`
`Object`	`mEndToStart`
`float`	`mHorizontalBias`
`Object`	`mLeftToLeft`
`Object`	`mLeftToRight`
`int`	`mMarginBottom`
`int`	`mMarginBottomGone`
`int`	`mMarginEnd`
`int`	`mMarginEndGone`
`int`	`mMarginLeft`
`int`	`mMarginLeftGone`
`int`	`mMarginRight`
`int`	`mMarginRightGone`
`int`	`mMarginStart`
`int`	`mMarginStartGone`
`int`	`mMarginTop`
`int`	`mMarginTopGone`
`Object`	`mRightToLeft`
`Object`	`mRightToRight`
`Object`	`mStartToEnd`
`Object`	`mStartToStart`
`Object`	`mTopToBottom`
`Object`	`mTopToTop`
`float`	`mVerticalBias`

From androidx.constraintlayout.core.state.HelperReference

`final State`	`mHelperState`
`ArrayList<Object>`	`mReferences`

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`	`applyWidgetConstraints()` apply all the constraints attributes of the mConstraintWidget
`ConstraintReference`	`baseline()`
`ConstraintReference`	`baselineToBaseline(Object reference)`
`ConstraintReference`	`baselineToBottom(Object reference)`
`ConstraintReference`	`baselineToTop(Object reference)`
`ConstraintReference`	`bias(float value)`
`ConstraintReference`	`bottom()`
`ConstraintReference`	`bottomToBottom(Object reference)`
`ConstraintReference`	`bottomToTop(Object reference)`
`ConstraintReference`	`centerHorizontally(Object reference)`
`ConstraintReference`	`centerVertically(Object reference)`
`ConstraintReference`	`circularConstraint(Object reference, float angle, float distance)`
`ConstraintReference`	`clear()`
`ConstraintReference`	`clearAll()` Clears all constraints.
`ConstraintReference`	`clearHorizontal()`
`ConstraintReference`	`clearVertical()`
`ConstraintWidget`	`createConstraintWidget()`
`ConstraintReference`	`end()`
`ConstraintReference`	`endToEnd(Object reference)`
`ConstraintReference`	`endToStart(Object reference)`
`float`	`getAlpha()`
`Facade`	`getFacade()`
`Dimension`	`getHeight()`
`int`	`getHorizontalChainStyle()`
`float`	`getHorizontalChainWeight()`
`Object`	`getKey()`
`float`	`getPivotX()`
`float`	`getPivotY()`
`float`	`getRotationX()`
`float`	`getRotationY()`
`float`	`getRotationZ()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`String`	`getTag()`
`float`	`getTranslationX()`
`float`	`getTranslationY()`
`float`	`getTranslationZ()`
`int`	`getVerticalChainStyle(int chainStyle)`
`float`	`getVerticalChainWeight()`
`Object`	`getView()`
`Dimension`	`getWidth()`
`ConstraintReference`	`height(Dimension dimension)`
`ConstraintReference`	`horizontalBias(float value)`
`ConstraintReference`	`left()`
`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`	`right()`
`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`	`setConstraintWidget(ConstraintWidget widget)`
`void`	`setFacade(Facade facade)`
`ConstraintReference`	`setHeight(Dimension dimension)`
`void`	`setHorizontalChainStyle(int chainStyle)`
`void`	`setHorizontalChainWeight(float weight)`
`void`	`setKey(Object key)`
`void`	`setTag(String tag)`
`void`	`setVerticalChainStyle(int chainStyle)`
`void`	`setVerticalChainWeight(float weight)`
`void`	`setView(Object view)`
`ConstraintReference`	`setWidth(Dimension dimension)`
`ConstraintReference`	`start()`
`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()` 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`	`applyBase()` Allows the derived classes to invoke the apply method in the ConstraintReference
`ConstraintWidget`	`getConstraintWidget()`
`State.Helper`	`getType()`

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

FlowReference

Summary

Protected fields

Public constructors

Public methods

Protected methods

Inherited fields

Inherited methods

Protected fields

mFirstHorizontalBias

mFirstHorizontalStyle

mFirstVerticalBias

mFirstVerticalStyle

mFlow

mHorizontalAlign

mHorizontalGap

mHorizontalStyle

mLastHorizontalBias

mLastHorizontalStyle

mLastVerticalBias

mLastVerticalStyle

mMapPostMargin

mMapPreMargin

mMapWeights

mMaxElementsWrap

mOrientation

mPaddingBottom