FlowReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

class FlowReference : HelperReference

kotlin.Any
↳	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

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

Public functions
`Unit`	`addFlowElement( id: String!, weight: Float, preMargin: Float, postMargin: Float )` Relate widgets to the FlowReference
`Unit`	`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
`Unit`	`setFirstHorizontalBias(firstHorizontalBias: Float)` Set first horizontal bias
`Unit`	`setFirstHorizontalStyle(firstHorizontalStyle: Int)` Set first horizontal style
`Unit`	`setFirstVerticalBias(firstVerticalBias: Float)` Set first vertical bias
`Unit`	`setFirstVerticalStyle(firstVerticalStyle: Int)` Set first vertical style
`Unit`	`setHelperWidget(widget: HelperWidget!)`
`Unit`	`setHorizontalAlign(horizontalAlign: Int)` Set horizontal align
`Unit`	`setHorizontalGap(horizontalGap: Int)` Set horizontal gap
`Unit`	`setHorizontalStyle(horizontalStyle: Int)` Set horizontal style
`Unit`	`setLastHorizontalBias(lastHorizontalBias: Float)` Set last horizontal bias
`Unit`	`setLastHorizontalStyle(lastHorizontalStyle: Int)` Set last horizontal style
`Unit`	`setLastVerticalBias(lastVerticalBias: Float)` Set last vertical bias
`Unit`	`setLastVerticalStyle(lastVerticalStyle: Int)` Set last vertical style
`Unit`	`setMaxElementsWrap(maxElementsWrap: Int)` Set max element wrap
`Unit`	`setOrientation(mOrientation: Int)` Set the orientation of a Flow
`Unit`	`setPaddingBottom(padding: Int)` Set padding
`Unit`	`setPaddingLeft(padding: Int)` Set paddingLeft
`Unit`	`setPaddingRight(padding: Int)` Set paddingRight
`Unit`	`setPaddingTop(padding: Int)` Set paddingTop
`Unit`	`setVerticalAlign(verticalAlign: Int)` Set vertical align
`Unit`	`setVerticalGap(verticalGap: Int)` Set vertical gap
`Unit`	`setVerticalStyle(verticalStyle: Int)` set vertical style
`Unit`	`setWrapMode(wrap: Int)` Set wrap Mode

Protected functions
`Float`	`getPostMargin(id: String!)` Get the post margin of a widget
`Float`	`getPreMargin(id: String!)` Get the pre margin of a widget
`Float`	`getWeight(id: String!)` Get the weight of a widget

Protected properties
`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`

Inherited functions

From androidx.constraintlayout.core.state.ConstraintReference

`Unit`	`addCustomColor(name: String!, color: Int)`
`Unit`	`addCustomFloat(name: String!, value: Float)`
`ConstraintReference!`	`alpha(alpha: Float)`
`Unit`	`applyWidgetConstraints()` apply all the constraints attributes of the mConstraintWidget
`ConstraintReference!`	`baseline()`
`ConstraintReference!`	`baselineToBaseline(reference: Any!)`
`ConstraintReference!`	`baselineToBottom(reference: Any!)`
`ConstraintReference!`	`baselineToTop(reference: Any!)`
`ConstraintReference!`	`bias(value: Float)`
`ConstraintReference!`	`bottom()`
`ConstraintReference!`	`bottomToBottom(reference: Any!)`
`ConstraintReference!`	`bottomToTop(reference: Any!)`
`ConstraintReference!`	`centerHorizontally(reference: Any!)`
`ConstraintReference!`	`centerVertically(reference: Any!)`
`ConstraintReference!`	`circularConstraint(reference: Any!, angle: Float, distance: Float)`
`ConstraintReference!`	`clear()`
`ConstraintReference!`	`clearAll()` Clears all constraints.
`ConstraintReference!`	`clearHorizontal()`
`ConstraintReference!`	`clearVertical()`
`ConstraintWidget!`	`createConstraintWidget()`
`ConstraintReference!`	`end()`
`ConstraintReference!`	`endToEnd(reference: Any!)`
`ConstraintReference!`	`endToStart(reference: Any!)`
`Float`	`getAlpha()`
`Facade!`	`getFacade()`
`Dimension!`	`getHeight()`
`Int`	`getHorizontalChainStyle()`
`Float`	`getHorizontalChainWeight()`
`Any!`	`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(chainStyle: Int)`
`Float`	`getVerticalChainWeight()`
`Any!`	`getView()`
`Dimension!`	`getWidth()`
`ConstraintReference!`	`height(dimension: Dimension!)`
`ConstraintReference!`	`horizontalBias(value: Float)`
`ConstraintReference!`	`left()`
`ConstraintReference!`	`leftToLeft(reference: Any!)`
`ConstraintReference!`	`leftToRight(reference: Any!)`
`ConstraintReference!`	`margin(marginValue: Any!)`
`ConstraintReference!`	`margin(value: Int)`
`ConstraintReference!`	`marginGone(marginGoneValue: Any!)`
`ConstraintReference!`	`marginGone(value: Int)`
`ConstraintReference!`	`pivotX(x: Float)`
`ConstraintReference!`	`pivotY(y: Float)`
`ConstraintReference!`	`right()`
`ConstraintReference!`	`rightToLeft(reference: Any!)`
`ConstraintReference!`	`rightToRight(reference: Any!)`
`ConstraintReference!`	`rotationX(x: Float)`
`ConstraintReference!`	`rotationY(y: Float)`
`ConstraintReference!`	`rotationZ(z: Float)`
`ConstraintReference!`	`scaleX(x: Float)`
`ConstraintReference!`	`scaleY(y: Float)`
`Unit`	`setConstraintWidget(widget: ConstraintWidget!)`
`Unit`	`setFacade(facade: Facade!)`
`ConstraintReference!`	`setHeight(dimension: Dimension!)`
`Unit`	`setHorizontalChainStyle(chainStyle: Int)`
`Unit`	`setHorizontalChainWeight(weight: Float)`
`Unit`	`setKey(key: Any!)`
`Unit`	`setTag(tag: String!)`
`Unit`	`setVerticalChainStyle(chainStyle: Int)`
`Unit`	`setVerticalChainWeight(weight: Float)`
`Unit`	`setView(view: Any!)`
`ConstraintReference!`	`setWidth(dimension: Dimension!)`
`ConstraintReference!`	`start()`
`ConstraintReference!`	`startToEnd(reference: Any!)`
`ConstraintReference!`	`startToStart(reference: Any!)`
`ConstraintReference!`	`top()`
`ConstraintReference!`	`topToBottom(reference: Any!)`
`ConstraintReference!`	`topToTop(reference: Any!)`
`ConstraintReference!`	`translationX(x: Float)`
`ConstraintReference!`	`translationY(y: Float)`
`ConstraintReference!`	`translationZ(z: Float)`
`Unit`	`validate()` Validate the constraints
`ConstraintReference!`	`verticalBias(value: Float)`
`ConstraintReference!`	`visibility(visibility: Int)`
`ConstraintReference!`	`width(dimension: Dimension!)`

From androidx.constraintlayout.core.state.HelperReference

`HelperReference!`	`add(objects: Array<Any!>!)`
`Unit`	`applyBase()` Allows the derived classes to invoke the apply method in the ConstraintReference
`ConstraintWidget!`	`getConstraintWidget()`
`State.Helper!`	`getType()`

Inherited properties

From androidx.constraintlayout.core.state.ConstraintReference

`Any!`	`mBottomToBottom`
`Any!`	`mBottomToTop`
`Any!`	`mEndToEnd`
`Any!`	`mEndToStart`
`Float`	`mHorizontalBias`
`Any!`	`mLeftToLeft`
`Any!`	`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`
`Any!`	`mRightToLeft`
`Any!`	`mRightToRight`
`Any!`	`mStartToEnd`
`Any!`	`mStartToStart`
`Any!`	`mTopToBottom`
`Any!`	`mTopToTop`
`Float`	`mVerticalBias`

From androidx.constraintlayout.core.state.HelperReference

`State!`	`mHelperState`
`ArrayList<Any!>!`	`mReferences`

Public constructors

FlowReference

Added in 1.1.0

FlowReference(state: State!, type: State.Helper!)

Public functions

addFlowElement

Added in 1.1.0

fun addFlowElement(
    id: String!,
    weight: Float,
    preMargin: Float,
    postMargin: Float
): Unit

Relate widgets to the FlowReference

Parameters
`id: String!`	id of a widget
`weight: Float`	weight of a widget
`preMargin: Float`	preMargin of a widget
`postMargin: Float`	postMargin of a widget

apply

fun apply(): Unit

getFirstHorizontalBias

Added in 1.1.0

fun getFirstHorizontalBias(): Float

Get first horizontal bias

Returns
`Float`	first horizontal bias

getFirstHorizontalStyle

Added in 1.1.0

fun getFirstHorizontalStyle(): Int

Get first horizontal style

Returns
`Int`	first horizontal style

getFirstVerticalBias

Added in 1.1.0

fun getFirstVerticalBias(): Float

Get first vertical bias

Returns
`Float`	first vertical bias value

getFirstVerticalStyle

Added in 1.1.0

fun getFirstVerticalStyle(): Int

Get first vertical style

Returns
`Int`	first vertical style

getHelperWidget

fun getHelperWidget(): HelperWidget!

getHorizontalAlign

Added in 1.1.0

fun getHorizontalAlign(): Int

Get horizontal align

Returns
`Int`	horizontal align value

getHorizontalBias

Added in 1.1.0

fun getHorizontalBias(): Float

Get horizontal bias

Returns
`Float`	horizontal bias value

getHorizontalGap

Added in 1.1.0

fun getHorizontalGap(): Int

Get horizontal gap

Returns
`Int`	horizontal gap value

getHorizontalStyle

Added in 1.1.0

fun getHorizontalStyle(): Int

Get horizontal style

Returns
`Int`	horizontal style

getLastHorizontalBias

Added in 1.1.0

fun getLastHorizontalBias(): Float

Get last horizontal bias

Returns
`Float`	last horizontal bias value

getLastHorizontalStyle

Added in 1.1.0

fun getLastHorizontalStyle(): Int

Get last horizontal style

Returns
`Int`	last horizontal style

getLastVerticalBias

Added in 1.1.0

fun getLastVerticalBias(): Float

Get last vertical bias

Returns
`Float`	last vertical bias

getLastVerticalStyle

Added in 1.1.0

fun getLastVerticalStyle(): Int

Get last vertical style

Returns
`Int`	last vertical style

getMaxElementsWrap

Added in 1.1.0

fun getMaxElementsWrap(): Int

Get max element wrap

Returns
`Int`	max element wrap value

getOrientation

Added in 1.1.0

fun getOrientation(): Int

Get the orientation of a Flow

Returns
`Int`	orientation value

getPaddingBottom

Added in 1.1.0

fun getPaddingBottom(): Int

Get paddingBottom

Returns
`Int`	paddingBottom value

getPaddingLeft

Added in 1.1.0

fun getPaddingLeft(): Int

Get paddingLeft

Returns
`Int`	paddingLeft value

getPaddingRight

Added in 1.1.0

fun getPaddingRight(): Int

Get paddingRight

Returns
`Int`	paddingRight value

getPaddingTop

Added in 1.1.0

fun getPaddingTop(): Int

Get paddingTop

Returns
`Int`	paddingTop value

getVerticalAlign

Added in 1.1.0

fun getVerticalAlign(): Int

Get vertical align

Returns
`Int`	vertical align value

getVerticalBias

Added in 1.1.0

fun getVerticalBias(): Float

Get vertical bias

Returns
`Float`	vertical bias value

getVerticalGap

Added in 1.1.0

fun getVerticalGap(): Int

Get vertical gap

Returns
`Int`	vertical gap value

getVerticalStyle

Added in 1.1.0

fun getVerticalStyle(): Int

Get vertical style

Returns
`Int`	vertical style

getWrapMode

Added in 1.1.0

fun getWrapMode(): Int

Get wrap mode

Returns
`Int`	wrap mode

setFirstHorizontalBias

Added in 1.1.0

fun setFirstHorizontalBias(firstHorizontalBias: Float): Unit

Set first horizontal bias

Parameters
`firstHorizontalBias: Float`	first horizontal bias value

setFirstHorizontalStyle

Added in 1.1.0

fun setFirstHorizontalStyle(firstHorizontalStyle: Int): Unit

Set first horizontal style

Parameters
`firstHorizontalStyle: Int`	Flow first horizontal style

setFirstVerticalBias

Added in 1.1.0

fun setFirstVerticalBias(firstVerticalBias: Float): Unit

Set first vertical bias

Parameters
`firstVerticalBias: Float`	first vertical bias value

setFirstVerticalStyle

Added in 1.1.0

fun setFirstVerticalStyle(firstVerticalStyle: Int): Unit

Set first vertical style

Parameters
`firstVerticalStyle: Int`	Flow first vertical style

setHelperWidget

fun setHelperWidget(widget: HelperWidget!): Unit

setHorizontalAlign

Added in 1.1.0

fun setHorizontalAlign(horizontalAlign: Int): Unit

Set horizontal align

Parameters
`horizontalAlign: Int`	horizontal align value

setHorizontalGap

Added in 1.1.0

fun setHorizontalGap(horizontalGap: Int): Unit

Set horizontal gap

Parameters
`horizontalGap: Int`	horizontal gap value

setHorizontalStyle

Added in 1.1.0

fun setHorizontalStyle(horizontalStyle: Int): Unit

Set horizontal style

Parameters
`horizontalStyle: Int`	Flow horizontal style

setLastHorizontalBias

Added in 1.1.0

fun setLastHorizontalBias(lastHorizontalBias: Float): Unit

Set last horizontal bias

Parameters
`lastHorizontalBias: Float`	last horizontal bias value

setLastHorizontalStyle

Added in 1.1.0

fun setLastHorizontalStyle(lastHorizontalStyle: Int): Unit

Set last horizontal style

Parameters
`lastHorizontalStyle: Int`	Flow last horizontal style

setLastVerticalBias

Added in 1.1.0

fun setLastVerticalBias(lastVerticalBias: Float): Unit

Set last vertical bias

Parameters
`lastVerticalBias: Float`	last vertical bias value

setLastVerticalStyle

Added in 1.1.0

fun setLastVerticalStyle(lastVerticalStyle: Int): Unit

Set last vertical style

Parameters
`lastVerticalStyle: Int`	Flow last vertical style

setMaxElementsWrap

Added in 1.1.0

fun setMaxElementsWrap(maxElementsWrap: Int): Unit

Set max element wrap

Parameters
`maxElementsWrap: Int`	max element wrap value

setOrientation

Added in 1.1.0

fun setOrientation(mOrientation: Int): Unit

Set the orientation of a Flow

Parameters
`mOrientation: Int`	orientation value

setPaddingBottom

Added in 1.1.0

fun setPaddingBottom(padding: Int): Unit

Set padding

Parameters
`padding: Int`	paddingBottom value

setPaddingLeft

Added in 1.1.0

fun setPaddingLeft(padding: Int): Unit

Set paddingLeft

Parameters
`padding: Int`	paddingLeft value

setPaddingRight

Added in 1.1.0

fun setPaddingRight(padding: Int): Unit

Set paddingRight

Parameters
`padding: Int`	paddingRight value

setPaddingTop

Added in 1.1.0

fun setPaddingTop(padding: Int): Unit

Set paddingTop

Parameters
`padding: Int`	paddingTop value

setVerticalAlign

Added in 1.1.0

fun setVerticalAlign(verticalAlign: Int): Unit

Set vertical align

Parameters
`verticalAlign: Int`	vertical align value

setVerticalGap

Added in 1.1.0

fun setVerticalGap(verticalGap: Int): Unit

Set vertical gap

Parameters
`verticalGap: Int`	vertical gap value

setVerticalStyle

Added in 1.1.0

fun setVerticalStyle(verticalStyle: Int): Unit

set vertical style

Parameters
`verticalStyle: Int`	Flow vertical style

setWrapMode

Added in 1.1.0

fun setWrapMode(wrap: Int): Unit

Set wrap Mode

Parameters
`wrap: Int`	wrap Mode

Protected functions

getPostMargin

Added in 1.1.0

protected fun getPostMargin(id: String!): Float

Get the post margin of a widget

Parameters
`id: String!`	id id of a widget

Returns
`Float`	the post margin of a widget

getPreMargin

Added in 1.1.0

protected fun getPreMargin(id: String!): Float

Get the pre margin of a widget

Parameters
`id: String!`	id id of a widget

Returns
`Float`	the pre margin of a widget

getWeight

Added in 1.1.0

protected fun getWeight(id: String!): Float

Get the weight of a widget

Parameters
`id: String!`	id of a widget

Returns
`Float`	the weight of a widget

Protected properties

mFirstHorizontalBias

Added in 1.1.0

protected val mFirstHorizontalBias: Float

mFirstHorizontalStyle

Added in 1.1.0

protected val mFirstHorizontalStyle: Int

mFirstVerticalBias

Added in 1.1.0

protected val mFirstVerticalBias: Float

mFirstVerticalStyle

Added in 1.1.0

protected val mFirstVerticalStyle: Int

mFlow

Added in 1.1.0

protected val mFlow: Flow!

mHorizontalAlign

Added in 1.1.0

protected val mHorizontalAlign: Int

mHorizontalGap

Added in 1.1.0

protected val mHorizontalGap: Int

mHorizontalStyle

Added in 1.1.0

protected val mHorizontalStyle: Int

mLastHorizontalBias

Added in 1.1.0

protected val mLastHorizontalBias: Float

mLastHorizontalStyle

Added in 1.1.0

protected val mLastHorizontalStyle: Int

mLastVerticalBias

Added in 1.1.0

protected val mLastVerticalBias: Float

mLastVerticalStyle

Added in 1.1.0

protected val mLastVerticalStyle: Int

mMapPostMargin

Added in 1.1.0

protected val mMapPostMargin: HashMap<String!, Float!>!

mMapPreMargin

Added in 1.1.0

protected val mMapPreMargin: HashMap<String!, Float!>!

mMapWeights

Added in 1.1.0

protected val mMapWeights: HashMap<String!, Float!>!

mMaxElementsWrap

Added in 1.1.0

protected val mMaxElementsWrap: Int

mOrientation

Added in 1.1.0

protected val mOrientation: Int

mPaddingBottom

Added in 1.1.0

protected val mPaddingBottom: Int

mPaddingLeft

Added in 1.1.0

protected val mPaddingLeft: Int

mPaddingRight

Added in 1.1.0

protected val mPaddingRight: Int

mPaddingTop

Added in 1.1.0

protected val mPaddingTop: Int

mVerticalAlign

Added in 1.1.0

protected val mVerticalAlign: Int

mVerticalGap

Added in 1.1.0

protected val mVerticalGap: Int

mVerticalStyle

Added in 1.1.0

protected val mVerticalStyle: Int

mWrapMode

Added in 1.1.0

protected val mWrapMode: Int