com.googlecode.lanterna.gui

Interface Component

All Known Subinterfaces:

Container, InteractableComponent

All Known Implementing Classes:

AbstractComponent, AbstractContainer, AbstractInteractableComponent, AbstractListBox, ActionListBox, ActivityIndicator, Button, CheckBox, CheckBoxList, CommonCheckBox, EditArea, EmptySpace, Label, Panel, PasswordBox, ProgressBar, RadioCheckBoxList, Separator, SpinningActivityIndicator, Table, TextArea, TextBox

public interface Component

The base component interface, which all components must implement.

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Component.Alignment

Method Summary

Methods

Modifier and Type	Method and Description
Component	addBorder(Border border, String title) Surrounds this component with a specified border
void	addComponentListener(ComponentListener cl)
Component.Alignment	getAlignment()
TerminalSize	getMinimumSize() This method is called by the layout system to figure out what the absolute minimum size is for this component.
Container	getParent()
TerminalSize	getPreferredSize() This method is called by the layout system to figure out how much space each component will be assigned.
Window	getWindow() Returns the window which is directly or indirectly containing this component.
boolean	isScrollable() This method is used by the layout system when it needs to shrink components because the available space is too small.
boolean	isVisible()
void	removeComponentListener(ComponentListener cl)
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	setAlignment(Component.Alignment alignment) Sets the alignment property on the Component which will serve as a hint to the rendering code as to how to draw the component if it is assigned more space that it asked for.
void	setPreferredSize(TerminalSize preferredSizeOverride) If called with a non-null parameter, it will override the component's own preferred size calculation and instead getPreferredSize() will return the value passed in.
void	setVisible(boolean visible) If false, the GUI system will ignore this component in the layout and drawing stage

Method Detail

getParent

Container getParent()

Returns:

Container which currently owns this component

getWindow

Window getWindow()

Returns the window which is directly or indirectly containing this component. If the component has not been placed on any window yet, it will return null.

Returns:

Window that contains this component or null

addComponentListener

void addComponentListener(ComponentListener cl)

removeComponentListener

void removeComponentListener(ComponentListener cl)

repaint

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. 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

setVisible

void setVisible(boolean visible)

If false, the GUI system will ignore this component in the layout and drawing stage

Parameters:

visible - true if you want the component to be visible, false to make it hidden

isVisible

boolean isVisible()

Returns:

true if the component is visible, false otherwise

isScrollable

boolean isScrollable()

This method is used by the layout system when it needs to shrink components because the available space is too small. Scrollable components will be shrunk first.

Returns:

True if this component has a scrollable area and can contain more text than fits on the screen

getPreferredSize

TerminalSize getPreferredSize()

This method is called by the layout system to figure out how much space each component will be assigned. Return the size you would like your component to use, for best presentation. There is no guarante that the component will actually be assigned this space, you could get both smaller and larger space assigned.

Returns:

The preferred size of this component, given its current state

getMinimumSize

TerminalSize getMinimumSize()

This method is called by the layout system to figure out what the absolute minimum size is for this component. If the component cannot be assigned this space, it will be inactivated and not rendered.

Returns:

The absolutely minimum space that needs to be available for this component

setPreferredSize

void setPreferredSize(TerminalSize preferredSizeOverride)

If called with a non-null parameter, it will override the component's own preferred size calculation and instead getPreferredSize() will return the value passed in. If called with null, the calculation will be used again.

Parameters:

preferredSizeOverride - Value getPreferredSize() should return instead of calculating it

setAlignment

void setAlignment(Component.Alignment alignment)

Sets the alignment property on the Component which will serve as a hint to the rendering code as to how to draw the component if it is assigned more space that it asked for. The behavior of this property is different between components, some may use it and some may not.

The default alignment is also up to each component to decide, see the documentation for the individual component you are using.

Parameters:

alignment - Alignment of the component

getAlignment

Component.Alignment getAlignment()

Returns:

Returns the alignment of this component

addBorder

Component addBorder(Border border,
                  String title)

Surrounds this component with a specified border

Parameters:

border - Border to use

Returns:

New component which contains the original wrapped with the specified border