View source

class VerticalLayout

package feathers.layout

extends EventDispatcher

implements ILayout

@:directlyUsed@:event(openfl.events.Event.CHANGE)

Positions items from top to bottom in a single column.

Events:

openfl.events.Event.CHANGE

Dispatched when a property of the layout changes, which triggers the container to invalidate.

Available since

1.0.0

.

See also:

Constructor

new()

Creates a new VerticalLayout object.

Available since

1.0.0

.

Variables

gap:Float

The space, in pixels, between each two adjacent items in the layout.

If the gap is set to Math.POSITIVE_INFINITY, the items will be positioned as far apart as possible. In this case, the gap will never be smaller than minGap.

In the following example, the layout's gap is set to 20 pixels:

layout.gap = 20.0;
Available since

1.0.0

.

horizontalAlign:HorizontalAlign

How the content is positioned horizontally (along the x-axis) within the container.

The following example aligns the container's content to the right:

layout.horizontalAlign = RIGHT;
Available since

1.0.0

.

See also:

justifyResetEnabled:Bool

Indicates if the width of items should be reset if the horizontalAlign property is set to HorizontalAlign.JUSTIFY and the explicit width of the parent container is not set.

Available since

1.0.0

.

See also:

minGap:Float

If the value of the gap property is Math.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible and position the items as far from each other as they can go without going outside of the view port bounds, the final calculated value of the gap will not be smaller than the value of the minGap property.

In the following example, the layout's minimum gap is set to 4 pixels:

layout.minGap = 4.0;
Available since

1.0.0

.

paddingBottom:Float

The space, in pixels, between the parent container's bottom edge and its content.

In the following example, the layout's bottom padding is set to 20 pixels:

layout.paddingBottom = 20.0;
Available since

1.0.0

.

paddingLeft:Float

The space, in pixels, between the parent container's left edge and its content.

In the following example, the layout's left padding is set to 20 pixels:

layout.paddingLeft = 20.0;
Available since

1.0.0

.

paddingRight:Float

The space, in pixels, between the parent container's right edge and its content.

In the following example, the layout's right padding is set to 20 pixels:

layout.paddingRight = 20.0;
Available since

1.0.0

.

paddingTop:Float

The space, in pixels, between the parent container's top edge and its content.

In the following example, the layout's top padding is set to 20 pixels:

layout.paddingTop = 20.0;
Available since

1.0.0

.

verticalAlign:VerticalAlign

How the content is positioned vertically (along the y-axis) within the container. If the total height of the content is larger than the available height within the container, then the positioning of the items will always start from the top.

Note: The VerticalAlign.JUSTIFY constant is not supported by this layout.

The following example aligns the container's content to the bottom:

layout.verticalAlign = BOTTOM;
Available since

1.0.0

.

See also:

Methods

layout(items:Array<DisplayObject>, measurements:Measurements, ?result:LayoutBoundsResult):LayoutBoundsResult

See also:

setPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also: