{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ConstraintsKt

public final class ConstraintsKt


Summary

Public methods

static final @NonNull Constraints
Constraints(int minWidth, int maxWidth, int minHeight, int maxHeight)

Create a Constraints.

static final @NonNull Constraints
constrain(
    @NonNull Constraints receiver,
    @NonNull Constraints otherConstraints
)

Takes otherConstraints and returns the result of coercing them in the current constraints.

static final @NonNull IntSize

Takes a size and returns the closest size to it that satisfies the constraints.

static final int
constrainHeight(@NonNull Constraints receiver, int height)

Takes a height and returns the closest size to it that satisfies the constraints.

static final int
constrainWidth(@NonNull Constraints receiver, int width)

Takes a width and returns the closest size to it that satisfies the constraints.

static final boolean

Takes a size and returns whether it satisfies the current constraints.

static final @NonNull Constraints
offset(@NonNull Constraints receiver, int horizontal, int vertical)

Returns the Constraints obtained by offsetting the current instance with the given values.

Public methods

Constraints

public static final @NonNull Constraints Constraints(int minWidth, int maxWidth, int minHeight, int maxHeight)

Create a Constraints. minWidth and minHeight must be positive and maxWidth and maxHeight must be greater than or equal to minWidth and minHeight, respectively, or Infinity.

constrain

public static final @NonNull Constraints constrain(
    @NonNull Constraints receiver,
    @NonNull Constraints otherConstraints
)

Takes otherConstraints and returns the result of coercing them in the current constraints. Note this means that any size satisfying the resulting constraints will satisfy the current constraints, but they might not satisfy the otherConstraints when the two set of constraints are disjoint. Examples (showing only width, height works the same): (minWidth=2, maxWidth=10).constrain(minWidth=7, maxWidth=12) -> (minWidth = 7, maxWidth = 10) (minWidth=2, maxWidth=10).constrain(minWidth=11, maxWidth=12) -> (minWidth=10, maxWidth=10) (minWidth=2, maxWidth=10).constrain(minWidth=5, maxWidth=7) -> (minWidth=5, maxWidth=7)

constrain

public static final @NonNull IntSize constrain(@NonNull Constraints receiver, @NonNull IntSize size)

Takes a size and returns the closest size to it that satisfies the constraints.

constrainHeight

public static final int constrainHeight(@NonNull Constraints receiver, int height)

Takes a height and returns the closest size to it that satisfies the constraints.

constrainWidth

public static final int constrainWidth(@NonNull Constraints receiver, int width)

Takes a width and returns the closest size to it that satisfies the constraints.

isSatisfiedBy

public static final boolean isSatisfiedBy(@NonNull Constraints receiver, @NonNull IntSize size)

Takes a size and returns whether it satisfies the current constraints.

offset

public static final @NonNull Constraints offset(@NonNull Constraints receiver, int horizontal, int vertical)

Returns the Constraints obtained by offsetting the current instance with the given values.