org.java_lcw.jil

Class Image

java.lang.Object

org.java_lcw.jil.Image

public class Image
extends java.lang.Object

Main Image object used to construct new Image files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.Color This class is how colors are passed around to/from the Image Object
static class	Image.ImageException
static class	Image.ImageType Image Types for Image Object to use (open/save)
static class	Image.ScaleType ScaleTypes that can be used when resizing an Image.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	MODE_L MODE_L is grey scaled image (8 bits per pixel, 1 channel)
static byte	MODE_RGB MODE_RGB is an RGB (Red Green Blue) image Each color is its own Channel (24 bits per pixel, 3 channels)
static byte	MODE_RGBA MODE_RGBA is an RGBA (Red Green Blue Alpha) image Each color and alpha has its own Channel (32 bits per pixel, 4 channels)

Method Summary

Methods

Modifier and Type	Method and Description
Image	changeMode(byte MODE) Change the MODE of the current Image.
Image	copy()
static Image	create(byte mode, int width, int height) Main Method for creating a new Image
Image	cut(int x, int y, int width, int height)
void	fillColor(Image.Color c) Fill current Image with this color
static Image	fromBufferedImage(java.awt.image.BufferedImage BI) Create an Image from a BufferedImage from AWT - The new Image will always be RGBA type
static Image	fromByteArray(byte mode, int width, int height, byte[] data) Create an Image object from a byte Array.
static Image	fromImageData(org.eclipse.swt.graphics.ImageData data) This takes ImageData from SWT and makes an Image Object.
byte	getBPP() Get the number of bitsPerPixel, this is the same as the Image.MODE_ of the Image
byte	getChannels() Returns the number channels in this Image (BPP/8)
int	getHeight() Returns the height of this Image
Image.Color	getPixel(int x, int y) The a color for a given pixel
byte	getPixelInChannel(int x, int y, byte c)
int	getWidth() Returns the width of this Image
void	mkRandom() Sets this Image to random Data
static Image	open(java.lang.String filename) Static Method that allows you to open a file, just pass in the path/filename.
static Image	open(java.lang.String filename, Image.ImageType type) Static Method that allows you to open a file, just pass in the path/filename.
void	paste(int x, int y, Image img) Paste the given Image object onto this Image If the given Image is taller or wider then this Image we only merge the visible bits onto this Image
Image	resize(int width, int height) This resizes the Image, uses the Nearest Neighbor scaler, and keeps aspect ratio
Image	resize(int width, int height, boolean keepAspect) This resizes the Image, uses the Nearest Neighbor scaler, and keeps aspect ratio
Image	resize(int width, int height, boolean keepAspect, Image.ScaleType st) This resizes the Image
void	save(java.lang.String filename) Save the image to the given file name.
void	save(java.lang.String filename, Image.ImageType type) Save the image to the given file name.
protected void	setChannel(byte channel, byte[] array)
void	setPixel(int x, int y, Image.Color c) Set a pixel in this image to a given Color
void	setPixelInChannel(int x, int y, byte c, byte p)
byte[]	toArray() Outputs this image to a ByteArray.
java.awt.image.BufferedImage	toBufferedImage() Take the current Image object and make a BufferedImage out of it.
org.eclipse.swt.graphics.ImageData	toImageData() Create an SWT ImageData object based from the current Image object

Methods inherited from class java.lang.Object

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

Field Detail

MODE_L

public static final byte MODE_L

MODE_L is grey scaled image (8 bits per pixel, 1 channel)

See Also:

Constant Field Values

MODE_RGB

public static final byte MODE_RGB

MODE_RGB is an RGB (Red Green Blue) image Each color is its own Channel (24 bits per pixel, 3 channels)

See Also:

Constant Field Values

MODE_RGBA

public static final byte MODE_RGBA

MODE_RGBA is an RGBA (Red Green Blue Alpha) image Each color and alpha has its own Channel (32 bits per pixel, 4 channels)

See Also:

Constant Field Values

Method Detail

create

public static Image create(byte mode,
           int width,
           int height)

Main Method for creating a new Image

Parameters:

mode - Image mode, uses the static bytes Image.MODE_(L, RGB, RGBA)

width - How wide the image should be in pixels

height - How high the Image should be in pixels

Returns:

Returns an Image object

fromByteArray

public static Image fromByteArray(byte mode,
                  int width,
                  int height,
                  byte[] data)
                           throws Image.ImageException

Create an Image object from a byte Array. The byte array must be a single array of bytes representing the mode given (L, RGB, or RGBA)

Parameters:

mode - Image mode, uses the static bytes Image.MODE_(L, RGB, RGBA)

width - How wide the image should be in pixels

height - How high the Image should be in pixels

data - byte[] to use to loading the data

Returns:

Returns an Image object with the provided byte[] set in it

Throws:

Image.ImageException - This happens if the data provided is to large or to small for the (mode/8)*width*height

open

public static Image open(java.lang.String filename)
                  throws Image.ImageException,
                         java.io.IOException

Static Method that allows you to open a file, just pass in the path/filename.

Parameters:

filename - Filename to attempt to open.

Returns:

Returns an Image object from the provided file.

Throws:

Image.ImageException - This can happen if we do not know the type of file we where asked to open.

java.io.IOException - This happens when we can not access the file.

open

public static Image open(java.lang.String filename,
         Image.ImageType type)
                  throws java.io.IOException,
                         Image.ImageException

Static Method that allows you to open a file, just pass in the path/filename.

Parameters:

filename - Filename to attempt to open.

type - Type of file to open used Image.ImageType.(TIFF, PNG, JPEG)

