de.vandermeer.asciithemes

Interface TA_Frame

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt

public interface TA_Frame
extends IsTextArt

A frame (box) 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 ArrayList<StrBuilder>	addFrame(Collection<StrBuilder> coll, int mode) Changes the input collection by adding a frame.
default String	addFrameString(Collection<StrBuilder> coll, int mode) Returns a string containing the input collection with the requested frame.
static TA_Frame	create(TA_Line line, TA_Corner corner, TA_Border border, String description) Creates a new frame theme using the same top/bottom lines.
static TA_Frame	create(TA_Line topline, TA_Line bottomline, TA_Corner corner, TA_Border border, String description) Creates a new frame theme using different lines and the same top/bottom corners.
TA_Border	getBorder() Returns the border for the frame.
TA_Line	getBottomline() Returns the bottom line of the theme.
TA_Corner	getCorner() Returns the corner.
TA_Line	getTopline() Returns the top line of the theme.
default StrBuilder	renderBottomLine(int mode, int width) Renders a bottom line for the frame.
default StrBuilder	renderTopLine(int mode, int width) Renders a top line for the frame.
default StrBuilder	toDoc()

Methods inherited from interface HasDescription

getDescription

Method Detail

addFrameString

default String addFrameString(Collection<StrBuilder> coll,
                              int mode)

Returns a string containing the input collection with the requested frame.

Parameters:

coll - input collection

mode - frame mode

Returns:

string with the framed collection

addFrame

default ArrayList<StrBuilder> addFrame(Collection<StrBuilder> coll,
                                       int mode)

Changes the input collection by adding a frame. The return list will have - one line added as first element with the frame top line, - one line added at the end with the frame bottom line, and - for each original element border characters will be added left and right.

The methods assumes that all line (members of the collection) have the same length.

The following exceptions apply:

• top line will not be added if the frame does not define a top line nor top corners

• bottom line will not be added if the frame does not define a bottom line nor bottom corners

• left borders will only be added if the frame defines a border with left border character

• right borders will only be added if the frame defines a border with right border character

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

Parameters:

coll - the collection to add a frame to

mode - options for the frame

Returns:

new list with frame

renderTopLine

default StrBuilder renderTopLine(int mode,
                                 int width)

Renders a top line for the frame.

Parameters:

mode - the frame mode

width - the width of lines in the frame

Returns:

a builder with top line, empty if none was created

renderBottomLine

default StrBuilder renderBottomLine(int mode,
                                    int width)

Renders a bottom line for the frame.

Parameters:

mode - the frame mode

width - the width of lines in the frame

Returns:

a builder with bottom line, empty if none was created

getBorder

TA_Border getBorder()

Returns the border for the frame.

Returns:

frame border, cannot be null

getBottomline

TA_Line getBottomline()

Returns the bottom line of the theme.

Returns:

line character, cannot be null

getCorner

TA_Corner getCorner()

Returns the corner.

Returns:

corner, cannot be null

getTopline

TA_Line getTopline()

Returns the top line of the theme.

Returns:

line character, cannot be null

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc

create

static TA_Frame create(TA_Line line,
                       TA_Corner corner,
                       TA_Border border,
                       String description)

Creates a new frame theme using the same top/bottom lines.

Parameters:

line - the frame top/bottom line

corner - the frame corner

border - the frame border

description - a description for the line, cannot be blank

Returns:

new frame theme

create

static TA_Frame create(TA_Line topline,
                       TA_Line bottomline,
                       TA_Corner corner,
                       TA_Border border,
                       String description)

Creates a new frame theme using different lines and the same top/bottom corners.

Parameters:

topline - the frame top line

bottomline - the frame bottom line

corner - the frame corner

border - the frame border

description - a description for the line, cannot be blank

Returns:

new frame theme