de.vandermeer.asciitable

Class AT_Context

Object

AT_Context

All Implemented Interfaces:

CategoryIs, IsTableContext, IsObjectContext

public class AT_Context
extends Object
implements IsTableContext

Context for an AsciiTable.

Since:

v0.3.0

Version:

v0.3.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	frameBottomMargin Margin outside bottom frame.
protected Character	frameBottomMarginChar The character outside bottom frame.
protected Character	frameLeftChar The character for left frame margin.
protected int	frameLeftMargin Margin outside the left frame border.
protected Character	frameRightChar The character for right frame margin.
protected int	frameRightMargin Margin outside the right frame border.
protected int	frameTopMargin Margin outside top frame.
protected Character	frameTopMarginChar The character outside top frame.
protected TA_Grid	grid The grid (actual frame) for the table.
protected int	gridTheme The theme for the grid (which parts to use for drawing a frame).
protected int	gridThemeOptions Options for the grid, for instance show empty lines.
protected String	lineSeparator A line separator for generating text output.
protected int	width The width of the table, actual width depends on padding settings, default is 80.

Constructor Summary

Constructors

Constructor and Description
AT_Context()

Method Summary

Modifier and Type	Method and Description
Character	getFrameBottomChar() Returns the bottom frame margin character.
int	getFrameBottomMargin() Returns the bottom frame margin.
Character	getFrameLeftChar() Returns the left frame margin character.
int	getFrameLeftMargin() Returns the left frame margin.
Character	getFrameRightChar() Returns the right frame margin character.
int	getFrameRightMargin() Returns the right frame margin.
Character	getFrameTopChar() Returns the top frame margin character.
int	getFrameTopMargin() Returns the top frame margin.
TA_Grid	getGrid() Returns the grid.
int	getGridTheme() Returns the grid theme.
int	getGridThemeOptions() Returns the grid theme options.
String	getLineSeparator() Returns the current set line separator.
int	getTextWidth(int width)
int	getWidth()
AT_Context	setFrameBottomChar(Character frameBottom) Sets the bottom frame margin character.
AT_Context	setFrameBottomMargin(int frameBottom) Sets the bottom frame margin
AT_Context	setFrameLeftChar(Character frameLeft) Sets the left frame margin character.
AT_Context	setFrameLeftMargin(int frameLeft) Sets the left frame margin
AT_Context	setFrameLeftRightChar(Character frameChar) Sets the left and right frame margin character.
AT_Context	setFrameLeftRightChar(Character frameLeft, Character frameRight) Sets the left and right frame margin character.
AT_Context	setFrameLeftRightMargin(int frameMargin) Sets the left and right frame margin.
AT_Context	setFrameLeftRightMargin(int frameLeft, int frameRight) Sets the left and right frame margin.
AT_Context	setFrameRightChar(Character frameRight) Sets the right frame margin character.
AT_Context	setFrameRightMargin(int frameRight) Sets the right frame margin
AT_Context	setFrameTopBottomMargin(int frameMargin) Sets the top and bottom frame margin.
AT_Context	setFrameTopBottomMargin(int frameTop, int frameBottom) Sets the top and bottom frame margin.
AT_Context	setFrameTopChar(Character frameTop) Sets the top frame margin character.
AT_Context	setFrameTopMargin(int frameTop) Sets the top frame margin
AT_Context	setGrid(TA_Grid grid) Sets the grid used to render the table.
AT_Context	setGridTheme(int theme) Sets the grid theme.
AT_Context	setGridTheme(TA_GridThemes theme) Sets the grid theme.
AT_Context	setGridThemeOptions(int options) Sets options for the grid theme.
AT_Context	setGridThemeOptions(TA_GridThemeOptions options) Sets options for the grid theme.
AT_Context	setLineSeparator(String separator) Sets a new line separator for the renderer.
AT_Context	setWidth(int width) Sets the table width.

Methods inherited from class Object

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

Methods inherited from interface IsTableContext

checkWidth, getTextWidth

Field Detail

lineSeparator

protected String lineSeparator

A line separator for generating text output.

frameBottomMarginChar

protected Character frameBottomMarginChar

The character outside bottom frame.

frameBottomMargin

protected int frameBottomMargin

Margin outside bottom frame.

frameLeftChar

protected Character frameLeftChar

The character for left frame margin.

frameLeftMargin

protected int frameLeftMargin

Margin outside the left frame border.

frameRightChar

protected Character frameRightChar

The character for right frame margin.

frameRightMargin

protected int frameRightMargin

Margin outside the right frame border.

frameTopMarginChar

protected Character frameTopMarginChar

The character outside top frame.

frameTopMargin

protected int frameTopMargin

Margin outside top frame.

width

protected int width

The width of the table, actual width depends on padding settings, default is 80.

grid

protected TA_Grid grid

The grid (actual frame) for the table.

gridTheme

protected int gridTheme

The theme for the grid (which parts to use for drawing a frame).

gridThemeOptions

protected int gridThemeOptions

Options for the grid, for instance show empty lines.

Constructor Detail

AT_Context

public AT_Context()

Method Detail

getFrameBottomChar

public Character getFrameBottomChar()

Returns the bottom frame margin character.

Returns:

bottom frame margin character

getFrameBottomMargin

public int getFrameBottomMargin()

Returns the bottom frame margin.

Returns:

bottom frame margin

getFrameLeftChar

