de.frame4j.graf

Class MatrixDisplay

java.lang.Object

de.frame4j.graf.MatrixDisplay

All Implemented Interfaces:

Paintable

Direct Known Subclasses:

MatrixTextDisplay

@MinDoc(copyright="Copyright 1998 - 2003, 2004, 2008, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.11",
        lastModified="5.02.2019",
        lastModifiedBy="A. Weinert",
        usage="import, use as Paintable",
        purpose="a matrix display for graphical applications")
public class MatrixDisplay
extends Object
implements Paintable

A matrix display.

Objects of this class act as a simple rectangular dot matrix LCD or LED display.

To basically show printable characters display (with no good descenders) 5 * 8 (matrix) points (+ 2 points character distance) are sufficient:

        01234..01234..01234
     0   ***           ***
     1  *   *         *   *
     2  *   *         *   *
     3  *****   ****   ****
     4  *   *  *   *      *
     5  *   *   ****      *
     6  *   *      *   ***
     7         ****
        ( A      g      9 )

For most characters of ISO 8859-1 (plus some more) the class DisplayPattern features such pattern. For one line of 20 characters (and distance 2 dots) a MatrixDisplay of 138 * 8 would have to be made.

Every point's state is represented by a byte value:

Value	Meaning	Colour
0	Off	background colour
else	On	foreground colour

© Copyright 2000 - 2001, 2003, 2006 Albrecht Weinert

Version:

11 (5.02.2019)

Author:

Albrecht Weinert

See Also:

DisplayPattern

Field Summary

Fields

Modifier and Type	Field and Description
int	allXdots Number of all points, X direction, horizontal .
int	allYdots Number of all points, Y direction, vertical .
Color	background Background colour..
protected byte[][]	dots State of the points.
Color	foreground Foreground colour.
Color	marginGround Margin colour.
protected MatrixDisplayDim	matDisDim
boolean	onRound "On point" shall be round.
static int	SCR_R_X Scroll reserve, X direction, extra columns to right.
static int	SCR_R_Y Scroll reserve, in Y direction, additional lines below.

Constructor Summary

Constructors

Constructor and Description
MatrixDisplay(int noXdots, int noYdots, int margin, int size, int dist) Constructor with equal x and y sizes for the matrix dots.
MatrixDisplay(int noXdots, int noYdots, int marginX, int marginY, int sizeX, int sizeY, int distX, int distY) Universal Constructor by independent x and y dimensions .
MatrixDisplay(MatrixDisplayDim size) Constructor by predefined dimensions.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all points.
byte	getDot(int x, int y) Get a point's state.
void	paint(Graphics g, int px, int py, int w, int h) Painting the matrix display dots.
void	setAllBack(Color c) Set the background and margin colour.
void	setBackground(Color c) Set the background colour.
void	setDot(int x, int y, byte dot) Set a point's state.
void	setDots(int x, int y, int xNum, int yNum, byte[][] muster, int xOff, int yOff) Set multiple points.
void	setForeground(Color c) Set the foreground colour.
void	setMarginGround(Color c) Set the margin colour.
void	setShift(int sX, int sY) Shift the display to top and to left by number of pixels.

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

SCR_R_X

public static final int SCR_R_X

Scroll reserve, X direction, extra columns to right.

26

See Also:

Constant Field Values

allXdots

public final int allXdots

Number of all points, X direction, horizontal .

Set finally at construction.
Without counting the scroll reserve SCR_R_Y.

SCR_R_Y

public static final int SCR_R_Y

Scroll reserve, in Y direction, additional lines below.

18

See Also:

Constant Field Values

allYdots

public final int allYdots

Number of all points, Y direction, vertical .

Set finally at construction.

onRound

public boolean onRound

"On point" shall be round.

If true the dot in the on state will be drawn as circle (oval) not as rectangle.
This is automatically set false if one of the dimensions otWidth or dotHeight is less than five.

default: false

dots

protected final byte[][] dots

State of the points.

The two dimensional array will be constructed as
new byte[noYdots + SCR_R_Y][noXdots + SCR_R_X]
respectively as t
new byte[allYdots][allXdots]
The reserve to below and to right facilitates scrolling operations to the top and to the left supplying preset but invisible content.

First index is line the second the column number. This is in discordance to usual speaking and coordinate / parameter sequence (x, y).

