Class FocusOrderGroup

java.lang.Object

com.blackrook.gui.group.FocusOrderGroup

public class FocusOrderGroup
extends Object

A group that binds a series of actions to a set of focusable objects, in such that if one presses certain buttons or keys, they will go forward or back in focus.

If the object receives a GUIInputConstants.KEY_LEFT or GUIInputConstants.KEY_DOWN key or a positive GAMEPAD_TAP AXIS_POV.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FocusOrderGroup.Direction
protected class	FocusOrderGroup.GroupAction	Action added to objects for advancing focus.

Field Summary

Fields

Modifier and Type	Field	Description
protected FocusOrderGroup.Direction	direction	Directionality.
protected GUIObject[]	order	Object order list.

Constructor Summary

Constructors

Constructor	Description
FocusOrderGroup(FocusOrderGroup.Direction direction, boolean loopOrder, GUIObject... objects)	Creates a new FocusOrderGroup and binds the required actions to the objects provided.
FocusOrderGroup(FocusOrderGroup.Direction direction, boolean loopOrder, Iterable<GUIObject> objects)	Creates a new FocusOrderGroup and binds the required actions to the objects provided.
FocusOrderGroup(FocusOrderGroup.Direction direction, GUIObject... objects)	Creates a new FocusOrderGroup and binds the required actions to the objects provided.
FocusOrderGroup(FocusOrderGroup.Direction direction, Iterable<GUIObject> objects)	Creates a new FocusOrderGroup and binds the required actions to the objects provided.

Method Summary

Modifier and Type	Method	Description
protected void	bind(boolean loopOrder, GUIObject[] objects)	Binds the actions in this group to the objects in the group.

Methods inherited from class Object

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

Field Details

direction

protected FocusOrderGroup.Direction direction

Directionality.

order

protected GUIObject[] order

Object order list.

Constructor Details

FocusOrderGroup

public FocusOrderGroup(FocusOrderGroup.Direction direction,
 GUIObject... objects)

Creates a new FocusOrderGroup and binds the required actions to the objects provided.

Parameters:

direction - the directionality of the focus keys.

objects - the objects to include in the group.

FocusOrderGroup

public FocusOrderGroup(FocusOrderGroup.Direction direction,
 boolean loopOrder,
 GUIObject... objects)

Creates a new FocusOrderGroup and binds the required actions to the objects provided.

Parameters:

direction - the directionality of the focus keys.

loopOrder - if true, the order loops back to the beginning, and not if false.

objects - the objects to include in the group.

FocusOrderGroup

public FocusOrderGroup(FocusOrderGroup.Direction direction,
 Iterable<GUIObject> objects)

Creates a new FocusOrderGroup and binds the required actions to the objects provided.

Parameters:

direction - the directionality of the focus keys.

objects - the objects to include in the group.

FocusOrderGroup

public FocusOrderGroup(FocusOrderGroup.Direction direction,
 boolean loopOrder,
 Iterable<GUIObject> objects)

Creates a new FocusOrderGroup and binds the required actions to the objects provided.

Parameters:

direction - the directionality of the focus keys.

loopOrder - if true, the order loops back to the beginning, and not if false.

objects - the objects to include in the group.

Method Details

bind

protected void bind(boolean loopOrder,
 GUIObject[] objects)

Binds the actions in this group to the objects in the group.

Parameters:

loopOrder - if true, the end loops back to the beginning.

objects - the objects in the group.