class Flow : VirtualLayout


Implements the Flow virtual layout.

Summary

Public constructors

Inherited functions

From androidx.constraintlayout.core.widgets.ConstraintWidget
Unit
addChildrenToSolverByDependency(
    container: ConstraintWidgetContainer!,
    system: LinearSystem!,
    widgets: HashSet<ConstraintWidget!>!,
    orientation: Int,
    addSelf: Boolean
)
Boolean

Returns true if this widget should be used in a barrier

Unit
connect(
    constraintFrom: ConstraintAnchor.Type!,
    target: ConstraintWidget!,
    constraintTo: ConstraintAnchor.Type!
)

Connect a given anchor of this widget to another anchor of a target widget

Unit
connect(from: ConstraintAnchor!, to: ConstraintAnchor!, margin: Int)

Connect the given anchors together (the from anchor should be owned by this widget)

Unit
connect(
    constraintFrom: ConstraintAnchor.Type!,
    target: ConstraintWidget!,
    constraintTo: ConstraintAnchor.Type!,
    margin: Int
)

Connect a given anchor of this widget to another anchor of a target widget

Unit
connectCircularConstraint(
    target: ConstraintWidget!,
    angle: Float,
    radius: Int
)

Set a circular constraint

Unit

Create all the system variables for this widget

Unit
Unit
ConstraintAnchor!

Given a type of anchor, returns the corresponding anchor.

ArrayList<ConstraintAnchor!>!

Return the array of anchors of this widget

Int

Return the baseline distance relative to the top of the widget

Float
getBiasPercent(orientation: Int)

Return the percentage bias that is used when two opposite connections exist of the same strength in a particular orientation.

Int

Return the bottom position of the widget

Any!

Return the companion widget.

Int

Accessor for the skip value

String!

Returns the name of this widget (used for debug purposes)

ConstraintWidget.DimensionBehaviour!
getDimensionBehaviour(orientation: Int)

Get the widget's DimensionBehaviour in an specific orientation.

Float

Return the current ratio of this widget

Int

Return the current side on which ratio will be applied

Boolean
Int

Return the height of the widget

Float

Return the horizontal percentage bias that is used when two opposite connections exist of the same strength.

ConstraintWidget!

if in a horizontal chain return the left most widget in the chain.

Int

get the chain starting from this widget to be packed.

ConstraintWidget.DimensionBehaviour!

Accessor for the horizontal dimension behaviour

Int

Returns all the horizontal margin of the widget.

Int
Int
Int

Return the left position of the widget (similar to getX)

Int
getLength(orientation: Int)

Get a dimension of the widget in a particular orientation.

Int
Int
Int

Return the minimum height of the widget

Int

Return the minimum width of the widget

ConstraintWidget!
getNextChainMember(orientation: Int)

Return the next chain member if one exists

Int
Int
ConstraintWidget!

Returns the parent of this widget if there is one

ConstraintWidget!

Return the previous chain member if one exists

Int

Return the right position of the widget

Int

Return the x position of the widget, relative to the root (without animation)

Int

Return the y position of the widget, relative to the root (without animation)

WidgetRun!
getRun(orientation: Int)
Unit
Int

Return the top position of the widget (similar to getY)

String!

Returns the type string if set

Float

Return the vertical percentage bias that is used when two opposite connections exist of the same strength.

ConstraintWidget!

if in a vertical chain return the top most widget in the chain.

Int

Set the chain starting from this widget to be packed.

ConstraintWidget.DimensionBehaviour!

Accessor for the vertical dimension behaviour

Int

Returns all the vertical margin of the widget

Int

Returns the current visibility value for this widget

Int

Return the width of the widget

Int
Int

Return the x position of the widget, relative to its container

Int

Return the y position of the widget, relative to its container

Boolean

Return true if this widget has a baseline

Boolean
hasDanglingDimension(orientation: Int)
Boolean
Boolean
Boolean
hasResolvedTargets(orientation: Int, size: Int)
Unit
immediateConnect(
    startType: ConstraintAnchor.Type!,
    target: ConstraintWidget!,
    endType: ConstraintAnchor.Type!,
    margin: Int,
    goneMargin: Int
)

Immediate connection to an anchor without any checks.

Boolean

Returns if this widget is animated.

Boolean

Returns true if height is set to wrap_content

Boolean
Boolean
isInBarrier(orientation: Int)
Boolean

Test if you are in a Horizontal chain

Boolean
Boolean

Test if you are in a vertical chain

Boolean
Boolean
Boolean
Boolean
Boolean

Returns true if the widget is the root widget

Boolean
Boolean
Boolean
Boolean

Returns true if width is set to wrap_content

Unit
Unit
Boolean
Boolean
Unit
Unit

Reset all the constraints set on this widget

Unit

Reset the given anchor

Unit

Reset all connections

Unit
Unit

Reset the solver variables of the anchors

