com.googlecode.lanterna.gui.component

Class AbstractComponent

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractContainer, AbstractInteractableComponent, ActivityIndicator, EmptySpace, Label, ProgressBar, Separator, Table

public abstract class AbstractComponent
extends Object
implements Component

Author:

Martin

Nested Class Summary

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

Component.Alignment

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

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)
protected abstract TerminalSize	calculatePreferredSize()
Component.Alignment	getAlignment()
protected List<ComponentListener>	getComponentListeners()
protected GUIScreen	getGUIScreen()
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.
protected void	invalidate()
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	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.
protected void	setParent(Container parent)
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
protected TextGraphics	transformAccordingToAlignment(TextGraphics graphics, TerminalSize preferredSize) Will create a sub-graphic area according to the alignment, if the assigned size is larger than the preferred size.

Methods inherited from class java.lang.Object

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

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

repaint

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getParent

public Container getParent()

Specified by:

getParent in interface Component

Returns:

Container which currently owns this component

setParent

protected void setParent(Container parent)

addComponentListener

public void addComponentListener(ComponentListener cl)

Specified by:

addComponentListener in interface Component

removeComponentListener

public void removeComponentListener(ComponentListener cl)

Specified by:

removeComponentListener in interface Component

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Component

Returns:

true if the component is visible, false otherwise

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

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

Specified by:

setVisible in interface Component

Parameters:

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

isScrollable

public boolean isScrollable()

Description copied from interface: Component

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.

Specified by:

isScrollable in interface Component

Returns:

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

setPreferredSize

public void setPreferredSize(TerminalSize preferredSizeOverride)

Description copied from interface: Component

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.

Specified by:

setPreferredSize in interface Component

Parameters:

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

getPreferredSize

public TerminalSize getPreferredSize()

Description copied from interface: Component

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.

Specified by:

getPreferredSize in interface Component

Returns:

The preferred size of this component, given its current state

calculatePreferredSize

protected abstract TerminalSize calculatePreferredSize()

getMinimumSize

public TerminalSize getMinimumSize()

Description copied from interface: Component

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.

Specified by:

getMinimumSize in interface Component

Returns:

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

getAlignment

public Component.Alignment getAlignment()

Specified by:

getAlignment in interface Component

Returns:

Returns the alignment of this component

setAlignment

public void setAlignment(Component.Alignment alignment)

Description copied from interface: Component

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.

Specified by:

setAlignment in interface Component

Parameters:

alignment - Alignment of the component

invalidate

protected void invalidate()

getComponentListeners

protected List<ComponentListener> getComponentListeners()

getWindow

public Window getWindow()

Description copied from interface: Component

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.

Specified by:

getWindow in interface Component

Returns:

Window that contains this component or null

getGUIScreen

protected GUIScreen getGUIScreen()

addBorder

public Component addBorder(Border border,
                  String title)

Description copied from interface: Component

Surrounds this component with a specified border

Specified by:

addBorder in interface Component

Parameters:

border - Border to use

Returns:

New component which contains the original wrapped with the specified border

transformAccordingToAlignment

protected TextGraphics transformAccordingToAlignment(TextGraphics graphics,
                                         TerminalSize preferredSize)

Will create a sub-graphic area according to the alignment, if the assigned size is larger than the preferred size.