Media

Class Picture

java.lang.Object

java.util.Observable

Media.Picture

All Implemented Interfaces:

java.lang.Iterable<Pixel>

public class Picture
extends java.util.Observable
implements java.lang.Iterable<Pixel>

This class represents a picture that can be displayed on the screen. A picture is a 2-dimensional (height,width) collection of pixels each having a color that can be displayed on a screen and stored as a JPG in a file.

Version:

1.0 (06/06/02), 2.0 (08/06/01), 3.0 (08/08/26), 4.0 (09/05/04), 5.0 (09/06/30), 6.0 (10/09/02), 7.0 ( 10/06/14)

Author:

Michael Pickard, Andrew Cheesman, David Hughes, David Hughes, David Hughes, David Hughes, David Hughes

Constructor Summary

Constructors

Constructor and Description
Picture() Create a picture from a file provided by a dialog.
Picture(int width, int height) This constructor creates a new blank (white) picture of sepcified width & height.
Picture(java.lang.String fileName) Create a picture with the specified filename

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() This method returns the file of the picture or null if there is no associated file.
int	getHeight() This method returns the height of the Picture
Pixel	getPixel(int x, int y) This method returns a single Pixel object
int	getWidth() This method returns the width of the Picture
boolean	hasNext() This method returns true if there is at least one more pixel that hasn't been accessed via the default iterator.
java.util.Iterator<Pixel>	iterator() Creates and returns a new Iterator to iterate through the pixels.
Pixel	next() This method returns the next Pixel in the picture.
void	save() This method saves the image with the filename provided by the dialog.
void	save(java.lang.String filename) Saves the picture to the specified file
void	setCanvas(BasicIO.GeneralCanvas gc) Used by BasicForm.
void	setJFrame(javax.swing.JFrame frame) Used by BasicForm.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Picture

public Picture()

Create a picture from a file provided by a dialog.

Picture

public Picture(java.lang.String fileName)

Create a picture with the specified filename

Parameters:

fileName - the name and directory of the picture file

Picture

public Picture(int width,
               int height)

This constructor creates a new blank (white) picture of sepcified width & height.

Parameters:

width - width of blank picture

height - height of blank picture

Method Detail

setJFrame

public void setJFrame(javax.swing.JFrame frame)

Used by BasicForm. Tells the Picture which JFrame it is on, so that it may refresh the JFrame when updates are made to the image so they can be seen in real time.

Parameters:

frame - the JFrame which the picture is on

setCanvas

public void setCanvas(BasicIO.GeneralCanvas gc)

Used by BasicForm. This method informs the Picture of which Canvas it is being drawn to so it can inform the individual pixels and pixel changes can be seen in real time.

Parameters:

gc - the canvas the picture is being drawn to

getFile

public java.io.File getFile()

This method returns the file of the picture or null if there is no associated file. - DH

Returns:

File file associated with picture

getWidth

public int getWidth()

This method returns the width of the Picture

Returns:

int (the width of the picture)

getHeight

public int getHeight()

This method returns the height of the Picture

Returns:

int (the height of the picture)

getPixel

public Pixel getPixel(int x,
                      int y)

This method returns a single Pixel object

Parameters:

x - (the x-coordinate of the desired Pixel)

y - (the y-coordinate of the desired Pixel)

Returns:

Pixel the Pixel at the given x, y coordinate

save

public void save()

This method saves the image with the filename provided by the dialog.

save

public void save(java.lang.String filename)

Saves the picture to the specified file

Parameters:

filename - the file name and directory of where to save the image.

iterator

public java.util.Iterator<Pixel> iterator()

Creates and returns a new Iterator to iterate through the pixels.

Specified by:

iterator in interface java.lang.Iterable<Pixel>

hasNext

public boolean hasNext()

This method returns true if there is at least one more pixel that hasn't been accessed via the default iterator.

Returns:

boolean true if there is another pixel

next

public Pixel next()

This method returns the next Pixel in the picture.

Returns:

Pixel the next pixel