Unit
StringBuilder!

Serialize the anchors for JSON5 output

Unit
setAnimated(animated: Boolean)

Set if this widget is animated.

Unit

Set the baseline distance relative to the top of the widget

Unit
setCompanionWidget(companion: Any!)

Set the companion widget.

Unit

Set the skip value for this widget.

Unit

Set the debug name of this widget

Unit

Utility debug function.

Unit
setDimension(w: Int, h: Int)

Set both width and height of the widget

Unit

Set the ratio of the widget

Unit
setDimensionRatio(ratio: Float, dimensionRatioSide: Int)

Set the ratio of the widget The ratio will be applied if at least one of the dimension (width or height) is set to a behaviour of DimensionBehaviour.MATCH_CONSTRAINT -- the dimension's value will be set to the other dimension * ratio.

Unit
setFinalBaseline(baselineValue: Int)
Unit
setFinalFrame(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int,
    baseline: Int,
    orientation: Int
)
Unit
Unit
Unit
Unit
setFinalVertical(y1: Int, y2: Int)
Unit
setFrame(start: Int, end: Int, orientation: Int)

Set the position+dimension of the widget based on starting/ending positions on one dimension.

Unit
setFrame(left: Int, top: Int, right: Int, bottom: Int)

Set the position+dimension of the widget given left/top/right/bottom

Unit
setGoneMargin(type: ConstraintAnchor.Type!, goneMargin: Int)

Set the margin to be used when connected to a widget with a visibility of GONE

Unit
setHasBaseline(hasBaseline: Boolean)
Unit

Set the height of the widget

Unit
setHeightWrapContent(heightWrapContent: Boolean)

Keep track of wrap_content for height

Unit
setHorizontalBiasPercent(horizontalBiasPercent: Float)

Set the horizontal bias percent to apply when we have two opposite constraints of equal strength

Unit
setHorizontalChainStyle(horizontalChainStyle: Int)

Set the chain starting from this widget to be packed.

Unit
setHorizontalDimension(left: Int, right: Int)

Set the positions for the horizontal dimension only

Unit

Set the widget's behaviour for the horizontal dimension

Unit
setHorizontalMatchStyle(
    horizontalMatchStyle: Int,
    min: Int,
    max: Int,
    percent: Float
)

Set the horizontal style when MATCH_CONSTRAINT is set

Unit
setHorizontalWeight(horizontalWeight: Float)

Set the horizontal weight (only used in chains)

Unit
setInBarrier(orientation: Int, value: Boolean)
Unit
setInPlaceholder(inPlaceholder: Boolean)
Unit
setInVirtualLayout(inVirtualLayout: Boolean)
Unit
setLastMeasureSpec(horizontal: Int, vertical: Int)
Unit
setLength(length: Int, orientation: Int)

Set the dimension of a widget in a particular orientation.

Unit
setMaxHeight(maxHeight: Int)
Unit
setMaxWidth(maxWidth: Int)
Unit
setMeasureRequested(measureRequested: Boolean)
Unit

Set the minimum height of the widget

Unit

Set the minimum width of the widget

Unit
setOffset(x: Int, y: Int)

Set the offset of this widget relative to the root widget

Unit
setOrigin(x: Int, y: Int)

Set both the origin in (x, y) of the widget, relative to its container

Unit

Set the parent of this widget

Unit
setType(type: String!)

Set the type of the widget (as a String)

Unit
setVerticalBiasPercent(verticalBiasPercent: Float)

Set the vertical bias percent to apply when we have two opposite constraints of equal strength

Unit
setVerticalChainStyle(verticalChainStyle: Int)

Set the chain starting from this widget to be packed.

Unit
setVerticalDimension(top: Int, bottom: Int)

Set the positions for the vertical dimension only

Unit

Set the widget's behaviour for the vertical dimension

Unit
setVerticalMatchStyle(
    verticalMatchStyle: Int,
    min: Int,
    max: Int,
    percent: Float
)

Set the vertical style when MATCH_CONSTRAINT is set

Unit
setVerticalWeight(verticalWeight: Float)

Set the vertical weight (only used in chains)

Unit
setVisibility(visibility: Int)

Set the visibility for this widget

Unit

Set the width of the widget

Unit
setWidthWrapContent(widthWrapContent: Boolean)

Keep track of wrap_content for width

Unit
Unit
setX(x: Int)

Set the x position of the widget, relative to its container

Unit
setY(y: Int)

Set the y position of the widget, relative to its container

Unit
setupDimensionRatio(
    hParentWrapContent: Boolean,
    vParentWrapContent: Boolean,
    horizontalDimensionFixed: Boolean,
    verticalDimensionFixed: Boolean
)

Resolves the dimension ratio parameters (mResolvedDimensionRatioSide &mDimensionRatio)

String!

Returns a string representation of the ConstraintWidget

