Package com.googlecode.lanterna.gui2.table

Class DefaultTableRenderer<V>

java.lang.Object

com.googlecode.lanterna.gui2.table.DefaultTableRenderer<V>

Type Parameters:

V - Type of data stored in each table cell

All Implemented Interfaces:

ComponentRenderer<V>, InteractableRenderer<V>, TableRenderer<V>

public class DefaultTableRenderer<V>
extends Object
implements TableRenderer<V>

Default implementation of TableRenderer

Author:

Martin

Constructor Summary

Constructors

Constructor	Description
DefaultTableRenderer()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	drawComponent(TextGUIGraphics graphics, Table<V> table)	Using the supplied graphics object, draws the component passed in.
TerminalPosition	getCursorLocation(Table<V> component)
TerminalSize	getPreferredSize(Table<V> table)	Given the supplied component, how large does this renderer want the component to be?
void	setCellHorizontalBorderStyle(TableCellBorderStyle cellHorizontalBorderStyle)	Sets the style to be used when horizontally separating table cells from each other.
void	setCellVerticalBorderStyle(TableCellBorderStyle cellVerticalBorderStyle)	Sets the style to be used when vertically separating table cells from each other.
void	setExpandableColumns(Collection<Integer> expandableColumns)	Sets the list of columns (by index, where 0 is the first column) that can be expanded, should the drawable area be larger than the table is requesting.
void	setHeaderHorizontalBorderStyle(TableCellBorderStyle headerHorizontalBorderStyle)	Sets the style to be used when separating the table header labels from each other.
void	setHeaderVerticalBorderStyle(TableCellBorderStyle headerVerticalBorderStyle)	Sets the style to be used when separating the table header row from the actual "data" cells below.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTableRenderer

public DefaultTableRenderer()

Default constructor

Method Detail

setHeaderVerticalBorderStyle

public void setHeaderVerticalBorderStyle(TableCellBorderStyle headerVerticalBorderStyle)

Sets the style to be used when separating the table header row from the actual "data" cells below. This will cause a new line to be added under the header labels, unless set to TableCellBorderStyle.None.

Parameters:

headerVerticalBorderStyle - Style to use to separate Table header from body

setHeaderHorizontalBorderStyle

public void setHeaderHorizontalBorderStyle(TableCellBorderStyle headerHorizontalBorderStyle)

Sets the style to be used when separating the table header labels from each other. This will cause a new column to be added in between each label, unless set to TableCellBorderStyle.None.

Parameters:

headerHorizontalBorderStyle - Style to use when separating header columns horizontally

setCellVerticalBorderStyle

public void setCellVerticalBorderStyle(TableCellBorderStyle cellVerticalBorderStyle)

Sets the style to be used when vertically separating table cells from each other. This will cause a new line to be added between every row, unless set to TableCellBorderStyle.None.

Parameters:

cellVerticalBorderStyle - Style to use to separate table cells vertically

setCellHorizontalBorderStyle

public void setCellHorizontalBorderStyle(TableCellBorderStyle cellHorizontalBorderStyle)

Sets the style to be used when horizontally separating table cells from each other. This will cause a new column to be added between every row, unless set to TableCellBorderStyle.None.

Parameters:

cellHorizontalBorderStyle - Style to use to separate table cells horizontally

setExpandableColumns

public void setExpandableColumns(Collection<Integer> expandableColumns)

Sets the list of columns (by index, where 0 is the first column) that can be expanded, should the drawable area be larger than the table is requesting.

Parameters:

expandableColumns - Collection of indexes for expandable columns

getPreferredSize

public TerminalSize getPreferredSize(Table<V> table)

Description copied from interface: ComponentRenderer

Given the supplied component, how large does this renderer want the component to be? Notice that this is the responsibility of the renderer and not the component itself, since the component has no idea what its visual representation looks like.

Specified by:

getPreferredSize in interface ComponentRenderer<V>

Specified by:

getPreferredSize in interface TableRenderer<V>

Parameters:

table - Component to calculate the preferred size of

Returns:

The size this renderer would like the component to take up

getCursorLocation

public TerminalPosition getCursorLocation(Table<V> component)

Specified by:

getCursorLocation in interface InteractableRenderer<V>

drawComponent

public void drawComponent(TextGUIGraphics graphics,
                          Table<V> table)

Description copied from interface: ComponentRenderer

Using the supplied graphics object, draws the component passed in.

Specified by:

drawComponent in interface ComponentRenderer<V>

Specified by:

drawComponent in interface TableRenderer<V>

Parameters:

graphics - Graphics object to use for drawing

table - Component to draw