Libraries.Interface.Layouts.LayoutProperties Documentation

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer TOPThe TOP border style will place a border only on the top side of this Control.
integer RIGHTThe RIGHT border style will place a border only on the right side of this Control.
integer FIT_FONTThe FIT_FONT layout style is used to ensure a Control's height can fit the Font used in this LayoutProperties, plus margin from the children elements. FIT_FONT is only effective for the vertical layout style, and requires that a Font is present in this LayoutProperties.
integer LEFTThe LEFT border style will place a border only on the left side of this Control.
integer FILLThe FILL layout style will attempt to fill the remaining width or height of the container with this Control. Note that this is only effective if the container's dimensions are already known independently of this element's size -- for example, a FILL layout can't be effectively used if the container's layout style is FIT_CONTENTS.
integer ALLThe ALL border style will place borders on all four sides of this Control.
integer FIT_CONTENTSThe FIT_CONTENTS layout style will calculate this Control's dimensions as the combined total dimensions of its children elements. Because children elements often need to have some concrete information about the parent's dimensions, it's recommended to only use this in one of the two directions (horizontally or vertically) for the Control. For example, FlowLayouts work well with elements with a predetermined STANDARD horizontal layout style and using FIT_CONTENTS for the vertical layout style.
integer MAINTAIN_ASPECT_RATIOThe MAINTAIN_ASPECT_RATIO layout style is used to calculate one of the dimensions of the Control relative to the other dimension. For example, it can be used to ensure that the width of a Control is always 120% of the height. This style can only be used to calculate one of the two dimensions (width or height) at a time. For example, if the horizontal layout style is MAINTAIN_ASPECT_RATIO, the vertical layout style must be different, such as using the STANDARD style.
integer NONEThe NONE border style will disable borders on the Control this is applied to.
integer BOTTOMThe BOTTOM border style will place a border only on the bottom side of this Control.
integer STANDARDThe STANDARD layout style calculates the dimensions and positions of the Control using percentages of the Control's dimensions combined with static pixel values. Because this is dependent on the container's size to calculate the percentages, this is incompatible with container layouts that use the children to determine its own size, such as FIT_CONTENTS.

Actions Documentation

Compare(Libraries.Language.Object object)

Parameters

Return

integer

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)

GetBackgroundColor()

GetBorderStyle()

Return

integer

GetBorderThickness()

Return

number

GetBottomLeftPixelRounding()

Return

number

GetBottomLeftRounding()

Return

number

GetBottomMargin()

Return

number

GetBottomPadding()

Return

number

GetBottomRightPixelRounding()

Return

number

GetBottomRightRounding()

Return

number

GetColorProperty(text property)

Parameters

  • text property

Return

Libraries.Game.Graphics.ColorGroup

GetContainerGridHeight()

Return

integer

GetContainerGridWidth()

Return

integer

GetFocusBorderColor()

GetFocusFontColor()

GetFontOutlineColor()

GetFontOutlineThickness()

Return

number

GetFontSize()

Return

integer

GetForegroundColor()

GetForegroundSelectionColor()

GetGridHeight()

Return

integer

GetGridWidth()

Return

integer

GetGridX()

Return

integer

GetGridY()

Return

integer

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()

GetHorizontalLayoutMode()

The SetHorizontalLayoutMode is used to determine how the width of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the width as a set number of pixels plus a percentage of the container's width. FILL, which will make the width fill the remaining width of the container. FIT_CONTENTS, which will calculate the width to fit the children contents.

Return

integer:

GetInterfaceOptionsKey()

Return

text

GetInterfaceScale()

Return

number

GetLabelText()

Return

text

GetLayoutRows()

This action returns how many rows this element should occupy, if the layout supports it. This effectively makes the control taller. This is most commonly used in conjunction with FormRowLayout (or StackedRowPage which uses that layout).

Return

number:

GetLeftMargin()

Return

number

GetLeftPadding()

Return

number

GetMaximumContainerHeight()

Return

number

GetMaximumContainerWidth()

Return

number

GetMaximumHeight()

Return

number

GetMaximumWidth()

Return

number

GetMinimumHeight()

Return

number

GetMinimumWidth()

Return

number

GetMouseDownColor()

GetMouseDownFontColor()

GetMouseDownGlowColor()

GetMouseOverColor()

GetMouseOverFontColor()

GetMouseOverGlowColor()

GetNumberProperty(text property)

Parameters

  • text property

Return

number

GetPercentageHeight()

Return

number

GetPercentageOriginX()

Return

number

GetPercentageOriginY()

Return

number

GetPercentageWidth()

Return

number

GetPercentageX()

Return

number

GetPercentageY()

Return

number

GetPixelHeight()

Return

number

GetPixelWidth()

Return

number

GetPixelX()

Return

number

GetPixelY()

Return

number

GetRightMargin()

Return

number

GetRightPadding()

Return

number

GetSelectionBorderColor()

GetSelectionColor()

GetSelectionFontColor()

GetShadowEdgeFade()

Return

number

GetShadowHeight()

Return

number

GetShadowWidth()

Return

number

GetShadowX()

Return

number

GetShadowY()

Return

number

GetTopLeftPixelRounding()

Return

number

GetTopLeftRounding()

Return

number

GetTopMargin()

Return

number

GetTopPadding()

Return

number

GetTopRightPixelRounding()

Return

number

GetTopRightRounding()

Return

number

GetUnfocusedSelectionBorderColor()

GetUnfocusedSelectionColor()

GetUnfocusedSelectionFontColor()

GetVerticalLayoutMode()</