Unit
updateFromRuns(updateHorizontal: Boolean, updateVertical: Boolean)
Unit
updateFromSolver(system: LinearSystem!, optimize: Boolean)

Update the widget from the values generated by the solver

From androidx.constraintlayout.core.widgets.HelperWidget
Unit

Add a widget to the helper

Unit
addDependents(
    dependencyLists: ArrayList<WidgetGroup!>!,
    orientation: Int,
    group: WidgetGroup!
)
Int
findGroupInDependents(orientation: Int)
Unit

Reset the widgets list contained by this helper

From androidx.constraintlayout.core.widgets.VirtualLayout

Inherited properties

From androidx.constraintlayout.core.widgets.ConstraintWidget
From androidx.constraintlayout.core.widgets.HelperWidget
From androidx.constraintlayout.core.widgets.VirtualLayout

Constants

HORIZONTAL_ALIGN_CENTER

Added in 1.1.0
const val HORIZONTAL_ALIGN_CENTER = 2: Int

HORIZONTAL_ALIGN_END

Added in 1.1.0
const val HORIZONTAL_ALIGN_END = 1: Int

HORIZONTAL_ALIGN_START

Added in 1.1.0
const val HORIZONTAL_ALIGN_START = 0: Int

VERTICAL_ALIGN_BASELINE

Added in 1.1.0
const val VERTICAL_ALIGN_BASELINE = 3: Int

VERTICAL_ALIGN_BOTTOM

Added in 1.1.0
const val VERTICAL_ALIGN_BOTTOM = 1: Int

VERTICAL_ALIGN_CENTER

Added in 1.1.0
const val VERTICAL_ALIGN_CENTER = 2: Int

VERTICAL_ALIGN_TOP

Added in 1.1.0
const val VERTICAL_ALIGN_TOP = 0: Int

WRAP_ALIGNED

Added in 1.1.0
const val WRAP_ALIGNED = 2: Int

WRAP_CHAIN

Added in 1.1.0
const val WRAP_CHAIN = 1: Int

WRAP_CHAIN_NEW

Added in 1.1.0
const val WRAP_CHAIN_NEW = 3: Int

WRAP_NONE

Added in 1.1.0
const val WRAP_NONE = 0: Int

Public constructors

Flow

Added in 1.1.0
Flow()

Public functions

addToSolver

fun addToSolver(system: LinearSystem!, optimize: Boolean): Unit

Add this widget to the solver

Parameters
system: LinearSystem!

the solver we want to add the widget to

optimize: Boolean

true if OPTIMIZATION_GRAPH is on

copy

fun copy(
    src: ConstraintWidget!,
    map: HashMap<ConstraintWidget!, ConstraintWidget!>!
): Unit

getMaxElementsWrap

Added in 1.1.0
fun getMaxElementsWrap(): Float

measure

fun measure(widthMode: Int, widthSize: Int, heightMode: Int, heightSize: Int): Unit

setFirstHorizontalBias

Added in 1.1.0
fun setFirstHorizontalBias(value: Float): Unit

setFirstHorizontalStyle

Added in 1.1.0
fun setFirstHorizontalStyle(value: Int): Unit

setFirstVerticalBias

Added in 1.1.0
fun setFirstVerticalBias(value: Float): Unit

setFirstVerticalStyle

Added in 1.1.0
fun setFirstVerticalStyle(value: Int): Unit

setHorizontalAlign

Added in 1.1.0
fun setHorizontalAlign(value: Int): Unit

setHorizontalBias

Added in 1.1.0
fun setHorizontalBias(value: Float): Unit

setHorizontalGap

Added in 1.1.0
fun setHorizontalGap(value: Int): Unit

setHorizontalStyle

Added in 1.1.0
fun setHorizontalStyle(value: Int): Unit

setLastHorizontalBias

Added in 1.1.0
fun setLastHorizontalBias(value: Float): Unit

setLastHorizontalStyle

Added in 1.1.0
fun setLastHorizontalStyle(value: Int): Unit

setLastVerticalBias

Added in 1.1.0
fun setLastVerticalBias(value: Float): Unit

setLastVerticalStyle

Added in 1.1.0
fun setLastVerticalStyle(value: Int): Unit

setMaxElementsWrap

Added in 1.1.0
fun setMaxElementsWrap(value: Int): Unit

setOrientation

Added in 1.1.0
fun setOrientation(value: Int): Unit

setVerticalAlign

Added in 1.1.0
fun setVerticalAlign(value: Int): Unit

setVerticalBias

Added in 1.1.0
fun setVerticalBias(value: Float): Unit

setVerticalGap

Added in 1.1.0
fun setVerticalGap(value: Int): Unit

setVerticalStyle

Added in 1.1.0
fun setVerticalStyle(value: Int): Unit

setWrapMode

Added in 1.1.0
fun setWrapMode(value: Int): Unit