class GridCore : VirtualLayout


The Grid Helper in the Core library that helps to enable Grid in Compose

Summary

Constants

const Int
const Int
const Int
const Int

Public constructors

GridCore(rows: Int, columns: Int)

Public functions

Unit
addToSolver(system: LinearSystem?, optimize: Boolean)

Add this widget to the solver

String?

get the string value of columnWeights

ConstraintWidgetContainer?

get the parent ConstraintWidgetContainer

IntArray<Int>

Get all the flags of a Grid

Float

get the value of horizontalGaps

Int

get the value of orientation

String?

get the string value of rowWeights

Float

get the value of verticalGaps

Unit
measure(widthMode: Int, widthSize: Int, heightMode: Int, heightSize: Int)
Unit
setColumnWeights(columnWeights: String)

set new columnWeights value and also invoke invalidate

Unit
setColumns(columns: Int)

set new columns value

Unit

Set the parent ConstraintWidgetContainer

Unit

Set flags of a Grid

Unit
setHorizontalGaps(horizontalGaps: Float)

set new horizontalGaps value and also invoke invalidate

Unit
setOrientation(orientation: Int)

set new orientation value

Unit
setRowWeights(rowWeights: String)

set new rowWeights value and also invoke invalidate

Unit
setRows(rows: Int)

set new rows value

Unit
setSkips(skips: String)

set new skips value

Unit

set new spans value

Unit
setVerticalGaps(verticalGaps: Float)

set new verticalGaps value and also invoke invalidate

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!
)
Unit
copy(
    src: ConstraintWidget!,
    map: HashMap<ConstraintWidget!, ConstraintWidget!>!
)
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

Added in 1.1.0-alpha13
const val HORIZONTAL = 0: Int

SPANS_RESPECT_WIDGET_ORDER

Added in 1.1.0-alpha13
const val SPANS_RESPECT_WIDGET_ORDER = 1: Int

SUB_GRID_BY_COL_ROW

Added in 1.1.0-alpha13
const val SUB_GRID_BY_COL_ROW = 0: Int

VERTICAL

Added in 1.1.0-alpha13
const val VERTICAL = 1: Int

Public constructors

GridCore

Added in 1.1.0-alpha13
GridCore()

GridCore

Added in 1.1.0-alpha13
GridCore(rows: Int, columns: Int)

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

getColumnWeights

Added in 1.1.0-alpha13
fun getColumnWeights(): String?

get the string value of columnWeights

Returns
String?

the string value of columnWeights

getContainer

Added in 1.1.0-alpha13
fun getContainer(): ConstraintWidgetContainer?

get the parent ConstraintWidgetContainer

Returns
ConstraintWidgetContainer?

the parent ConstraintWidgetContainer

getFlags

Added in 1.1.0-alpha13
fun getFlags(): IntArray<Int>

Get all the flags of a Grid

Returns
IntArray<Int>

a int array containing all the flags

getHorizontalGaps

Added in 1.1.0-alpha13
fun getHorizontalGaps(): Float

get the value of horizontalGaps

Returns
Float

the value of horizontalGaps

getOrientation

Added in 1.1.0-alpha13
fun getOrientation(): Int

get the value of orientation

Returns
Int

the value of orientation

getRowWeights

Added in 1.1.0-alpha13
fun getRowWeights(): String?

get the string value of rowWeights

Returns
String?

the string value of rowWeights

getVerticalGaps

Added in 1.1.0-alpha13
fun getVerticalGaps(): Float

get the value of verticalGaps

Returns
Float

the value of verticalGaps

measure

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

setColumnWeights

Added in 1.1.0-alpha13
fun setColumnWeights(columnWeights: String): Unit

set new columnWeights value and also invoke invalidate

Parameters
columnWeights: String

new columnWeights value

setColumns

Added in 1.1.0-alpha13
fun setColumns(columns: Int): Unit

set new columns value

Parameters
columns: Int

new rows value

setContainer

Added in 1.1.0-alpha13
fun setContainer(container: ConstraintWidgetContainer): Unit

Set the parent ConstraintWidgetContainer

Parameters
container: ConstraintWidgetContainer

the parent ConstraintWidgetContainer

setFlags

Added in 1.1.0-alpha13
fun setFlags(flags: IntArray): Unit

Set flags of a Grid

Parameters
flags: IntArray

a int array containing all the flags

setHorizontalGaps

Added in 1.1.0-alpha13
fun setHorizontalGaps(horizontalGaps: Float): Unit

set new horizontalGaps value and also invoke invalidate

Parameters
horizontalGaps: Float

new horizontalGaps value

setOrientation

Added in 1.1.0-alpha13
fun setOrientation(orientation: Int): Unit

set new orientation value

Parameters
orientation: Int

new orientation value

setRowWeights

Added in 1.1.0-alpha13
fun setRowWeights(rowWeights: String): Unit

set new rowWeights value and also invoke invalidate

Parameters
rowWeights: String

new rowWeights value

setRows

Added in 1.1.0-alpha13
fun setRows(rows: Int): Unit

set new rows value

Parameters
rows: Int

new rows value

setSkips

Added in 1.1.0-alpha13
fun setSkips(skips: String): Unit

set new skips value

Parameters
skips: String

new spans value

setSpans

Added in 1.1.0-alpha13
fun setSpans(spans: CharSequence): Unit

set new spans value

Parameters
spans: CharSequence

new spans value

setVerticalGaps

Added in 1.1.0-alpha13
fun setVerticalGaps(verticalGaps: Float): Unit

set new verticalGaps value and also invoke invalidate

Parameters
verticalGaps: Float

new verticalGaps value