Returns:

Returns an Image object from the provided file.

Throws:

Image.ImageException - This can happen if we do not know the type of file we where asked to open.

java.io.IOException - This happens when we can not access the file.

save

public void save(java.lang.String filename)
          throws java.io.IOException,
                 Image.ImageException

Save the image to the given file name. We determine the type based on the file extension (required)

Parameters:

filename - Path/Name of the file to save

Throws:

java.io.IOException - This happens if we can not save/open that file

Image.ImageException - This happens if we can not figure out the type you want use to save as

save

public void save(java.lang.String filename,
        Image.ImageType type)
          throws java.io.IOException,
                 Image.ImageException

Save the image to the given file name. We determine the type based on the file extension (required)

Parameters:

filename - Path/Name of the file to save

type - Type of file to open used Image.ImageType.(TIFF, PNG, JPEG)

Throws:

java.io.IOException - This happens if we can not save/open that file

Image.ImageException - This happens if we can not figure out the type you want use to save as

fromBufferedImage

public static Image fromBufferedImage(java.awt.image.BufferedImage BI)
                               throws Image.ImageException

Create an Image from a BufferedImage from AWT - The new Image will always be RGBA type

Parameters:

BI - BufferedImage to use to make the Image object

Returns:

returns an Image object based from the BufferedImage

Throws:

Image.ImageException - This happens if there is something wrong with the BufferedImage

toBufferedImage

public java.awt.image.BufferedImage toBufferedImage()
                                             throws Image.ImageException

Take the current Image object and make a BufferedImage out of it. This is always of TYPE_INT_ARGB.

Returns:

BufferedImage

Throws:

Image.ImageException

fromImageData

public static Image fromImageData(org.eclipse.swt.graphics.ImageData data)
                           throws Image.ImageException

This takes ImageData from SWT and makes an Image Object.

Parameters:

data - ImageData object to create an Image object from.

Returns:

An Image Object based from the ImageData provided.

Throws:

Image.ImageException

toImageData

public org.eclipse.swt.graphics.ImageData toImageData()

Create an SWT ImageData object based from the current Image object

Returns:

ImageData object

changeMode

public Image changeMode(byte MODE)
                 throws Image.ImageException

Change the MODE of the current Image. Use the static MODE_ types MODE_RGBA = 4 byte Image with an alpha channel MODE_RGB = 3 byte image MODE_L = 1 byte Image (black and white)

Parameters:

MODE - Sets the Image.MODE_ to change to

Returns:

Returns a new Image Object in that mode (Caution current Image object should be discarded as changes to it could effect the new Image Object

Throws:

Image.ImageException

resize

public Image resize(int width,
           int height)

This resizes the Image, uses the Nearest Neighbor scaler, and keeps aspect ratio

Parameters:

width - new Width

height - new Height

Returns:

new Image object of the given size

resize

public Image resize(int width,
           int height,
           boolean keepAspect)

This resizes the Image, uses the Nearest Neighbor scaler, and keeps aspect ratio

Parameters:

width - new Width

height - new Height

keepAspect - boolean, true means keep aspect, false means dont keep the aspect

Returns:

new Image object of the given size

resize

public Image resize(int width,
           int height,
           boolean keepAspect,
           Image.ScaleType st)

This resizes the Image

Parameters:

width - new Width

height - new Height

keepAspect - boolean, true means keep aspect, false means dont keep the aspect

st - ScaleType to use (see Image.ScaleTypes)

Returns:

new Image object of the given size

fillColor

public void fillColor(Image.Color c)

Fill current Image with this color

Parameters:

c -

setPixel

public void setPixel(int x,
            int y,
            Image.Color c)

Set a pixel in this image to a given Color

Parameters:

x - X position of the pixel

y - Y position of the pixel

c - Color to set the pixel to (see Image.Color)

setPixelInChannel

public void setPixelInChannel(int x,
                     int y,
                     byte c,
                     byte p)

getPixel

public Image.Color getPixel(int x,
                   int y)

The a color for a given pixel

Parameters:

x - X position of the pixel

y - Y position of the pixel

Returns:

Color object of that pixel

getPixelInChannel

public byte getPixelInChannel(int x,
                     int y,
                     byte c)

paste

public void paste(int x,
         int y,
         Image img)
           throws Image.ImageException

Paste the given Image object onto this Image If the given Image is taller or wider then this Image we only merge the visible bits onto this Image

Parameters:

x - X position to start the merge

y - Y position to start the merge

img - Image object to merge

Throws:

Image.ImageException

copy

public Image copy()
           throws Image.ImageException

Throws:

Image.ImageException

cut

public Image cut(int x,
        int y,
        int width,
        int height)
          throws Image.ImageException

Throws:

Image.ImageException

mkRandom

public void mkRandom()

Sets this Image to random Data

setChannel

protected void setChannel(byte channel,
              byte[] array)
                   throws Image.ImageException

Throws:

Image.ImageException

toArray

public byte[] toArray()

Outputs this image to a ByteArray. This has to be constructed so should not be called unless it is needed

Returns:

byte[] of the raw Image data

getBPP

public byte getBPP()

Get the number of bitsPerPixel, this is the same as the Image.MODE_ of the Image

Returns:

byte (8, 24, 32)

getChannels

public byte getChannels()

Returns the number channels in this Image (BPP/8)

Returns:

byte (1, 3, or 4)

getWidth

public int getWidth()

Returns the width of this Image

Returns:

Image Width (int)

getHeight

public int getHeight()

Returns the height of this Image

Returns:

Image Height (int)