de.vandermeer.asciithemes

Interface TA_Grid

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt

public interface TA_Grid
extends IsTextArt

A grid (table) using ASCII and/or UTF characters.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

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

Field Summary

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
default TA_Grid	addBottomRuleCharacterMap(int ruleset, char none, char horizontal, char bottomleft, char bottomright, char midup) Adds a new character map for a bottom rule using the given rule set indicator for normal, light, etc.
default TA_Grid	addCharacterMap(int ruleset, char none, char vertical, char midleft, char midright) Adds a new character map for a content row using the given rule set indicator for normal, light, etc.
default TA_Grid	addCharacterMap(int ruleset, char none, char horizontal, char vertical, char topleft, char topright, char bottomleft, char bottomright, char midleft, char midright, char midboth, char middown, char midup) Adds a new character map for a given rule set.
default ArrayList<StrBuilder>	addGrid(Collection<Object> content, int mode) Changes the input list by adding a grid.
default ArrayList<StrBuilder>	addGrid(Collection<Object> content, TA_GridThemes theme) Changes the input list by adding a grid.
default ArrayList<StrBuilder>	addGrid(Collection<Object> content, TA_GridThemes theme, TA_GridThemeOptions options) Changes the input list by adding a grid.
default TA_Grid	addMidruleCharacterMap(int ruleset, char none, char vertical, char midleft, char midright, char midboth, char middown, char midup) Adds a new character map for a mid rule using the given rule set indicator for normal, light, etc.
void	addSupportedRuleSet(int set) Adds a new rule set to the list supported rule sets.
default TA_Grid	addTopruleCharacterMap(int ruleset, char none, char horizontal, char topleft, char topright, char middown) Adds a new character map for a top rule using the given rule set indicator for normal, light, etc.
default ArrayList<Integer>	calculateColumns(ArrayList<Object> table) Calculates column width across the table, using columns with content to calculate width.
static TA_Grid	create(String description) Creates a new empty (no character map loaded) grid object.
Map<Integer,Character>	getCharacterMap() Returns the character map.
default boolean	hasRuleSet(int set) Tests if a particular rule set is supported by the grid.
int	supportedRulesets() Returns a flag with supported rule sets (effectively a list of supported rule sets).
default void	testRuleType(int type) Tests if the requested row type can be used, that is there is a corresponding character map available.
default StrBuilder	toDoc()

Methods inherited from interface HasDescription

getDescription

Method Detail

getCharacterMap

Map<Integer,Character> getCharacterMap()

Returns the character map.

Returns:

character map

addCharacterMap

default TA_Grid addCharacterMap(int ruleset,
                                char none,
                                char horizontal,
                                char vertical,
                                char topleft,
                                char topright,
                                char bottomleft,
                                char bottomright,
                                char midleft,
                                char midright,
                                char midboth,
                                char middown,
                                char midup)

Adds a new character map for a given rule set.

Parameters:

ruleset - required rule type (e.g. normal or light)

none - the none character (usually blank)

horizontal - the horizontal border character

vertical - the vertical border character

topleft - the top-left corner character

topright - the top-right corner character

bottomleft - the bottom-left corner character

bottomright - the bottom-right corner character

midleft - the mid-left corner character

midright - the mid-right corner character

midboth - the mid-both connector character

middown - the mid-down connector character

midup - the mid-up connector character

Returns:

this to allow chaining

addTopruleCharacterMap

default TA_Grid addTopruleCharacterMap(int ruleset,
                                       char none,
                                       char horizontal,
                                       char topleft,
                                       char topright,
                                       char middown)

Adds a new character map for a top rule using the given rule set indicator for normal, light, etc.

Parameters:

ruleset - required rule type (e.g. normal or light)

none - the none character (usually blank)

horizontal - the horizontal border character

topleft - the top-left corner character

topright - the top-right corner character

middown - the mid-down connector character

Returns:

this to allow chaining

addBottomRuleCharacterMap

default TA_Grid addBottomRuleCharacterMap(int ruleset,
                                          char none,
                                          char horizontal,
                                          char bottomleft,
                                          char bottomright,
                                          char midup)

Adds a new character map for a bottom rule using the given rule set indicator for normal, light, etc.

Parameters:

ruleset - required rule type (e.g. normal or light)

none - the none character (usually blank)

horizontal - the horizontal border character

bottomleft - the bottom-left corner character

bottomright - the bottom-right corner character

midup - the mid-up connector character

Returns:

this to allow chaining

addMidruleCharacterMap

default TA_Grid addMidruleCharacterMap(int ruleset,
                                       char none,
                                       char vertical,
                                       char midleft,
                                       char midright,
                                       char midboth,
                                       char middown,
                                       char midup)

Adds a new character map for a mid rule using the given rule set indicator for normal, light, etc.

Parameters:

ruleset - required rule type (e.g. normal or light)

none - the none character (usually blank)

vertical - the vertical border character

midleft - the mid-left corner character

midright - the mid-right corner character

midboth - the mid-both connector character

middown - the mid-down connector character

midup - the mid-up connector character

Returns:

this to allow chaining

addCharacterMap

default TA_Grid addCharacterMap(int ruleset,
                                char none,
                                char vertical,
                                char midleft,
                                char midright)

Adds a new character map for a content row using the given rule set indicator for normal, light, etc.

Parameters:

ruleset - required rule type (e.g. normal or light)

none - the none character (usually blank)

vertical - the vertical border character

midleft - the mid-left corner character

midright - the mid-right corner character

Returns:

this to allow chaining

supportedRulesets

int supportedRulesets()

Returns a flag with supported rule sets (effectively a list of supported rule sets).

Returns:

supported rule sets

addSupportedRuleSet

void addSupportedRuleSet(int set)

Adds a new rule set to the list supported rule sets.

Parameters:

set - new rule set

hasRuleSet

default boolean hasRuleSet(int set)

Tests if a particular rule set is supported by the grid.

Parameters:

set - the rule set to test for

Returns:

true if the rule set is supported, false otherwise

calculateColumns

default ArrayList<Integer> calculateColumns(ArrayList<Object> table)

Calculates column width across the table, using columns with content to calculate width.

Parameters:

table - a table with rules and content

Returns:

calculated columns

testRuleType

default void testRuleType(int type)

Tests if the requested row type can be used, that is there is a corresponding character map available. The test is a validation of state, throwing an exception if no corresponding character map is provided by the grid.

Parameters:

type - row type to test

addGrid

default ArrayList<StrBuilder> addGrid(Collection<Object> content,
                                      TA_GridThemes theme)

Changes the input list by adding a grid.

The method does guarantee that all lines (member of the final collection) have the same length.

Parameters:

content - the content to add a grid to

theme - the grid theme

Returns:

new list with grid

addGrid

default ArrayList<StrBuilder> addGrid(Collection<Object> content,
                                      TA_GridThemes theme,
                                      TA_GridThemeOptions options)

Changes the input list by adding a grid.

The method does guarantee that all lines (member of the final collection) have the same length.

Parameters:

content - the content to add a grid to

theme - the grid theme

options - the grid theme options

Returns:

new list with grid

addGrid

default ArrayList<StrBuilder> addGrid(Collection<Object> content,
                                      int mode)

Changes the input list by adding a grid.

The method does guarantee that all lines (member of the final collection) have the same length.

Parameters:

content - the content to add a grid to

mode - options for the grid

Returns:

new list with grid

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc

create

static TA_Grid create(String description)

Creates a new empty (no character map loaded) grid object.

Parameters:

description - a description for the line, cannot be blank

Returns:

new grid object