jhelp.util.gui

Class JHelpMask

java.lang.Object

jhelp.util.gui.JHelpMask

public class JHelpMask
extends java.lang.Object

Represents a mask.
A mask is image with light on (foreground) pixels and light off (background) pixels.
Because there are only 2 possible value per pixels (on or off) the memory size is optimized

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	data Data of mask
private int	height Mask height
private int	width Mask width

Constructor Summary

Constructors

Modifier	Constructor and Description
	JHelpMask(int width, int height) Create a new instance of JHelpMask
private	JHelpMask(int width, int height, byte[] data) Create a new instance of JHelpMask

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() clear the mask.
void	drawCharacter(char character, java.lang.String family) Use a character for mask
void	fill(int x, int y) Light on a pixel and all pixels of around, the filling is stopped by pixels already on
int	getHeight() Mask height
boolean	getValue(int x, int y) Indicates if a pixel in on
int	getWidth() Mask width
static JHelpMask	load(java.io.InputStream inputStream) Load the mask from a stream
void	save(java.io.OutputStream outputStream) Save the mask in a stream
void	setValue(int x, int y, boolean value) Change a pixel value

Methods inherited from class java.lang.Object

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

Field Detail

data

private final byte[] data

Data of mask

height

private final int height

Mask height

width

private final int width

Mask width

Constructor Detail

JHelpMask

private JHelpMask(int width,
         int height,
         byte[] data)

Create a new instance of JHelpMask

Parameters:

width - Mask width

height - Mask height

data - Mask data

JHelpMask

public JHelpMask(int width,
         int height)

Create a new instance of JHelpMask

Parameters:

width - Mask width

height - Mask height

Method Detail

load

public static JHelpMask load(java.io.InputStream inputStream)
                      throws java.io.IOException

Load the mask from a stream

Parameters:

inputStream - Stream to read

Returns:

Loaded mask

Throws:

java.io.IOException - On reading issue

clear

public void clear()

clear the mask. Put all pixels at off

drawCharacter

public void drawCharacter(char character,
                 java.lang.String family)

Use a character for mask

Parameters:

character - Character to use

family - Font family name

fill

public void fill(int x,
        int y)

Light on a pixel and all pixels of around, the filling is stopped by pixels already on

Parameters:

x - X fill start

y - Y fill start

getHeight

public int getHeight()

Mask height

Returns:

Mask height

getValue

public boolean getValue(int x,
               int y)

Indicates if a pixel in on

Parameters:

x - Pixel x

y - Pixel Y

Returns:

true if the pixel in on

getWidth

public int getWidth()

Mask width

Returns:

Mask width

save

public void save(java.io.OutputStream outputStream)
          throws java.io.IOException

Save the mask in a stream

Parameters:

outputStream - Stream where write the mask

Throws:

java.io.IOException - On writing issue

setValue

public void setValue(int x,
            int y,
            boolean value)

Change a pixel value

Parameters:

x - Pixel X

y - Pixel Y

value - true for light on, false for light off