class FlowReference : 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.

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
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

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
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

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

Set wrap Mode

Protected functions

Float

Get the post margin of a widget

Float

Get the pre margin of a widget

Float

Get the weight of a widget

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

apply all the constraints attributes of the mConstraintWidget

ConstraintReference!
ConstraintReference!
baselineToBaseline(reference: Any!)
ConstraintReference!
baselineToBottom(reference: Any!)
ConstraintReference!
baselineToTop(reference: Any!)
ConstraintReference!
bias(value: Float)
ConstraintReference!
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!
ConstraintReference!

Clears all constraints.

ConstraintReference!
ConstraintReference!
ConstraintWidget!
ConstraintReference!
end()
ConstraintReference!
endToEnd(reference: Any!)
ConstraintReference!
endToStart(reference: Any!)
Float
Facade!
Dimension!
Int
Float
Any!
Float
Float
Float
Float
Float
Float
Float
String!
Float
Float
Float
Int
Float
Any!
Dimension!
ConstraintReference!
height(dimension: Dimension!)
ConstraintReference!
ConstraintReference!
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!
ConstraintReference!
ConstraintReference!
ConstraintReference!
rightToLeft(reference: Any!)
ConstraintReference!
rightToRight(reference: Any!)
ConstraintReference!
ConstraintReference!
ConstraintReference!
ConstraintReference!
ConstraintReference!
Unit
Unit
setFacade(facade: Facade!)
ConstraintReference!
setHeight(dimension: Dimension!)
Unit
Unit
Unit
setKey(key: Any!)
Unit
setTag(tag: String!)
Unit
Unit
Unit
setView(view: Any!)
ConstraintReference!
setWidth(dimension: Dimension!)
ConstraintReference!
ConstraintReference!
startToEnd(reference: Any!)
ConstraintReference!
startToStart(reference: Any!)
ConstraintReference!
top()
ConstraintReference!
topToBottom(reference: Any!)
ConstraintReference!
topToTop(reference: Any!)
ConstraintReference!
ConstraintReference!
ConstraintReference!
Unit

Validate the constraints

ConstraintReference!
ConstraintReference!
visibility(visibility: Int)
ConstraintReference!
width(dimension: Dimension!)
From androidx.constraintlayout.core.state.HelperReference
HelperReference!
add(objects: Array<Any!>!)
Unit

Allows the derived classes to invoke the apply method in the ConstraintReference

ConstraintWidget!
State.Helper!

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 mFirstHorizontalBiasFloat

mFirstHorizontalStyle

Added in 1.1.0
protected val mFirstHorizontalStyleInt

mFirstVerticalBias

Added in 1.1.0
protected val mFirstVerticalBiasFloat

mFirstVerticalStyle

Added in 1.1.0
protected val mFirstVerticalStyleInt

mFlow

Added in 1.1.0
protected val mFlowFlow!

mHorizontalAlign

Added in 1.1.0
protected val mHorizontalAlignInt

mHorizontalGap

Added in 1.1.0
protected val mHorizontalGapInt

mHorizontalStyle

Added in 1.1.0
protected val mHorizontalStyleInt

mLastHorizontalBias

Added in 1.1.0
protected val mLastHorizontalBiasFloat

mLastHorizontalStyle

Added in 1.1.0
protected val mLastHorizontalStyleInt

mLastVerticalBias

Added in 1.1.0
protected val mLastVerticalBiasFloat

mLastVerticalStyle

Added in 1.1.0
protected val mLastVerticalStyleInt

mMapPostMargin

Added in 1.1.0
protected val mMapPostMarginHashMap<String!, Float!>!

mMapPreMargin

Added in 1.1.0
protected val mMapPreMarginHashMap<String!, Float!>!

mMapWeights

Added in 1.1.0
protected val mMapWeightsHashMap<String!, Float!>!

mMaxElementsWrap

Added in 1.1.0
protected val mMaxElementsWrapInt

mOrientation

Added in 1.1.0
protected val mOrientationInt

mPaddingBottom

Added in 1.1.0
protected val mPaddingBottomInt

mPaddingLeft

Added in 1.1.0
protected val mPaddingLeftInt

mPaddingRight

Added in 1.1.0
protected val mPaddingRightInt

mPaddingTop

Added in 1.1.0
protected val mPaddingTopInt

mVerticalAlign

Added in 1.1.0
protected val mVerticalAlignInt

mVerticalGap

Added in 1.1.0
protected val mVerticalGapInt

mVerticalStyle

Added in 1.1.0
protected val mVerticalStyleInt

mWrapMode

Added in 1.1.0
protected val mWrapModeInt