com.googlecode.lanterna.gui.layout

Interface LayoutManager

All Known Implementing Classes:

BorderLayout, HorisontalLayout, LinearLayout, VerticalLayout

public interface LayoutManager

Classes that implements this interface are for keeping and maintaining the component layout of a container. They will be responsible for, given a certain usable area of the terminal, position the components in a certain way depending on the implemention.

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LayoutManager.LaidOutComponent This interface represents a component that has been placed on an area.

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(Component component, LayoutParameter... parameters) Adds a component to the layout manager
TerminalSize	getPreferredSize() Calculates the optimal size of the container this layout manager is controlling by asking every component controlled by the manager how big they would like to be.
List<? extends LayoutManager.LaidOutComponent>	layout(TerminalSize layoutArea) Given a size, lay out all the components on this area
boolean	maximisesHorisontally()
boolean	maximisesVertically()
void	removeComponent(Component component) Removes a component from the layout

Method Detail

addComponent

void addComponent(Component component,
                LayoutParameter... parameters)

Adds a component to the layout manager

Parameters:

component - Component to add to the layout manager

parameters - Parameters to associate with the component on this layout

removeComponent

void removeComponent(Component component)

Removes a component from the layout

Parameters:

component - Component to remove

getPreferredSize

TerminalSize getPreferredSize()

Calculates the optimal size of the container this layout manager is controlling by asking every component controlled by the manager how big they would like to be. Depending on implementation, the layout manager may or may not add or remove space to the combined number.

Returns:

Size of the preferred area the layout would like

layout

List<? extends LayoutManager.LaidOutComponent> layout(TerminalSize layoutArea)

Given a size, lay out all the components on this area

Parameters:

layoutArea - Size that the layout is allowed to use

Returns:

List of all components, laid out on the allowed area

maximisesVertically

boolean maximisesVertically()

Returns:

True if there is a component within this layout that would like to use as much vertical space as is possible on the screen

maximisesHorisontally

boolean maximisesHorisontally()

Returns:

True if there is a component within this layout that would like to use as much horizontal space as is possible on the screen