PlacementModifierScope


The scope to the block callback in of the placement modifier.

Summary

Public constructors

Cmn

Public properties

Dp

Offsets the component vertically from its original calculated bottom position.

Cmn
Breadth

Sets the preferred height of the component.

Cmn
Dp

Offsets the component horizontally from its original calculated left position.

Cmn
Dp

Constrains the maximum height of the component.

Cmn
Dp

Constrains the maximum width of the component.

Cmn
Dp

Constrains the minimum height of the component.

Cmn
Dp

Constrains the minimum width of the component.

Cmn
Dp

Offsets the component horizontally from its original calculated right position.

Cmn
Dp

Offsets the component vertically from its original calculated top position.

Cmn
Breadth

Sets the preferred width of the component.

Cmn

Public constructors

PlacementModifierScope

PlacementModifierScope()

Public properties

bottom

var bottomDp

Offsets the component vertically from its original calculated bottom position. Positive values shift the component upwards (further from the bottom edge), negative downwards.

height

var heightBreadth

Sets the preferred height of the component. The actual size will also depend on the parent's constraints and other modifiers.

left

var leftDp

Offsets the component horizontally from its original calculated left position. Positive values shift the component to the right, negative to the left.

maxHeight

var maxHeightDp

Constrains the maximum height of the component. The component's height, including padding, will be at most this value.

If maxHeight is negative it is treated as being 0.dp.

If top and/or bottom are specified, maxHeight is clamped to the remaining vertical space remaining in the constraints after the top and bottom are removed.

maxWidth

var maxWidthDp

Constrains the maximum width of the component. The component's width, including padding, will be at most this value.

If maxWidth is negative it is treated as being 0.dp.

If left and/or right are specified, maxWidth is clamped to the remaining horizontal space remaining in the constraints after the left and right are removed.

minHeight

var minHeightDp

Constrains the minimum height of the component. The component's height, including padding, will be at least this value.

If both minHeight and maxHeight are specified and minHeight is greater than maxHeight will be clamped to maxHeight.

If top and/or bottom are specified, minHeight is clamped to the remaining vertical space remaining in the constraints in the constraints after the top and bottom are removed.

minWidth

var minWidthDp

Constrains the minimum width of the component. The component's width, including padding, will be at least this value.

If both minWidth and maxWidth are specified and minWidth is greater than maxWidth will be clamped to maxWidth.

If left and/or right are specified, maxWidth is clamped to the remaining horizontal space remaining in the constraints after the left and right are removed.

right

var rightDp

Offsets the component horizontally from its original calculated right position. Positive values shift the component to the left (further from the right edge), negative to the right.

top

var topDp

Offsets the component vertically from its original calculated top position. Positive values shift the component downwards, negative upwards.

width

var widthBreadth

Sets the preferred width of the component. The actual size will also depend on the parent's constraints and other modifiers.