Libraries.Interface.Layouts.FlowLayout Documentation

Inherits from: Libraries.Language.Object, Libraries.Interface.Layouts.Layout

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

IsIgnoringHidden()

Fix the width to an integer. We want things to align well to pixel coordinates.

Return

boolean:

IsIgnoringInterfaceScale()

Objects are placed such that their top edge is at the currentY.

Return

boolean:

IsSingleLine()

Setting the height will trigger a resize.

Return

boolean:

IsVerticalCentering()

We have to estimate the height now to determine the width.

Return

boolean:

Layout(Libraries.Interface.Controls.Control container, Libraries.Containers.Array<Libraries.Interface.Item2D> items, number newContainerWidth, number newContainerHeight)

Objects are placed such that their top edge is at the currentY.

Parameters

SetIgnoreHidden(boolean ignore)

We had to place all elements before to determine the height of the container, but now that the height is known we need to ensure the items are placed at the right y positions.

Parameters

  • boolean ignore

SetIgnoreInterfaceScale(boolean ignore)

Boolean used to ensure we don't perform redundant resizing on items that were already fit to their contents while fitting the container width to its contents.

Parameters

  • boolean ignore

SetSingleLine(boolean single)

If there's no space left to fill, fill the next line instead.

Parameters

  • boolean single

SetVerticalCentering(boolean centering)

Boolean used to ensure we don't perform redundant resizing on a control.

Parameters

  • boolean centering