Class FlowLayout

java.lang.Object

com.blackrook.gui.layout.FlowLayout

All Implemented Interfaces:

GUILayout

public class FlowLayout
extends Object
implements GUILayout

A layout for GUIObjects that sets the position of its components inside the parent. This does not resize components.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FlowLayout.HAlignment	Horizontal alignment types.
protected static class	FlowLayout.NewLinePanel	Special panel that acts as a "new line" in a flow.
static enum	FlowLayout.VAlignment	Vertical alignment types.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<com.blackrook.gui.layout.FlowLayout.Flow>	currentLineup	Vector of objects.
static final float	DEFAULT_GAP	Default gap size.
protected FlowLayout.HAlignment	hAlignment	Horizontal alignment type.
protected float	horizontalGap	Horizontal gap between objects.
protected float	sizeX	Current X space.
protected float	sizeY	Current Y space.
protected FlowLayout.VAlignment	vAlignment	Vertical alignment type.
protected float	verticalGap	Vertical gap between objects.

Constructor Summary

Constructors

Constructor	Description
FlowLayout()	Creates a new FlowLayout with a LEFT horizontal alignment, TOP vertical alignment, and default gaps.
FlowLayout(FlowLayout.HAlignment h)	Creates a new FlowLayout with a specific horizontal alignment, TOP vertical alignment, and default gaps.
FlowLayout(FlowLayout.HAlignment h, FlowLayout.VAlignment v)	Creates a new FlowLayout with specific alignments and default gaps.
FlowLayout(FlowLayout.HAlignment h, FlowLayout.VAlignment v, float hGap)	Creates a new FlowLayout with specific alignments and horizontal gap.
FlowLayout(FlowLayout.HAlignment h, FlowLayout.VAlignment v, float hGap, float vGap)	Creates a new FlowLayout with specific alignments and gaps.

Method Summary

Modifier and Type	Method	Description
static GUIObject	createNewLinePanel()	Creates a special panel that is used for deciding to create a new line in the flow layout.
protected void	orientChildren(GUIObject parent)
protected void	prepareLayout(GUIObject parent)
void	resizeChild(GUIObject object, int index, int childTotal)	Called when a child object needs resizing.

Methods inherited from class Object

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

Field Details

DEFAULT_GAP

public static final float DEFAULT_GAP

Default gap size.

See Also:

• Constant Field Values

hAlignment

protected FlowLayout.HAlignment hAlignment

Horizontal alignment type.

vAlignment

protected FlowLayout.VAlignment vAlignment

Vertical alignment type.

horizontalGap

protected float horizontalGap

Horizontal gap between objects.

verticalGap

protected float verticalGap

Vertical gap between objects.

sizeX

protected float sizeX

Current X space.

sizeY

protected float sizeY

Current Y space.

currentLineup

protected List<com.blackrook.gui.layout.FlowLayout.Flow> currentLineup

Vector of objects.

Constructor Details

FlowLayout

public FlowLayout()

Creates a new FlowLayout with a LEFT horizontal alignment, TOP vertical alignment, and default gaps.

FlowLayout

public FlowLayout(FlowLayout.HAlignment h)

Creates a new FlowLayout with a specific horizontal alignment, TOP vertical alignment, and default gaps.

Parameters:

h - the horizontal alignment of this layout.

FlowLayout

public FlowLayout(FlowLayout.HAlignment h,
 FlowLayout.VAlignment v)

Creates a new FlowLayout with specific alignments and default gaps.

Parameters:

h - the horizontal alignment of this layout.

v - the vertical alignment of this layout.

FlowLayout

public FlowLayout(FlowLayout.HAlignment h,
 FlowLayout.VAlignment v,
 float hGap)

Creates a new FlowLayout with specific alignments and horizontal gap.

Parameters:

h - the horizontal alignment of this layout.

v - the vertical alignment of this layout.

hGap - the gap between horizontal elements.

FlowLayout

public FlowLayout(FlowLayout.HAlignment h,
 FlowLayout.VAlignment v,
 float hGap,
 float vGap)

Creates a new FlowLayout with specific alignments and gaps.

Parameters:

h - the horizontal alignment of this layout.

v - the vertical alignment of this layout.

hGap - the gap between horizontal elements.

vGap - the gap between vertical elements.

Method Details

createNewLinePanel

public static GUIObject createNewLinePanel()

Creates a special panel that is used for deciding to create a new line in the flow layout.

Returns:

a new panel.

resizeChild

public void resizeChild(GUIObject object,
 int index,
 int childTotal)

Description copied from interface: GUILayout

Called when a child object needs resizing. DO NOT RESIZE THE PARENT OBJECT IN THIS METHOD, AS IT MAY CAUSE AN INFINITE LOOP TO OCCUR.

Specified by:

resizeChild in interface GUILayout

Parameters:

object - the object to resize.

index - the child index while traversing through the list of children.

childTotal - the total number of children.

prepareLayout

protected void prepareLayout(GUIObject parent)

orientChildren

protected void orientChildren(GUIObject parent)