GridReference

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

public class GridReference extends HelperReference

java.lang.Object
↳	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(@NonNull State state, @NonNull State.Helper type)`

Public methods
`void`	`apply()` Apply all the attributes to the helper widget (Grid)
`@Nullable String`	`getColumnWeights()` Get the column weights
`int`	`getColumnsSet()` Get the number of columns
`int`	`getFlags()` Get all the flags of a Grid
`@NonNull 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
`@Nullable String`	`getRowWeights()` Get the row weights
`int`	`getRowsSet()` Get the number of rows
`@Nullable String`	`getSkips()` Get the skips
`@Nullable String`	`getSpans()` Get the spans
`float`	`getVerticalGaps()` Get the vertical gaps
`void`	`setColumnWeights(@NonNull String columnWeights)` Set the column weights
`void`	`setColumnsSet(int columnsSet)` Set the number of columns
`void`	`setFlags(int flags)` Set flags of a Grid
`void`	`setFlags(@NonNull String flags)` Set flags of a Grid
`void`	`setHelperWidget(@Nullable HelperWidget widget)` Set the helper widget (Grid)
`void`	`setHorizontalGaps(float horizontalGaps)` Set the horizontal gaps
`void`	`setOrientation(int orientation)` Set the Orientation
`void`	`setPaddingBottom(int paddingBottom)` set padding bottom
`void`	`setPaddingEnd(int paddingEnd)` set padding right
`void`	`setPaddingStart(int paddingStart)` set padding left
`void`	`setPaddingTop(int paddingTop)` set padding top
`void`	`setRowWeights(@NonNull String rowWeights)` Set the row weights
`void`	`setRowsSet(int rowsSet)` Set the number of rows
`void`	`setSkips(@NonNull String skips)` Set the skips
`void`	`setSpans(@NonNull String spans)` Set the spans
`void`	`setVerticalGaps(float verticalGaps)` Set the vertical gaps

Inherited fields

From androidx.constraintlayout.core.state.ConstraintReference

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

From androidx.constraintlayout.core.state.HelperReference

`final State`	`mHelperState`
`ArrayList<Object>`	`mReferences`

Inherited methods

From androidx.constraintlayout.core.state.ConstraintReference

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

From androidx.constraintlayout.core.state.HelperReference

`HelperReference`	`add(Object[] objects)`
`void`	`applyBase()` Allows the derived classes to invoke the apply method in the ConstraintReference
`ConstraintWidget`	`getConstraintWidget()`
`State.Helper`	`getType()`

Public constructors

GridReference

Added in 1.1.0

public GridReference(@NonNull State state, @NonNull State.Helper type)

Public methods

apply

public void apply()

Apply all the attributes to the helper widget (Grid)

getColumnWeights

Added in 1.1.0

public @Nullable String getColumnWeights()

Get the column weights

Returns
`@Nullable String`	the column weights

getColumnsSet

Added in 1.1.0

public int getColumnsSet()

Get the number of columns

Returns
`int`	the number of columns

getFlags

Added in 1.1.0

public int getFlags()

Get all the flags of a Grid

Returns
`int`	an int value containing flag information

getHelperWidget

public @NonNull HelperWidget getHelperWidget()

Get the helper widget (Grid)

Returns
`@NonNull HelperWidget`	the helper widget (Grid)

getHorizontalGaps

Added in 1.1.0

public float getHorizontalGaps()

Get the horizontal gaps

Returns
`float`	the horizontal gaps

getOrientation

Added in 1.1.0

public int getOrientation()

Get the Orientation

Returns
`int`	the Orientation

getPaddingBottom

Added in 1.1.0

public int getPaddingBottom()

get padding bottom

Returns
`int`	padding bottom

getPaddingEnd

Added in 1.1.0

public int getPaddingEnd()

get padding right

Returns
`int`	padding right

getPaddingStart

Added in 1.1.0

public int getPaddingStart()

get padding left

Returns
`int`	padding left

getPaddingTop

Added in 1.1.0

public int getPaddingTop()

get padding top

Returns
`int`	padding top

getRowWeights

Added in 1.1.0

public @Nullable String getRowWeights()

Get the row weights

Returns
`@Nullable String`	the row weights

getRowsSet

Added in 1.1.0

public int getRowsSet()

Get the number of rows

Returns
`int`	the number of rows

getSkips

Added in 1.1.0

public @Nullable String getSkips()

Get the skips

Returns
`@Nullable String`	the skips

getSpans

Added in 1.1.0

public @Nullable String getSpans()

Get the spans

Returns
`@Nullable String`	the spans

getVerticalGaps

Added in 1.1.0

public float getVerticalGaps()

Get the vertical gaps

Returns
`float`	the vertical gaps

setColumnWeights

Added in 1.1.0

public void setColumnWeights(@NonNull String columnWeights)

Set the column weights

Parameters
`@NonNull String columnWeights`	the column weights

setColumnsSet

Added in 1.1.0

public void setColumnsSet(int columnsSet)

Set the number of columns

Parameters
`int columnsSet`	the number of columns

setFlags

Added in 1.1.0

public void setFlags(int flags)

Set flags of a Grid

Parameters
`int flags`	an int value containing flag information

setFlags

Added in 1.1.0

public void setFlags(@NonNull String flags)

Set flags of a Grid

Parameters
`@NonNull String flags`	a String containing all the flags

setHelperWidget

public void setHelperWidget(@Nullable HelperWidget widget)

Set the helper widget (Grid)

Parameters
`@Nullable HelperWidget widget`	the helper widget (Grid)

setHorizontalGaps

Added in 1.1.0

public void setHorizontalGaps(float horizontalGaps)

Set the horizontal gaps

Parameters
`float horizontalGaps`	the horizontal gaps

setOrientation

Added in 1.1.0

public void setOrientation(int orientation)

Set the Orientation

Parameters
`int orientation`	the Orientation

setPaddingBottom

Added in 1.1.0

public void setPaddingBottom(int paddingBottom)

set padding bottom

Parameters
`int paddingBottom`	padding bottom to be set

setPaddingEnd

Added in 1.1.0

public void setPaddingEnd(int paddingEnd)

set padding right

Parameters
`int paddingEnd`	padding right to be set

setPaddingStart

Added in 1.1.0

public void setPaddingStart(int paddingStart)

set padding left

Parameters
`int paddingStart`	padding left to be set

setPaddingTop

Added in 1.1.0

public void setPaddingTop(int paddingTop)

set padding top

Parameters
`int paddingTop`	padding top to be set

setRowWeights

Added in 1.1.0

public void setRowWeights(@NonNull String rowWeights)

Set the row weights

Parameters
`@NonNull String rowWeights`	the row weights

setRowsSet

Added in 1.1.0

public void setRowsSet(int rowsSet)

Set the number of rows

Parameters
`int rowsSet`	the number of rows

setSkips

Added in 1.1.0

public void setSkips(@NonNull String skips)

Set the skips

Parameters
`@NonNull String skips`	the skips

setSpans

Added in 1.1.0

public void setSpans(@NonNull String spans)

Set the spans

Parameters
`@NonNull String spans`	the spans

setVerticalGaps

Added in 1.1.0

public void setVerticalGaps(float verticalGaps)

Set the vertical gaps

Parameters
`float verticalGaps`	the vertical gaps