GridReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

class GridReference : HelperReference

kotlin.Any
↳	androidx.constraintlayout.core.state.ConstraintReference
	↳	androidx.constraintlayout.core.state.HelperReference
		↳	androidx.constraintlayout.core.state.helpers.GridReference

A HelperReference of a Grid Helper that helps enable Grid in Compose

Summary

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

Public functions
`Unit`	`apply()` Apply all the attributes to the helper widget (Grid)
`String?`	`getColumnWeights()` Get the column weights
`Int`	`getColumnsSet()` Get the number of columns
`Int`	`getFlags()` Get all the flags of a Grid
`HelperWidget`	`getHelperWidget()` Get the helper widget (Grid)
`Float`	`getHorizontalGaps()` Get the horizontal gaps
`Int`	`getOrientation()` Get the Orientation
`Int`	`getPaddingBottom()` get padding bottom
`Int`	`getPaddingEnd()` get padding right
`Int`	`getPaddingStart()` get padding left
`Int`	`getPaddingTop()` get padding top
`String?`	`getRowWeights()` Get the row weights
`Int`	`getRowsSet()` Get the number of rows
`String?`	`getSkips()` Get the skips
`String?`	`getSpans()` Get the spans
`Float`	`getVerticalGaps()` Get the vertical gaps
`Unit`	`setColumnWeights(columnWeights: String)` Set the column weights
`Unit`	`setColumnsSet(columnsSet: Int)` Set the number of columns
`Unit`	`setFlags(flags: Int)` Set flags of a Grid
`Unit`	`setFlags(flags: String)` Set flags of a Grid
`Unit`	`setHelperWidget(widget: HelperWidget?)` Set the helper widget (Grid)
`Unit`	`setHorizontalGaps(horizontalGaps: Float)` Set the horizontal gaps
`Unit`	`setOrientation(orientation: Int)` Set the Orientation
`Unit`	`setPaddingBottom(paddingBottom: Int)` set padding bottom
`Unit`	`setPaddingEnd(paddingEnd: Int)` set padding right
`Unit`	`setPaddingStart(paddingStart: Int)` set padding left
`Unit`	`setPaddingTop(paddingTop: Int)` set padding top
`Unit`	`setRowWeights(rowWeights: String)` Set the row weights
`Unit`	`setRowsSet(rowsSet: Int)` Set the number of rows
`Unit`	`setSkips(skips: String)` Set the skips
`Unit`	`setSpans(spans: String)` Set the spans
`Unit`	`setVerticalGaps(verticalGaps: Float)` Set the vertical gaps

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

GridReference

Added in 1.1.0

GridReference(state: State, type: State.Helper)

Public functions

apply

fun apply(): Unit

Apply all the attributes to the helper widget (Grid)

getColumnWeights

Added in 1.1.0

fun getColumnWeights(): String?

Get the column weights

Returns
`String?`	the column weights

getColumnsSet

Added in 1.1.0

fun getColumnsSet(): Int

Get the number of columns

Returns
`Int`	the number of columns

getFlags

Added in 1.1.0

fun getFlags(): Int

Get all the flags of a Grid

Returns
`Int`	an int value containing flag information

getHelperWidget

fun getHelperWidget(): HelperWidget

Get the helper widget (Grid)

Returns
`HelperWidget`	the helper widget (Grid)

getHorizontalGaps

Added in 1.1.0

fun getHorizontalGaps(): Float

Get the horizontal gaps

Returns
`Float`	the horizontal gaps

getOrientation

Added in 1.1.0

fun getOrientation(): Int

Get the Orientation

Returns
`Int`	the Orientation

getPaddingBottom

Added in 1.1.0

fun getPaddingBottom(): Int

get padding bottom

Returns
`Int`	padding bottom

getPaddingEnd

Added in 1.1.0

fun getPaddingEnd(): Int

get padding right

Returns
`Int`	padding right

getPaddingStart

Added in 1.1.0

fun getPaddingStart(): Int

get padding left

Returns
`Int`	padding left

getPaddingTop

Added in 1.1.0

fun getPaddingTop(): Int

get padding top

Returns
`Int`	padding top

getRowWeights

Added in 1.1.0

fun getRowWeights(): String?

Get the row weights

Returns
`String?`	the row weights

getRowsSet

Added in 1.1.0

fun getRowsSet(): Int

Get the number of rows

Returns
`Int`	the number of rows

getSkips

Added in 1.1.0

fun getSkips(): String?

Get the skips

Returns
`String?`	the skips

getSpans

Added in 1.1.0

fun getSpans(): String?

Get the spans

Returns
`String?`	the spans

getVerticalGaps

Added in 1.1.0

fun getVerticalGaps(): Float

Get the vertical gaps

Returns
`Float`	the vertical gaps

setColumnWeights

Added in 1.1.0

fun setColumnWeights(columnWeights: String): Unit

Set the column weights

Parameters
`columnWeights: String`	the column weights

setColumnsSet

Added in 1.1.0

fun setColumnsSet(columnsSet: Int): Unit

Set the number of columns

Parameters
`columnsSet: Int`	the number of columns

setFlags

Added in 1.1.0

fun setFlags(flags: Int): Unit

Set flags of a Grid

Parameters
`flags: Int`	an int value containing flag information

setFlags

Added in 1.1.0

fun setFlags(flags: String): Unit

Set flags of a Grid

Parameters
`flags: String`	a String containing all the flags

setHelperWidget

fun setHelperWidget(widget: HelperWidget?): Unit

Set the helper widget (Grid)

Parameters
`widget: HelperWidget?`	the helper widget (Grid)

setHorizontalGaps

Added in 1.1.0

fun setHorizontalGaps(horizontalGaps: Float): Unit

Set the horizontal gaps

Parameters
`horizontalGaps: Float`	the horizontal gaps

setOrientation

Added in 1.1.0

fun setOrientation(orientation: Int): Unit

Set the Orientation

Parameters
`orientation: Int`	the Orientation

setPaddingBottom

Added in 1.1.0

fun setPaddingBottom(paddingBottom: Int): Unit

set padding bottom

Parameters
`paddingBottom: Int`	padding bottom to be set

setPaddingEnd

Added in 1.1.0

fun setPaddingEnd(paddingEnd: Int): Unit

set padding right

Parameters
`paddingEnd: Int`	padding right to be set

setPaddingStart

Added in 1.1.0

fun setPaddingStart(paddingStart: Int): Unit

set padding left

Parameters
`paddingStart: Int`	padding left to be set

setPaddingTop

Added in 1.1.0

fun setPaddingTop(paddingTop: Int): Unit

set padding top

Parameters
`paddingTop: Int`	padding top to be set

setRowWeights

Added in 1.1.0

fun setRowWeights(rowWeights: String): Unit

Set the row weights

Parameters
`rowWeights: String`	the row weights

setRowsSet

Added in 1.1.0

fun setRowsSet(rowsSet: Int): Unit

Set the number of rows

Parameters
`rowsSet: Int`	the number of rows

setSkips

Added in 1.1.0

fun setSkips(skips: String): Unit

Set the skips

Parameters
`skips: String`	the skips

setSpans

Added in 1.1.0

fun setSpans(spans: String): Unit

Set the spans

Parameters
`spans: String`	the spans

setVerticalGaps

Added in 1.1.0

fun setVerticalGaps(verticalGaps: Float): Unit

Set the vertical gaps

Parameters
`verticalGaps: Float`	the vertical gaps