com.simsilica.lemur.core

Class ComponentStack

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<GuiComponent>

com.simsilica.lemur.core.ComponentStack

All Implemented Interfaces:

java.lang.Iterable<GuiComponent>, java.util.Collection<GuiComponent>, java.util.List<GuiComponent>

public class ComponentStack
extends java.util.AbstractList<GuiComponent>

A stack of components that comprise the layers of a GUI element.

Each component layer has an opportunity to grab some of the GUI element's space for itself before passing a smaller space down to its children.

When computing preferred size, the order is reversed (top down) gathering up the preferred size of each layer based on how it wants to wrap the layer above it. In this way, each layer kind of acts like a decorator for the layer above it.

Preferred size calculation and reshaping are all done in 3D and each layer can choose to reposition or reshape the next layer in any of these dimensions.

[a picture would be worth a thousand words]

It is often desirable to be able to insert specific types of components into specific layers in the stack. For example, "insets" on the bottom. Thus the component stack keeps a list of layer names that enforce this default ordering of named layers. Layers don't have to be named, but when they are they are kept in the order defined in this layer ordering list.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ComponentStack(java.lang.String... layerOrder) Creates a component stack with the specified layer ordering.

Method Summary

Modifier and Type	Method and Description
<T extends GuiComponent> T	addComponent(T c) Adds a new component to the top of the stack.
void	attach(GuiControl parent)
void	detach(GuiControl parent)
GuiComponent	get(int index)
protected GuiComponent[]	getArray()
<T extends GuiComponent> T	getComponent(java.lang.String layer) Returns the component that was previously associated with the specified layer.
java.lang.String[]	getLayerOrder() Returns the current layer order.
boolean	hasLayer(java.lang.String layerName) Returns true if the specified layer name exists in the layer order list.
protected void	rebuildStack() Completely rebuilds the component stack from the index, layer ordering, and top list.
boolean	removeComponent(GuiComponent c) Removes the specified component from the stack.
<T extends GuiComponent> T	removeComponent(java.lang.String layer) Removes the component that was previously associated with the specified layer.
<T extends GuiComponent> T	setComponent(java.lang.String layer, T c) Sets the specified component to the specified layer and returns the specified component.
void	setLayerOrder(java.lang.String... layerOrder) Sets a new layer ordering.
int	size()
java.lang.String	toString()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ComponentStack

public ComponentStack(java.lang.String... layerOrder)

Creates a component stack with the specified layer ordering.

Method Detail

getArray

protected GuiComponent[] getArray()

get

public GuiComponent get(int index)

Specified by:

get in interface java.util.List<GuiComponent>

Specified by:

get in class java.util.AbstractList<GuiComponent>

size

public int size()

Specified by:

size in interface java.util.Collection<GuiComponent>

Specified by:

size in interface java.util.List<GuiComponent>

Specified by:

size in class java.util.AbstractCollection<GuiComponent>

setLayerOrder

public void setLayerOrder(java.lang.String... layerOrder)

Sets a new layer ordering. This will invalidate and rebuild the component stack.

hasLayer

public boolean hasLayer(java.lang.String layerName)

Returns true if the specified layer name exists in the layer order list.

getLayerOrder

public java.lang.String[] getLayerOrder()

Returns the current layer order.

attach

public void attach(GuiControl parent)

detach

public void detach(GuiControl parent)

rebuildStack

protected void rebuildStack()

Completely rebuilds the component stack from the index, layer ordering, and top list. This should be called whenever changes are made to these data structures that cannot be reconciled with surgical changes to the components list.

addComponent

public <T extends GuiComponent> T addComponent(T c)

Adds a new component to the top of the stack.

setComponent

public <T extends GuiComponent> T setComponent(java.lang.String layer,
                                               T c)

Sets the specified component to the specified layer and returns the specified component. Note: this is different than java.util.List.set() behavior where it would return the previous value.

getComponent

public <T extends GuiComponent> T getComponent(java.lang.String layer)

Returns the component that was previously associated with the specified layer.

removeComponent

public <T extends GuiComponent> T removeComponent(java.lang.String layer)

Removes the component that was previously associated with the specified layer.

removeComponent

public boolean removeComponent(GuiComponent c)

Removes the specified component from the stack.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<GuiComponent>