public Character getFrameLeftChar()

Returns the left frame margin character.

Returns:

left frame margin character

getFrameLeftMargin

public int getFrameLeftMargin()

Returns the left frame margin.

Returns:

left frame margin

getFrameRightChar

public Character getFrameRightChar()

Returns the right frame margin character.

Returns:

right frame margin character

getFrameRightMargin

public int getFrameRightMargin()

Returns the right frame margin.

Returns:

right frame margin

getFrameTopChar

public Character getFrameTopChar()

Returns the top frame margin character.

Returns:

top frame margin character

getFrameTopMargin

public int getFrameTopMargin()

Returns the top frame margin.

Returns:

top frame margin

getTextWidth

public int getTextWidth(int width)

Specified by:

getTextWidth in interface IsTableContext

getWidth

public int getWidth()

Specified by:

getWidth in interface IsTableContext

setFrameBottomChar

public AT_Context setFrameBottomChar(Character frameBottom)

Sets the bottom frame margin character.

Parameters:

frameBottom - character

Returns:

this to allow chaining

setFrameBottomMargin

public AT_Context setFrameBottomMargin(int frameBottom)

Sets the bottom frame margin

Parameters:

frameBottom - margin

Returns:

this to allow chaining

setFrameLeftChar

public AT_Context setFrameLeftChar(Character frameLeft)

Sets the left frame margin character.

Parameters:

frameLeft - character

Returns:

this to allow chaining

setFrameLeftMargin

public AT_Context setFrameLeftMargin(int frameLeft)

Sets the left frame margin

Parameters:

frameLeft - margin

Returns:

this to allow chaining

setFrameLeftRightChar

public AT_Context setFrameLeftRightChar(Character frameChar)

Sets the left and right frame margin character.

Parameters:

frameChar - character

Returns:

this to allow chaining

setFrameLeftRightChar

public AT_Context setFrameLeftRightChar(Character frameLeft,
                                        Character frameRight)

Sets the left and right frame margin character.

Parameters:

frameLeft - character

frameRight - character

Returns:

this to allow chaining

setFrameLeftRightMargin

public AT_Context setFrameLeftRightMargin(int frameMargin)

Sets the left and right frame margin.

Parameters:

frameMargin - margin

Returns:

this to allow chaining

setFrameLeftRightMargin

public AT_Context setFrameLeftRightMargin(int frameLeft,
                                          int frameRight)

Sets the left and right frame margin.

Parameters:

frameLeft - margin

frameRight - margin

Returns:

this to allow chaining

setFrameRightChar

public AT_Context setFrameRightChar(Character frameRight)

Sets the right frame margin character.

Parameters:

frameRight - character

Returns:

this to allow chaining

setFrameRightMargin

public AT_Context setFrameRightMargin(int frameRight)

Sets the right frame margin

Parameters:

frameRight - margin

Returns:

this to allow chaining

setFrameTopBottomMargin

public AT_Context setFrameTopBottomMargin(int frameMargin)

Sets the top and bottom frame margin.

Parameters:

frameMargin - margin

Returns:

this to allow chaining

setFrameTopBottomMargin

public AT_Context setFrameTopBottomMargin(int frameTop,
                                          int frameBottom)

Sets the top and bottom frame margin.

Parameters:

frameTop - margin

frameBottom - margin

Returns:

this to allow chaining

setFrameTopChar

public AT_Context setFrameTopChar(Character frameTop)

Sets the top frame margin character.

Parameters:

frameTop - character

Returns:

this to allow chaining

setFrameTopMargin

public AT_Context setFrameTopMargin(int frameTop)

Sets the top frame margin

Parameters:

frameTop - margin

Returns:

this to allow chaining

setWidth

public AT_Context setWidth(int width)

Sets the table width.

Parameters:

width - new width

Returns:

this to allow chaining

setGrid

public AT_Context setGrid(TA_Grid grid)

Sets the grid used to render the table.

Parameters:

grid - new grid, ignored if null

Returns:

self to allow for chaining

getGrid

public TA_Grid getGrid()

Returns the grid.

Returns:

table grid

setGridTheme

public AT_Context setGridTheme(TA_GridThemes theme)

Sets the grid theme.

Parameters:

theme - new grid theme, ignored if null

Returns:

self to allow for chaining

setGridTheme

public AT_Context setGridTheme(int theme)

Sets the grid theme.

Parameters:

theme - new grid theme, must be positive integer

Returns:

self to allow for chaining

setGridThemeOptions

public AT_Context setGridThemeOptions(TA_GridThemeOptions options)

Sets options for the grid theme.

Parameters:

options - new grid theme options, ignored if null

Returns:

self to allow for chaining

setGridThemeOptions

public AT_Context setGridThemeOptions(int options)

Sets options for the grid theme.

Parameters:

options - new grid theme options, must be positive integer

Returns:

self to allow for chaining

getGridTheme

public int getGridTheme()

Returns the grid theme.

Returns:

grid theme

getGridThemeOptions

public int getGridThemeOptions()

Returns the grid theme options.

Returns:

grid theme options

setLineSeparator

public AT_Context setLineSeparator(String separator)

Sets a new line separator for the renderer.

Parameters:

separator - the new separator, ignored if blank

Returns:

self to allow chaining

getLineSeparator

public String getLineSeparator()

Returns the current set line separator.

Returns:

the line separator, null if none set