APIdia Launch Partner
Top Description Methods
com.badlogic.gdx.scenes.scene2d.utils

public Interface Layout

Known Direct Implementers
com.badlogic.gdx.scenes.scene2d.ui.Widget, com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup
Imports
com.badlogic.gdx.graphics.g2d.Batch, com.badlogic.gdx.scenes.scene2d.Actor

Provides methods for an actor to participate in layout and to provide a minimum, preferred, and maximum size.
Author
Nathan Sweet

Method Summary

Modifier and TypeMethod and Description
public float
getMaxHeight()

Zero indicates no max height.

public float
getMaxWidth()

Zero indicates no max width.

public float
public float
public float
public float
public void
invalidate()

Invalidates this actor's layout, causing layout() to happen the next time validate() is called.

public void
invalidateHierarchy()

Invalidates this actor and its ascendants, calling invalidate() on each.

public void
layout()

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls invalidate() on any each child whose width or height has changed, and calls validate() on each child.

public void
pack()

Sizes this actor to its preferred width and height, then calls validate().

public void
setFillParent(boolean fillParent)

If true, this actor will be sized to the parent in validate().

public void
setLayoutEnabled(boolean enabled)

Enables or disables the layout for this actor and all child actors, recursively.

public void
validate()

Ensures the actor has been laid out.

Method Detail

getMaxHeightback to summary
public float getMaxHeight()

Zero indicates no max height.

getMaxWidthback to summary
public float getMaxWidth()

Zero indicates no max width.

getMinHeightback to summary
public float getMinHeight()
getMinWidthback to summary
public float getMinWidth()
getPrefHeightback to summary
public float getPrefHeight()
getPrefWidthback to summary
public float getPrefWidth()
invalidateback to summary
public void invalidate()

Invalidates this actor's layout, causing layout() to happen the next time validate() is called. This method should be called when state changes in the actor that requires a layout but does not change the minimum, preferred, maximum, or actual size of the actor (meaning it does not affect the parent actor's layout).

invalidateHierarchyback to summary
public void invalidateHierarchy()

Invalidates this actor and its ascendants, calling invalidate() on each. This method should be called when state changes in the actor that affects the minimum, preferred, maximum, or actual size of the actor (meaning it potentially affects the parent actor's layout).

layoutback to summary
public void layout()

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls invalidate() on any each child whose width or height has changed, and calls validate() on each child. This method should almost never be called directly, instead validate() should be used.

packback to summary
public void pack()

Sizes this actor to its preferred width and height, then calls validate().

Generally this method should not be called in an actor's constructor because it calls layout(), which means a subclass would have layout() called before the subclass' constructor. Instead, in constructors simply set the actor's size to getPrefWidth() and getPrefHeight(). This allows the actor to have a size at construction time for more convenient use with groups that do not layout their children.

setFillParentback to summary
public void setFillParent(boolean fillParent)

If true, this actor will be sized to the parent in validate(). If the parent is the stage, the actor will be sized to the stage. This method is for convenience only when the widget's parent does not set the size of its children (such as the stage).

setLayoutEnabledback to summary
public void setLayoutEnabled(boolean enabled)

Enables or disables the layout for this actor and all child actors, recursively. When false, validate() will not cause a layout to occur. This can be useful when an actor will be manipulated externally, such as with actions. Default is true.

validateback to summary
public void validate()

Ensures the actor has been laid out. Calls layout() if invalidate() has been called since the last time validate() was called, or if the actor otherwise needs to be laid out. This method is usually called in Actor#draw(Batch, float) by the actor itself before drawing is performed.