com.googlecode.lanterna.gui.layout

Class LinearLayout

java.lang.Object

com.googlecode.lanterna.gui.layout.LinearLayout

All Implemented Interfaces:

LayoutManager

Direct Known Subclasses:

HorisontalLayout, VerticalLayout

public abstract class LinearLayout
extends Object
implements LayoutManager

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LinearLayout.LinearLayoutComponent

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui.layout.LayoutManager

LayoutManager.LaidOutComponent

Field Summary

Fields

Modifier and Type	Field and Description
static LayoutParameter	GROWS_HORIZONTALLY
static LayoutParameter	GROWS_VERTICALLY
static LayoutParameter	MAXIMIZES_HORIZONTALLY
static LayoutParameter	MAXIMIZES_VERTICALLY

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(Component component, LayoutParameter... layoutParameters) Adds a component to the layout manager
protected abstract int	getMajorAxis(TerminalSize terminalSize)
protected abstract LayoutParameter	getMajorGrowingParameter()
protected abstract LayoutParameter	getMajorMaximizesParameter()
protected abstract int	getMinorAxis(TerminalSize terminalSize)
protected abstract LayoutParameter	getMinorGrowingParameter()
protected abstract LayoutParameter	getMinorMaximizesParameter()
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.
protected List<Panel>	getSubPanels()
List<? extends LayoutManager.LaidOutComponent>	layout(TerminalSize layoutArea) Given a size, lay out all the components on this area
boolean	maximisesHorisontally()
protected abstract boolean	maximisesOnMajorAxis(Panel panel)
protected abstract boolean	maximisesOnMinorAxis(Panel panel)
boolean	maximisesVertically()
void	removeComponent(Component component) Removes a component from the layout
protected abstract void	setMajorAxis(TerminalPosition terminalPosition, int majorAxisValue)
protected abstract void	setMajorAxis(TerminalSize terminalSize, int majorAxisValue)
protected abstract void	setMinorAxis(TerminalSize terminalSize, int minorAxisValue)
void	setPadding(int padding)

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMIZES_HORIZONTALLY

public static final LayoutParameter MAXIMIZES_HORIZONTALLY

MAXIMIZES_VERTICALLY

public static final LayoutParameter MAXIMIZES_VERTICALLY

GROWS_HORIZONTALLY

public static final LayoutParameter GROWS_HORIZONTALLY

GROWS_VERTICALLY

public static final LayoutParameter GROWS_VERTICALLY

Method Detail

addComponent

public void addComponent(Component component,
                LayoutParameter... layoutParameters)

Description copied from interface: LayoutManager

Adds a component to the layout manager

Specified by:

addComponent in interface LayoutManager

Parameters:

component - Component to add to the layout manager

layoutParameters - Parameters to associate with the component on this layout

removeComponent

public void removeComponent(Component component)

Description copied from interface: LayoutManager

Removes a component from the layout

Specified by:

removeComponent in interface LayoutManager

Parameters:

component - Component to remove

setPadding

public void setPadding(int padding)

getPreferredSize

public TerminalSize getPreferredSize()

Description copied from interface: LayoutManager

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.

Specified by:

getPreferredSize in interface LayoutManager

Returns:

Size of the preferred area the layout would like

layout

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

Description copied from interface: LayoutManager

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

Specified by:

layout in interface LayoutManager

Parameters:

layoutArea - Size that the layout is allowed to use

Returns:

List of all components, laid out on the allowed area

maximisesHorisontally

public boolean maximisesHorisontally()

Specified by:

maximisesHorisontally in interface LayoutManager

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

maximisesVertically

public boolean maximisesVertically()

Specified by:

maximisesVertically in interface LayoutManager

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

maximisesOnMajorAxis

protected abstract boolean maximisesOnMajorAxis(Panel panel)

maximisesOnMinorAxis

protected abstract boolean maximisesOnMinorAxis(Panel panel)

setMajorAxis

protected abstract void setMajorAxis(TerminalSize terminalSize,
                int majorAxisValue)

setMinorAxis

protected abstract void setMinorAxis(TerminalSize terminalSize,
                int minorAxisValue)

setMajorAxis

protected abstract void setMajorAxis(TerminalPosition terminalPosition,
                int majorAxisValue)

getMajorAxis

protected abstract int getMajorAxis(TerminalSize terminalSize)

getMinorAxis

protected abstract int getMinorAxis(TerminalSize terminalSize)

getMajorMaximizesParameter

protected abstract LayoutParameter getMajorMaximizesParameter()

getMinorMaximizesParameter

protected abstract LayoutParameter getMinorMaximizesParameter()

getMajorGrowingParameter

protected abstract LayoutParameter getMajorGrowingParameter()

getMinorGrowingParameter

protected abstract LayoutParameter getMinorGrowingParameter()

getSubPanels

protected List<Panel> getSubPanels()