MatrixDisplayDim ( Frame4J -- the Java framework de.frame4j... )

java.lang.Object
- de.frame4j.graf.MatrixDisplayDim

```
@MinDoc(copyright="Copyright 2003,  2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.11",
        lastModified="5.02.2019",
        lastModifiedBy="A. Weinert",
        usage="use this (stateful) class to hold graphical size information",
        purpose="a matrix display\'s dimension")
public final class MatrixDisplayDim
extends Object
```
The dimension of a matrix display.

Objects of this class represent the immutable size information among others usable for simple LCD or LED like dot matrix displays, like e.g. MatrixDisplay. They just hold state and have virtually no behaviour (except for getPreferredSize(), getDotsSize()).

Of course, the class may be used to hold immutable size information for other purposes, too. It might even serve as a good substitute for the (pitifully mutable) Dimension.

© Copyright 2003 Albrecht Weinert

Version:

11 (5.02.2019)

Author:

Albrecht Weinert

See Also:

MatrixDisplay

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`dotHeight` Size of points, Y direction, vertical.
`int`	`dotWidth` Size of points, X direction, horizontal.
`int`	`hash` Hash code.
`int`	`height` Display size, Y direction, vertical, height including margin.
`int`	`heightDots` Display size, Y direction, vertical, height without margin.
`int`	`noXdots` Number of visible points, X direction, horizontal.
`int`	`noYdots` Number of visible points, Y direction, vertical.
`int`	`width` Display size, X direction, horizontal, width including margin.
`int`	`widthDots` Display size, X direction, horizontal, width without margin.
`int`	`xDist` Distance of points, X direction, horizontal.
`int`	`xMarg` Margin, X direction in Pixel.
`int`	`yDist` Distance of points, Y direction, vertical.
`int`	`yMarg` Margin, Y direction in Pixel.

Constructor Summary

Constructors
Constructor and Description
`MatrixDisplayDim(int noXdots, int noYdots, int margin, int size, int dist)` Constructor with same X and Y dimensions for matrix points.
`MatrixDisplayDim(int noXdots, int noYdots, int marginX, int marginY, int sizeX, int sizeY, int distX, int distY)` Constructor with independent X and Y dimensions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Compare the dimensions.
`Dimension`	`getDotsSize()` The matrix display's preferred size without margins.
`Dimension`	`getPreferredSize()` The matrix display's preferred size.
`int`	`hashCode()` Hash code.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - noXdots
```
public final int noXdots
```
    Number of visible points, X direction, horizontal.
    
    It will be finally set at construction.
  - noYdots
```
public final int noYdots
```
    Number of visible points, Y direction, vertical.
    
    It will be finally set at construction.
  - xMarg
```
public final int xMarg
```
    Margin, X direction in Pixel.
    
    It will be finally set at construction.
  - yMarg
```
public final int yMarg
```
    Margin, Y direction in Pixel.
    
    It will be finally set at construction.
  - dotWidth
```
public final int dotWidth
```
    Size of points, X direction, horizontal.
    
    Must be less or equal xDist.
    
    It will be finally set at construction.
  - dotHeight
```
public final int dotHeight
```
    Size of points, Y direction, vertical.
    
    Must be less or equal yDist.
  - xDist
```
public final int xDist
```
    Distance of points, X direction, horizontal.
    
    Must be greater or equal dotWidth.
    
    It will be finally set at construction.
  - yDist
```
public final int yDist
```
    Distance of points, Y direction, vertical.
    
    Must be greater or equal dotHeight.
    
    It will be finally set at construction.
  - hash
```
public final int hash
```
    Hash code.
  - width
```
public final int width
```
    Display size, X direction, horizontal, width including margin.
    
    Will be calculated as 2 * margin + (n-1)* spacing + 1 * dot_dimension.
  - height
```
public final int height
```
    Display size, Y direction, vertical, height including margin.
    
    Will be calculated as 2 * margin + (n-1)* spacing + 1 * dot_dimension.
  - widthDots
```
public final int widthDots
```
    Display size, X direction, horizontal, width without margin.
    
    Will be calculated as (n-1)* spacing + 1 * dot_dimension.
  - heightDots
```
public final int heightDots
```
    Display size, Y direction, vertical, height without margin.
    
    Will be calculated as (n-1)* spacing + 1 * dot_dimension.
- Constructor Detail
  - MatrixDisplayDim
```
public MatrixDisplayDim(int noXdots,
                        int noYdots,
                        int margin,
                        int size,
                        int dist)
```
    Constructor with same X and Y dimensions for matrix points.
    
    Wrong parameter values will default to the sensible minimum values.
    
    Parameters:
    
    noXdots - Number of points horizontal ( >= 1)
    
    noYdots - Number of points vertical ( >= 1)
    
    margin - Horizontal and vertical margin in pixel ( >= 0)
    
    size - Horizontal and vertical dimension of the matrix dots in pixel ( >= 1)
    
    dist - Horizontal and vertical distance of the dots in Pixel including their own size ( >= size)
  - MatrixDisplayDim
```
public MatrixDisplayDim(int noXdots,
                        int noYdots,
                        int marginX,
                        int marginY,
                        int sizeX,
                        int sizeY,
                        int distX,
                        int distY)
```
    Constructor with 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, except for the number of dots.
    
    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
  - equals
```
public boolean equals(Object other)
```
    Compare the dimensions.
    
    This method returns true if the other object is of type MatrixDisplayDim and has the same values for all dimensions defined in this class.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Overrides:
    
    hashCode in class Object
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    The matrix display's preferred size.
    
    This method returns the dimensions width * height as new Dimension object. This includes the margins.
  - getDotsSize
```
public Dimension getDotsSize()
```
    The matrix display's preferred size without margins.
    
    This method returns the dimensions widthDots * heightDots as a new Dimension object. This does exclude the margins; its the pure dot field's size.

Class MatrixDisplayDim

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

noXdots

noYdots

xMarg

yMarg

dotWidth

dotHeight

xDist

yDist

hash

width

height

widthDots

heightDots

Constructor Detail

MatrixDisplayDim

MatrixDisplayDim

Method Detail

equals

hashCode

getPreferredSize

getDotsSize