swing-ui-foundation/org.jetbrains.compose.swing.foundation.layout/Constraints

Constraints

class Constraints(val minWidth: Int = 0, val maxWidth: Int = Int.MAX_VALUE, val minHeight: Int = 0, val maxHeight: Int = Int.MAX_VALUE)

The extents a parent offers a child: the least it must occupy along each axis and the most it may.

A container computes these for each of its children and measures the child under them; the child answers with an extent inside them. Int.MAX_VALUE as a maximum means the axis is unbounded - the parent imposes no ceiling there, which is what a container asked for the extent it prefers offers, and what maximumLayoutSize already reports for a row.

The extents are plain Ints, the unit every other geometry in this library is written in.

Throws

IllegalArgumentException

if either minimum is negative or greater than its own maximum

Constructors

Constraints

constructor(minWidth: Int = 0, maxWidth: Int = Int.MAX_VALUE, minHeight: Int = 0, maxHeight: Int = Int.MAX_VALUE)

Types

Companion

object Companion

The standard constraints.

Properties

hasBoundedHeight

val hasBoundedHeight: Boolean

Whether the height has a finite maximum.

hasBoundedWidth

val hasBoundedWidth: Boolean

Whether the width has a finite maximum.

hasFixedHeight

val hasFixedHeight: Boolean

Whether the height can take exactly one value.

hasFixedWidth

val hasFixedWidth: Boolean

Whether the width can take exactly one value.

isZero

@Stable

val isZero: Boolean

Whether every size satisfying these constraints has zero area.

maxHeight

val maxHeight: Int

the most height the child may occupy, Int.MAX_VALUE for an unbounded axis

maxWidth

val maxWidth: Int

the most width the child may occupy, Int.MAX_VALUE for an unbounded axis

minHeight

val minHeight: Int

the least height the child must occupy

minWidth

val minWidth: Int

the least width the child must occupy

Functions

constrain

@Stable

fun Constraints.constrain(size: Dimension): Dimension

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

fun Constraints.constrain(otherConstraints: Constraints): Constraints

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)

constrainHeight

@Stable

fun Constraints.constrainHeight(height: Int): Int

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

constrainWidth

@Stable

fun Constraints.constrainWidth(width: Int): Int

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

copy

fun copy(minWidth: Int = this.minWidth, maxWidth: Int = this.maxWidth, minHeight: Int = this.minHeight, maxHeight: Int = this.maxHeight): Constraints

A new constraint with every extent left unchanged unless this call supplies a replacement.

copyMaxDimensions

@Stable

fun copyMaxDimensions(): Constraints

A copy with both minimum dimensions reset to zero.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isSatisfiedBy

@Stable

fun Constraints.isSatisfiedBy(size: Dimension): Boolean

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

offset

@Stable

fun Constraints.offset(horizontal: Int = 0, vertical: Int = 0): Constraints

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

toString

open override fun toString(): String