com.googlecode.lanterna.gui.component

Class Panel

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractContainer

com.googlecode.lanterna.gui.component.Panel

All Implemented Interfaces:

Component, Container, InteractableContainer

public class Panel
extends AbstractContainer

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Panel.Orientation

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

Component.Alignment

Constructor Summary

Constructors

Constructor and Description
Panel()
Panel(Border border, Panel.Orientation panelOrientation)
Panel(Panel.Orientation panelOrientation)
Panel(String title)
Panel(String title, Border border, Panel.Orientation panelOrientation)
Panel(String title, Panel.Orientation panelOrientation)

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(Component component, LayoutParameter... layoutParameters) Adds a new subcomponent to this container.
protected TerminalSize	calculatePreferredSize()
Border	getBorder()
LayoutManager	getLayoutManager()
String	getTitle()
boolean	maximisesHorisontally()
boolean	maximisesVertically()
boolean	removeComponent(Component component) Removes a component from this container.
void	repaint(TextGraphics graphics) This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself.
void	setBetweenComponentsPadding(int paddingSize) Deprecated. Use the layout manager to set the padding between components
void	setBorder(Border border)
void	setLayoutManager(LayoutManager layoutManager)
void	setTitle(String title)
String	toString()

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractContainer

addContainerListener, addShortcut, addShortcut, components, containsComponent, getComponentAt, getComponentCount, hasInteractable, isScrollable, nextFocus, previousFocus, removeAllComponents, removeContainerListener, triggerShortcut

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractComponent

addBorder, addComponentListener, getAlignment, getComponentListeners, getGUIScreen, getMinimumSize, getParent, getPreferredSize, getWindow, invalidate, isVisible, removeComponentListener, setAlignment, setParent, setPreferredSize, setVisible, transformAccordingToAlignment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.googlecode.lanterna.gui.Component

addBorder, addComponentListener, getAlignment, getMinimumSize, getParent, getPreferredSize, getWindow, isVisible, removeComponentListener, setAlignment, setPreferredSize, setVisible

Constructor Detail

Panel

public Panel()

Panel

public Panel(String title)

Panel

public Panel(Panel.Orientation panelOrientation)

Panel

public Panel(String title,
     Panel.Orientation panelOrientation)

Panel

public Panel(Border border,
     Panel.Orientation panelOrientation)

Panel

public Panel(String title,
     Border border,
     Panel.Orientation panelOrientation)

Method Detail

getBorder

public Border getBorder()

setBorder

public void setBorder(Border border)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

setLayoutManager

public void setLayoutManager(LayoutManager layoutManager)

getLayoutManager

public LayoutManager getLayoutManager()

maximisesVertically

public boolean maximisesVertically()

maximisesHorisontally

public boolean maximisesHorisontally()

setBetweenComponentsPadding

@Deprecated
public void setBetweenComponentsPadding(int paddingSize)

Deprecated. Use the layout manager to set the padding between components

repaint

public void repaint(TextGraphics graphics)

Description copied from interface: Component

This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself. Use the supplied TextGraphics object to draw the component. In order to find out how the size of your compnent (as decided by the layout), use the graphics objects and query for its size.

Parameters:

graphics - TextGraphics object to use for drawing the component and getting information about the drawing context

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

addComponent

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

Description copied from interface: Container

Adds a new subcomponent to this container.

Specified by:

addComponent in interface Container

Overrides:

addComponent in class AbstractContainer

Parameters:

component - Component to add to this container

layoutParameters - Optional parameters to give hits to the layout manager

removeComponent

public boolean removeComponent(Component component)

Description copied from interface: Container

Removes a component from this container.

Specified by:

removeComponent in interface Container

Overrides:

removeComponent in class AbstractContainer

Parameters:

component - Component to remove from this container

Returns:

true if a component was found and removed, false otherwise

toString

public String toString()

Overrides:

toString in class Object