Constraints

@Immutable
value class Constraints(value: Long)

Immutable constraints for measuring layouts, used by layouts or layout modifiers to measure their layout children. The parent chooses the Constraints defining a range, in pixels, within which the measured layout should choose a size:

  • minWidth<= chosenWidth<= maxWidth

  • minHeight<= chosenHeight<= maxHeight

For more details about how layout measurement works, see com.jakewharton.mosaic.layout.MeasurePolicy or com.jakewharton.mosaic.layout.LayoutModifier.measure.

A set of Constraints can have infinite maxWidth and/or maxHeight. This is a trick often used by parents to ask their children for their preferred size: unbounded constraints force children whose default behavior is to fill the available space (always size to maxWidth/maxHeight) to have an opinion about their preferred size. Most commonly, when measured with unbounded Constraints, these children will fallback to size themselves to wrap their content, instead of expanding to fill the available space (this is not always true as it depends on the child layout model, but is a common behavior for core layout components).

Constraints uses a Long to represent four values, minWidth, minHeight, maxWidth, and maxHeight. The range of the values varies to allow for at most 256K in one dimension. There are four possible maximum ranges, 13 bits/18 bits, and 15 bits/16 bits for either width or height, depending on the needs. For example, a width could range up to 18 bits and the height up to 13 bits. Alternatively, the width could range up to 16 bits and the height up to 15 bits. The height and width requirements can be reversed, with a height of up to 18 bits and width of 13 bits or height of 16 bits and width of 15 bits. Any constraints exceeding this range will fail.

Constructors

Link copied to clipboard
constructor(value: Long)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

false when maxHeight is Infinity and true if maxHeight is a non-Infinity value.

Link copied to clipboard

false when maxWidth is Infinity and true if maxWidth is a non-Infinity value.

Link copied to clipboard

Whether there is exactly one height value that satisfies the constraints.

Link copied to clipboard

Whether there is exactly one width value that satisfies the constraints.

Link copied to clipboard
@Stable
val isZero: Boolean

Whether the area of a component respecting these constraints will definitely be 0. This is true when at least one of maxWidth and maxHeight are 0.

Link copied to clipboard

The maximum height that the measurement can take, in pixels. This will either be a positive value greater than or equal to minHeight or Constraints.Infinity.

Link copied to clipboard

The maximum width that the measurement can take, in pixels. This will either be a positive value greater than or equal to minWidth or Constraints.Infinity.

Link copied to clipboard

The minimum height that the measurement can take, in pixels.

Link copied to clipboard

The minimum width that the measurement can take, in pixels.

Functions

Link copied to clipboard

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)

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

Link copied to clipboard
@Stable
fun Constraints.constrainHeight(height: Int): Int

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

Link copied to clipboard
@Stable
fun Constraints.constrainWidth(width: Int): Int

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

Link copied to clipboard
fun copy(minWidth: Int = this.minWidth, maxWidth: Int = this.maxWidth, minHeight: Int = this.minHeight, maxHeight: Int = this.maxHeight): Constraints

Copies the existing Constraints, replacing some of minWidth, minHeight, maxWidth, or maxHeight as desired. minWidth and minHeight must be positive and maxWidth and maxHeight must be greater than or equal to minWidth and minHeight, respectively, or Infinity.

Link copied to clipboard

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

Link copied to clipboard
@Stable
fun Constraints.offset(horizontal: Int = 0, vertical: Int = 0): Constraints

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

Link copied to clipboard
open override fun toString(): String