View source

class FlowProperties

package h2d

import h2d.Flow

@:directlyUsed@:allow(h2d.Flow)

An individual Flow element properties.

Can be obtained after adding the element to the Flow and calling Flow.getProperties. Contains configuration unique of each Flow element.

Variables

write onlyautoSize:Null<Float>

When set, element will use the maximum size of non-autoSize elements as size constraint instead of current constraint on the parent flow.

autoSizeHeight:Null<Float>

autoSizeWidth:Null<Float>

@:value(0)read onlycalculatedHeight:Int = 0

The calculated element height since last element reflow.

@:value(0)read onlycalculatedWidth:Int = 0

The calculated element width since last element reflow.

@:value(true)constraint:Bool = true

Will constraint the element size through Object.constraintSize if the Flow have a set maximum size.

See also:

horizontalAlign:Null<FlowAlign>

The Flow.horizontalAlign override.

If FlowProperties.isAbsolute is enabled - aligns the element within the Flow boundaries. Otherwise affects the element alignment within the Flow. Does not affect the alignment if Flow.layout is Horizontal.

@:value(false)isAbsolute:Bool = false

When enabled, element won't be automatically positioned during Flow.reflow and instead treated as an absolute element relative to the Flow.

read onlyisBreak:Bool

Whether this element is the last on its current row/column, and the next flow element being on the next row/column after overflow.

@:value(false)lineBreak:Bool = false

Forces this element to break the line and flow onto the next row/column. Flow.multiline is not required to be enabled.

minHeight:Null<Int>

The minimum occupied height of the element within the flow.

minWidth:Null<Int>

The minimum occupied width of the element within the flow.

@:value(0)offsetX:Int = 0

A visual offset of the element along the X axis.

Offset does not affect the occupied space by the element, and can lead to overlapping with other elements.

@:value(0)offsetY:Int = 0

A visual offset of the element along the Y axis.

Offset does not affect the occupied space by the element, and can lead to overlapping with other elements.

@:value(0)paddingBottom:Int = 0

An extra padding to the bottom of the flow element.

@:value(0)paddingLeft:Int = 0

An extra padding to the left of the flow element.

@:value(0)paddingRight:Int = 0

An extra padding to the right of the flow element.

@:value(0)paddingTop:Int = 0

An extra padding to the top of the flow element.

verticalAlign:Null<FlowAlign>

The Flow.verticalAlign override.

If FlowProperties.isAbsolute is enabled - aligns the element within the Flow boundaries. Otherwise affects the element alignment within the Flow. Does not affect the alignment if Flow.layout is Vertical.

Methods

inlinealign(vertical:Null<FlowAlign>, horizontal:Null<FlowAlign>):Void

Shortcut to set both FlowProperties.verticalAlign and FlowProperties.horizontalAlign.