Libraries.Interface.Layouts.TabFlowLayout Documentation

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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
IsIgnoringHidden()Boolean used to ensure we don't perform redundant resizing on a control.
Layout(Libraries.Interface.Controls.Control container, Libraries.Containers.Array<Libraries.Interface.Item2D> items, number containerWidth, number containerHeight)
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.
SetOffset(number offset)This action sets the starting position of the tabs.

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.

Example Code

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

Parameters

Return

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

Equals(Libraries.Language.Object object)

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

Example Code

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

Parameters

Return

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

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

IsIgnoringHidden()

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

Return

boolean:

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

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

SetOffset(number offset)

This action sets the starting position of the tabs. This is used to offset the tab positions to allow for access to tabs that hang off the edge of the container.

Parameters