org.mini2Dx.ui.layout

Class PixelLayoutUtils

java.lang.Object

org.mini2Dx.ui.layout.PixelLayoutUtils

public class PixelLayoutUtils
extends java.lang.Object

Utility class for layout of elements based on pixel coordinates

Constructor Summary

Constructors

Constructor and Description
PixelLayoutUtils()

Method Summary

Modifier and Type	Method and Description
static void	alignAbove(UiElement element, UiElement alignToElement, HorizontalAlignment horizontalAlignment) Aligns the bottom edge of a UiElement to the top of another element
static void	alignBelow(UiElement element, UiElement alignToElement, HorizontalAlignment horizontalAlignment) Aligns the top edge of a UiElement to the bottom of another element
static void	alignEdgeToEdge(UiElement element, UiElement alignToElement, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment) Aligns the edges of a UiElement to the edges of another element.
static void	alignLeftOf(UiElement element, UiElement alignToElement, VerticalAlignment verticalAlignment) Aligns the right edge of a UiElement to the left edge of another element
static void	alignRightOf(UiElement element, UiElement alignToElement, VerticalAlignment verticalAlignment) Aligns the left edge of this element to the right edge of another element
static boolean	isOperationsComplete()
static void	resizeScrollContentHeightToContents(ScrollBox scrollBox)
static void	setHeightToContentHeight(UiElement element, UiElement matchElement) Sets the height of one UiElement to match the content height of another element.
static void	setHeightToHeight(UiElement element, UiElement matchElement) Sets the height of one UiElement to match the height of another element
static void	setWidthToContentWidth(UiElement element, UiElement matchElement) Sets the width of one UiElement to match the content width of another element.
static void	setWidthToWidth(UiElement element, UiElement matchElement) Sets the width of one UiElement to match the width of another element
static void	shrinkToContents(ParentUiElement parentUiElement, boolean recursive, java.lang.Runnable callback) Shrinks the width and height for a ParentUiElement based on its children
static void	snapTo(UiElement element, UiElement snapToElement) Snaps the top-left of a UiElement to the top-left corner of another UiElement
static void	snapTo(UiElement element, UiElement snapToElement, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment) Snaps the edge of a UiElement to the edge of another element.
static void	update(float delta)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PixelLayoutUtils

public PixelLayoutUtils()

Method Detail

update

public static void update(float delta)

isOperationsComplete

public static boolean isOperationsComplete()

shrinkToContents

public static void shrinkToContents(ParentUiElement parentUiElement,
                                    boolean recursive,
                                    java.lang.Runnable callback)

Shrinks the width and height for a ParentUiElement based on its children

Parameters:

parentUiElement - The ParentUiElement to set

alignEdgeToEdge

public static void alignEdgeToEdge(UiElement element,
                                   UiElement alignToElement,
                                   HorizontalAlignment horizontalAlignment,
                                   VerticalAlignment verticalAlignment)

Aligns the edges of a UiElement to the edges of another element.

Parameters:

element - The UiElement to perform alignment on

alignToElement - The UiElement to align with. Note: This can also be the UiContainer

horizontalAlignment - HorizontalAlignment.LEFT aligns the right-side of this element to the left side of the align element. HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. HorizontalAlignment.RIGHT aligns the left-side of this element to the right-side of the align element.

verticalAlignment - VerticalAlignment.TOP aligns the bottom-side of this element to the top-side of the align element. VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. VerticalAlignment.BOTTOM aligns the top-side of this element to the bottom-side of the align element.

alignLeftOf

public static void alignLeftOf(UiElement element,
                               UiElement alignToElement,
                               VerticalAlignment verticalAlignment)

Aligns the right edge of a UiElement to the left edge of another element

Parameters:

element - The UiElement to perform alignment on

alignToElement - The UiElement to align with. Note: This can also be the UiContainer

verticalAlignment - VerticalAlignment.TOP aligns the top-side of this element to the top-side of the align element. * VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. * VerticalAlignment.BOTTOM aligns the bottom-side of this element to the bottom-side of the align element.

alignRightOf

public static void alignRightOf(UiElement element,
                                UiElement alignToElement,
                                VerticalAlignment verticalAlignment)

Aligns the left edge of this element to the right edge of another element

Parameters:

element - The UiElement to perform alignment on

alignToElement - The UiElement to align with. Note: This can also be the UiContainer

verticalAlignment - VerticalAlignment.TOP aligns the top-side of this element to the top-side of the align element. * VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. * VerticalAlignment.BOTTOM aligns the bottom-side of this element to the bottom-side of the align element.

alignBelow

public static void alignBelow(UiElement element,
                              UiElement alignToElement,
                              HorizontalAlignment horizontalAlignment)

Aligns the top edge of a UiElement to the bottom of another element

Parameters:

element - The UiElement to perform alignment on

alignToElement - The UiElement to align with. Note: This can also be the UiContainer

horizontalAlignment - HorizontalAlignment.LEFT aligns the left-side of this element to the left side of the align element. HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. HorizontalAlignment.RIGHT aligns the right-side of this element to the right-side of the align element.

alignAbove

public static void alignAbove(UiElement element,
                              UiElement alignToElement,
                              HorizontalAlignment horizontalAlignment)

Aligns the bottom edge of a UiElement to the top of another element

Parameters:

element - The UiElement to perform alignment on

alignToElement - The UiElement to align with. Note: This can also be the UiContainer

horizontalAlignment - HorizontalAlignment.LEFT aligns the left-side of this element to the left side of the align element. * HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. * HorizontalAlignment.RIGHT aligns the right-side of this element to the right-side of the align element.

snapTo

public static void snapTo(UiElement element,
                          UiElement snapToElement)

Snaps the top-left of a UiElement to the top-left corner of another UiElement

Parameters:

element - The UiElement to perform alignment on

snapToElement - The UiElement to snap to. Note: This can also be the UiContainer

snapTo

public static void snapTo(UiElement element,
                          UiElement snapToElement,
                          HorizontalAlignment horizontalAlignment,
                          VerticalAlignment verticalAlignment)

Snaps the edge of a UiElement to the edge of another element.

Parameters:

element - The UiElement to perform alignment on

snapToElement - The UiElement to snap to. Note: This can also be the UiContainer

horizontalAlignment - The HorizontalAlignment of this element within the area of the align element

verticalAlignment - The VerticalAlignment of this element within the area of the align element

setWidthToWidth

public static void setWidthToWidth(UiElement element,
                                   UiElement matchElement)

Sets the width of one UiElement to match the width of another element

Parameters:

element - The UiElement to set the width on

matchElement - The UiElement to get the width of

setWidthToContentWidth

public static void setWidthToContentWidth(UiElement element,
                                          UiElement matchElement)

Sets the width of one UiElement to match the content width of another element. Note: content width = (width - margin - padding)

Parameters:

element - The UiElement to set the width on

matchElement - The UiElement to get the content width of

setHeightToHeight

public static void setHeightToHeight(UiElement element,
                                     UiElement matchElement)

Sets the height of one UiElement to match the height of another element

Parameters:

element - The UiElement to set the height on

matchElement - The UiElement to get the height of

setHeightToContentHeight

public static void setHeightToContentHeight(UiElement element,
                                            UiElement matchElement)

Sets the height of one UiElement to match the content height of another element. Note: content height = (height - margin - padding)

Parameters:

element - The UiElement to set the height on

matchElement - The UiElement to get the content height of

resizeScrollContentHeightToContents

public static void resizeScrollContentHeightToContents(ScrollBox scrollBox)