de.frame4j.graf

Class MatrixTextDisplay

java.lang.Object

de.frame4j.graf.MatrixDisplay

de.frame4j.graf.MatrixTextDisplay

All Implemented Interfaces:

Paintable, Runnable

public class MatrixTextDisplay
extends MatrixDisplay
implements Runnable

A matrix text display.

Objects of this class act as a simple rectangular dot matrix LCD or LED display, like the parent MatrixDisplay with the additional feature of organising a multi text-line structure and the character display via DisplayPattern.


© Copyright 2000 - 2001, 2003, Albrecht Weinert

Version:

11 (5.02.2019)

Author:

Albrecht Weinert

See Also:

Paintable

Field Summary

Fields

Modifier and Type	Field and Description
int	charDist Character spacing in matrix dots.
protected int	columWidth
int	lineDist Line spacing in matrix dots.
protected int	lineHeight
int	nOcols Number of 5*8 (character) columns.
int	nOlines Number of 5*8 (character) lines.

Fields inherited from class de.frame4j.graf.MatrixDisplay

allXdots, allYdots, background, dots, foreground, marginGround, matDisDim, onRound, SCR_R_X, SCR_R_Y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MatrixTextDisplay(int nOlines, int nOcols, int charDist, int lineDist, MatrixDisplayDim size) Constructor by all measures / sizes.

Method Summary

Modifier and Type	Method and Description
void	clearLine(int line) Clear a line.
static MatrixTextDisplay	make(int nOlines, int nOcols, int charDist, int lineDist, MatrixDisplayDim size) Making by supplied measures.
void	putC(char c, int line, int colmn) Set one character.
void	putCR(char c, int line) Shift in one character from the right.
void	putStringL(String text, int maxLen, int line) Left aligned setting in of a character sequence.
void	putStringR(String text, int maxLen, int line) Right aligned setting in of a character sequence.
void	run() Running display thread's working method.
void	shiftL(int line) Left shift a line by one character position.
boolean	startRunText(String text, Component comp, int time) Start the running text display (only for one liners).
boolean	stopRunText() Stop the running display.

Methods inherited from class de.frame4j.graf.MatrixDisplay

clear, getDot, paint, setAllBack, setBackground, setDot, setDots, setForeground, setMarginGround, setShift

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.graf.Paintable

paint, paint

Field Detail

nOcols

public final int nOcols

Number of 5*8 (character) columns.

This is a text oriented measure. Set on construction. Range: 1..200
default: 20

nOlines

public final int nOlines

Number of 5*8 (character) lines.

This is a text oriented measure. Set on construction. Range: 1..200
default: 1

charDist

public final int charDist

Character spacing in matrix dots.

Range: 1..21
default: 2

lineDist

public final int lineDist

Line spacing in matrix dots.

Range: 1..10
default: 2

lineHeight

protected final int lineHeight

columWidth

protected final int columWidth

Constructor Detail

MatrixTextDisplay

protected MatrixTextDisplay(int nOlines,
                            int nOcols,
                            int charDist,
                            int lineDist,
                            MatrixDisplayDim size)

Constructor by all measures / sizes.

Internal use; not any checks.

Parameters:

size - herein size.noXdots and size.noYdots are irrelevant

Method Detail

make

public static MatrixTextDisplay make(int nOlines,
                                     int nOcols,
                                     int charDist,
                                     int lineDist,
                                     MatrixDisplayDim size)

Making by supplied measures.

A MatrixTextDisplay object according to the parameter values supplied (or their default value if out of range) will be made and returned.

Parameters:

size - herein size.noXdots and size.noYdots are irrelevant; if null 16 is took for margins and 4 for the dot size.

clearLine

public void clearLine(int line)

Clear a line.

The whole line content including the upper and lower charDist spacing dots and the right scroll reserve will be set to 0 (off, space).

Parameters:

line - 0..nOlines (line == nOlines is lower scroll reserve)

putC

public void putC(char c,
                 int line,
                 int colmn)

Set one character.

shiftL

public void shiftL(int line)

Left shift a line by one character position.

From the right the character from the scroll reserve will be put in.

putCR

public void putCR(char c,
                  int line)

Shift in one character from the right.

The call is equivalent to:
putC(c, line, nOcols);
shiftL(line);

putStringR

public void putStringR(String text,
                       int maxLen,
                       int line)

Right aligned setting in of a character sequence.

The line will be cleared before.

Parameters:

text - the line

maxLen - the length / number of characters

line - the line to modify

putStringL

public void putStringL(String text,
                       int maxLen,
                       int line)

Left aligned setting in of a character sequence.

The line will be cleared before.

Parameters:

text - the character sequence to set in

maxLen - the length / number of characters

line - the line to modify

stopRunText

public boolean stopRunText()

Stop the running display.

Returns:

false

startRunText

public boolean startRunText(String text,
                            Component comp,
                            int time)

Start the running text display (only for one liners).

The text will be set left aligned in line 0.
If this is a one line marquee display and if the component comp supplied is not null and if the text is longer than the display width, a thread is started, that will scroll the whole text from left to right (infinitely until explicitly stopped).

Parameters:

text - the running display text (marquee)

comp - a graphical component, embedding this Paintable object and accepting repaint requests.

time - the scroll step time in milliseconds 10 .. 2000ms default 44ms

Returns:

true, if the thread was started

run

public void run()

Running display thread's working method.

Specified by:

run in interface Runnable