core/io.nacular.doodle.layout.constraints

Package-level declarations

Types

AllowsForcedMutation

interface AllowsForcedMutation<T, V>

Bounds

interface Bounds

The rectangular bounds for a View that is being constrained.

ConstEdges

class ConstEdges : AllowsForcedMutation<Edges, Rectangle>

ConstExpression

class ConstExpression : AllowsForcedMutation<Expression, Double>

ConstPosition

class ConstPosition : AllowsForcedMutation<Position, Point>

ConstProperty

class ConstProperty : AllowsForcedMutation<Property, Double>

Constraint

class Constraint

Defines a linear relationship that captures the relationship between a set of variables and the degree to which that relationship should be enforced.

ConstraintDslContext

open class ConstraintDslContext

Block within which constraints can be defined and captured.

ConstraintException

open class ConstraintException : Exception

Any error that can be raised when applying constrains.

ConstraintLayout

abstract class ConstraintLayout : Layout

A Layout that positions Views using a set of constraints. These layouts are created using the constrain functions and follow the form:

DuplicateConstraintException

class DuplicateConstraintException(val constraint: Constraint) : ConstraintException

Thrown when a duplicate Constraint is added.

Edges

class Edges

External boundaries of a constrained item.

Expression

open class Expression

Represents a relationship between a set of Terms and a constant value. This allows the modeling of linear relationships of the form: 10x -5y + 11.

OffsetTransformer

class OffsetTransformer(offset: Double) : Transformer<Double>

ParentBounds

interface ParentBounds

Bounds the refer to the external, bounding rectangle for the parent of a View that is being constrained.

Position

class Position

2-Dimensional value within a Bounds set.

Property

abstract class Property

Simple value within a Bounds set.

Strength

@JvmInline

value class Strength : Comparable<Strength>

Defines the weight or priority applied to a given Constraint. This determines the likelihood of the Constraint being honored.

Term

abstract class Term

A coefficient-value pair that is used to build Expressions

UnsatisfiableConstraintException

class UnsatisfiableConstraintException(val constraint: Constraint, val existingConstraints: Collection<Constraint>) : ConstraintException

Indicates a Constraint is unsatisfiable.

Properties

center

val center: ConstraintDslContext.(Bounds) -> Unit

fill

val fill: ConstraintDslContext.(Bounds) -> Unit

Functions

center

fun center(strength: Strength): ConstraintDslContext.(Bounds) -> Unit

constrain

fun constrain(a: View, constraints: ConstraintDslContext.(Bounds) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains a single View.

fun constrain(a: View, b: View, constraints: ConstraintDslContext.(Bounds, Bounds) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains 2 Views.

fun constrain(a: View, b: View, c: View, constraints: ConstraintDslContext.(Bounds, Bounds, Bounds) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains 3 Views.

fun constrain(a: View, b: View, vararg others: View, constraints: ConstraintDslContext.(List<Bounds>) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains several Views.

fun constrain(a: View, b: View, c: View, d: View, constraints: ConstraintDslContext.(Bounds, Bounds, Bounds, Bounds) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains 4 Views.

fun constrain(a: View, b: View, c: View, d: View, e: View, constraints: ConstraintDslContext.(Bounds, Bounds, Bounds, Bounds, Bounds) -> Unit): ConstraintLayout

Creates a ConstraintLayout that constrains 5 Views.

fill

fun fill(strength: Strength): ConstraintDslContext.(Bounds) -> Unit

fun fill(insets: Insets, strength: Strength = Required): ConstraintDslContext.(Bounds) -> Unit

Inherited functions

minus

inline operator fun Strength.minus(value: Int): Strength

plus

operator fun Strength.plus(value: Int): Strength

withSizeInsets

fun ConstraintDslContext.withSizeInsets(width: Double? = null, height: Double? = null, block: ConstraintDslContext.() -> Unit)