matDisDim

protected final MatrixDisplayDim matDisDim

foreground

public Color foreground

Foreground colour.

default: red (rt)

background

public Color background

Background colour..

default: gray (gr)

marginGround

public Color marginGround

Margin colour.

default: yellow (ge)

Constructor Detail

MatrixDisplay

public MatrixDisplay(int noXdots,
                     int noYdots,
                     int margin,
                     int size,
                     int dist)

Constructor with equal x and y sizes for the matrix dots.

Wrong parameter values default to sensible minimal values.

Parameters:

noXdots - Number of points horizontal ( >= 1)

noYdots - Number of points vertical ( >= 1 )

margin - Horizontal and vertical margin in pixel ( >= 0 )

size - The dot's horizontal and vertical dimension in pixel ( >= 1 )

dist - The dot's horizontal and vertical distance including their size ( >= size )

MatrixDisplay

public MatrixDisplay(MatrixDisplayDim size)

Constructor by predefined dimensions.

Parameters:

size - all dimensions in one object

MatrixDisplay

public MatrixDisplay(int noXdots,
                     int noYdots,
                     int marginX,
                     int marginY,
                     int sizeX,
                     int sizeY,
                     int distX,
                     int distY)

Universal Constructor by independent x and y dimensions .

Wrong X parameter values will default to sensible minimum values.
Wrong Y parameter values will default to to corresponding X values.

Parameters:

noXdots - Number of points horizontal ( >= 1)

noYdots - Number of points vertical ( >= 1)

marginX - Horizontal margin in Pixel ( >= 0)

marginY - Vertical margin in Pixel ( >= 0)

sizeX - The dot's horizontal dimension in pixel ( >= 1)

sizeY - The dot's vertical dimension in pixel ( >= 1)

distX - Horizontal distance of the dots including their ( >= size)

distY - Vertical distance of the dots including their ( >= size)

Method Detail

getDot

public byte getDot(int x,
                   int y)

Get a point's state.

If x or y are outside the index range of dots, 0 is returned.

setDot

public void setDot(int x,
                   int y,
                   byte dot)

Set a point's state.

If x or y are outside the index range of dots, nothing is done.

clear

public void clear()

Clear all points.

This method sets all dots to 0 (=off).

setDots

public void setDots(int x,
                    int y,
                    int xNum,
                    int yNum,
                    byte[][] muster,
                    int xOff,
                    int yOff)

Set multiple points.

If muster is null, dots (itself) is taken as source and this method will scroll the content.

muster's first index is line the second is column.

Parameters:

x - Start column in the MatrixDisplay

y - Start line in the MatrixDisplay

xNum - Number of columns to change (will be automatically limited)

yNum - same for the lines

muster - a matrix point content (as source); null takes the actual content (shift operations)

xOff - Starting column in muster (source)

yOff - Starting line in muster (source)

setMarginGround

public void setMarginGround(Color c)

Set the margin colour.

setBackground

public void setBackground(Color c)

Set the background colour.

setAllBack

public void setAllBack(Color c)

Set the background and margin colour.

setForeground

public void setForeground(Color c)

Set the foreground colour.

setShift

public void setShift(int sX,
                     int sY)

Shift the display to top and to left by number of pixels.

The display can be shifted by a maximum of xDist to left respectively by maximal yDist pixel to the top bringing (parts of) the scroll reserve in sight.
This method does not change the displays content as would be done by using setDots(int, int, int, int, null, int, int). It just manipulates the origins for the next paint. This allows for smother scrolling implementations.

paint

public void paint(Graphics g,
                  int px,
                  int py,
                  int w,
                  int h)

Painting the matrix display dots.

The dots will be painted on g starting from p (left upper corner including margins) using dim as maximum size.

If g is null nothing happens.
p null acts as (0, 0) and dim null acts as natural size of this MatrixDisplay.

Specified by:

paint in interface Paintable

Parameters:

g - The notorious Graphics object (that can nowadays be expected to be a Graphics2D).
If null this method does nothing.

px - y are the left upper corner of where to paint; y grows downwards [sic!]

w - height are the size of an surrounding rectangle to paint within; if null (0, 0) either this object's "natural" size (if there is such thing) shall be used or nothing is to be done

See Also:

Paintable.paint(Graphics, Point, Dimension)