Class SimplePicture

java.lang.Object
  SimplePicture

All Implemented Interfaces:

DigitalPicture

Direct Known Subclasses:

Picture

public class SimplePicture
extends java.lang.Object
implements DigitalPicture

A class that represents a simple picture. A simple picture may have an associated file name and a title. A simple picture has pixels, width, and height. A simple picture uses a BufferedImage to hold the pixels. You can show a simple picture in a PictureFrame (a JFrame). Copyright Georgia Institute of Technology 2004

Author:

Barb Ericson ericson@cc.gatech.edu

Constructor Summary

SimplePicture()
A Constructor that takes no arguments.

SimplePicture(int width, int height)
A constructor that takes the width and height desired for a picture and creates a buffered image of that size.

SimplePicture(int width, int height, java.awt.Color theColor)
A constructor that takes the width and height desired for a picture and creates a buffered image of that size.

SimplePicture(SimplePicture copyPicture)
A Constructor that takes a picture to copy information from

SimplePicture(java.lang.String fileName)
A Constructor that takes a file name and uses the file to create a picture

Method Summary

void	addMessage(java.lang.String message, int xPos, int yPos) Method to draw a message as a string on the buffered image
void	copyPicture(SimplePicture sourcePicture) Method that will copy all of the passed source picture into the current picture object
java.awt.Graphics2D	createGraphics() Method to get a Graphics2D object for this picture which can be used to do 2D drawing on the picture
void	drawString(java.lang.String text, int xPos, int yPos) Method to draw a string at the given location on the picture
void	explore() Method to open a picture explorer on a copy of this simple picture
int	getBasicPixel(int x, int y) Method to return the pixel value as an int for the given x and y location
java.awt.image.BufferedImage	getBufferedImage() Method to get the buffered image
java.lang.String	getExtension() Method to get the extension for this picture
java.lang.String	getFileName() Method to get the file name associated with the picture
java.awt.Graphics	getGraphics() Method to get a graphics object for this picture to use to draw on
int	getHeight() Method to get the height of the picture in pixels
java.awt.Image	getImage() Method to get an image from the picture
static java.lang.String	getMediaPath(java.lang.String fileName) Method to get the directory for the media
PictureFrame	getPictureFrame() Method to get the picture frame for the picture
Picture	getPictureWithHeight(int height) Method to create a new picture of the passed height.
Pixel	getPixel(int x, int y) Method to get a pixel object for the given x and y location
Pixel[]	getPixels() Method to get a one-dimensional array of Pixels for this simple picture
java.lang.String	getTitle() Method to get the title of the picture
java.awt.geom.Rectangle2D	getTransformEnclosingRect(java.awt.geom.AffineTransform trans) Method to get the coordinates of the enclosing rectangle after this transformation is applied to the current picture
int	getWidth() Method to get the width of the picture in pixels
void	hide() Method to hide the picture
void	load(java.awt.Image image) Method to load the buffered image with the passed image
boolean	load(java.lang.String fileName) Method to write the contents of the picture to a file with the passed name without throwing errors
boolean	loadImage(java.lang.String fileName) Method to load the picture from the passed file name this just calls load(fileName) and is for name compatibility
void	loadOrFail(java.lang.String fileName) Method to load the picture from the passed file name
boolean	loadPictureAndShowIt(java.lang.String fileName) Method to load a picture from a file name and show it in a picture frame
void	repaint() Method to force the picture to redraw itself.
void	setAllPixelsToAColor(java.awt.Color color) Method to set the color in the picture to the passed color
void	setBasicPixel(int x, int y, int rgb) Method to set the value of a pixel in the picture from an int
static void	setMediaPath(java.lang.String directory) Method to set the media path by setting the directory to use
void	setPictureFrame(PictureFrame pictureFrame) Method to set the picture frame for this picture
void	setTitle(java.lang.String title) Method to set the title for the picture
void	setVisible(boolean flag) Method to make this picture visible or not
void	show() Method to show the picture in a picture frame
java.lang.String	toString() Method to return a string with information about this picture
boolean	write(java.lang.String fileName) Method to write the contents of the picture to a file with the passed name without throwing errors
void	writeOrFail(java.lang.String fileName) Method to write the contents of the picture to a file with the passed name

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePicture

public SimplePicture()

A Constructor that takes no arguments. All fields will be null. A no-argument constructor must be given in order for a class to be able to be subclassed. By default all subclasses will implicitly call this in their parent's no argument constructor unless a different call to super() is explicitly made as the first line of code in a constructor.

SimplePicture

public SimplePicture(java.lang.String fileName)

A Constructor that takes a file name and uses the file to create a picture

Parameters:

fileName - the file name to use in creating the picture

SimplePicture

public SimplePicture(int width,
                     int height)

A constructor that takes the width and height desired for a picture and creates a buffered image of that size. This constructor doesn't show the picture.

Parameters:

width - the desired width

height - the desired height

SimplePicture

public SimplePicture(int width,
                     int height,
                     java.awt.Color theColor)

A constructor that takes the width and height desired for a picture and creates a buffered image of that size. It also takes the color to use for the background of the picture.

Parameters:

width - the desired width

height - the desired height

theColor - the background color for the picture

SimplePicture

public SimplePicture(SimplePicture copyPicture)

A Constructor that takes a picture to copy information from

Parameters:

copyPicture - the picture to copy from

Method Detail

getExtension

public java.lang.String getExtension()

Method to get the extension for this picture

Returns:

the extendsion (jpg or bmp)

copyPicture

public void copyPicture(SimplePicture sourcePicture)

Method that will copy all of the passed source picture into the current picture object

Parameters:

sourcePicture - the picture object to copy

setAllPixelsToAColor

public void setAllPixelsToAColor(java.awt.Color color)

Method to set the color in the picture to the passed color

Parameters:

color - the color to set to

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

Method to get the buffered image

Specified by:

getBufferedImage in interface DigitalPicture

Returns:

the buffered image

getGraphics

public java.awt.Graphics getGraphics()

Method to get a graphics object for this picture to use to draw on

Returns:

a graphics object to use for drawing

createGraphics

public java.awt.Graphics2D createGraphics()

Method to get a Graphics2D object for this picture which can be used to do 2D drawing on the picture

getFileName

public java.lang.String getFileName()

Method to get the file name associated with the picture

Specified by:

getFileName in interface DigitalPicture

Returns:

the file name associated with the picture

getTitle

public java.lang.String getTitle()

Method to get the title of the picture

Specified by:

getTitle in interface DigitalPicture

Returns:

the title of the picture

setTitle

public void setTitle(java.lang.String title)

Method to set the title for the picture

Specified by:

setTitle in interface DigitalPicture

Parameters:

title - the title to use for the picture

getWidth

public int getWidth()

Method to get the width of the picture in pixels

Specified by:

getWidth in interface DigitalPicture

Returns:

the width of the picture in pixels

getHeight

public int getHeight()

Method to get the height of the picture in pixels

Specified by:

getHeight in interface DigitalPicture

Returns:

the height of the picture in pixels

getPictureFrame

public PictureFrame getPictureFrame()

Method to get the picture frame for the picture

Returns:

the picture frame associated with this picture (it may be null)

setPictureFrame

public void setPictureFrame(PictureFrame pictureFrame)

Method to set the picture frame for this picture

Parameters:

pictureFrame - the picture frame to use

getImage

public java.awt.Image getImage()

Method to get an image from the picture

Specified by:

getImage in interface DigitalPicture

Returns:

the buffered image since it is an image

getBasicPixel

public int getBasicPixel(int x,
                         int y)

Method to return the pixel value as an int for the given x and y location

Specified by:

getBasicPixel in interface DigitalPicture

Parameters:

x - the x coordinate of the pixel

y - the y coordinate of the pixel

Returns:

the pixel value as an integer (alpha, red, green, blue)

setBasicPixel

public void setBasicPixel(int x,
                          int y,
                          int rgb)

Method to set the value of a pixel in the picture from an int

Specified by:

setBasicPixel in interface DigitalPicture

Parameters:

x - the x coordinate of the pixel

y - the y coordinate of the pixel

rgb - the new rgb value of the pixel (alpha, red, green, blue)

getPixel

public Pixel getPixel(int x,
                      int y)

Method to get a pixel object for the given x and y location

Specified by:

getPixel in interface DigitalPicture

Parameters:

x - the x location of the pixel in the picture

y - the y location of the pixel in the picture

Returns:

a Pixel object for this location

getPixels

public Pixel[] getPixels()

Method to get a one-dimensional array of Pixels for this simple picture

Returns:

a one-dimensional array of Pixel objects starting with y=0 to y=height-1 and x=0 to x=width-1.

load

public void load(java.awt.Image image)

Method to load the buffered image with the passed image

Specified by:

load in interface DigitalPicture

Parameters:

image - the image to use

show

public void show()

Method to show the picture in a picture frame

Specified by:

show in interface DigitalPicture

hide

public void hide()

Method to hide the picture

setVisible

public void setVisible(boolean flag)

Method to make this picture visible or not

Parameters:

flag - true if you want it visible else false

explore

public void explore()

Method to open a picture explorer on a copy of this simple picture

repaint

public void repaint()

Method to force the picture to redraw itself. This is very useful after you have changed the pixels in a picture.

loadOrFail

public void loadOrFail(java.lang.String fileName)
                throws java.io.IOException

Method to load the picture from the passed file name

Parameters:

fileName - the file name to use to load the picture from

Throws:

java.io.IOException

load

public boolean load(java.lang.String fileName)

Method to write the contents of the picture to a file with the passed name without throwing errors

Specified by:

load in interface DigitalPicture

Parameters:

fileName - the name of the file to write the picture to

Returns:

true if success else false

loadImage

public boolean loadImage(java.lang.String fileName)

Method to load the picture from the passed file name this just calls load(fileName) and is for name compatibility

Parameters:

fileName - the file name to use to load the picture from

Returns:

true if success else false

addMessage

public void addMessage(java.lang.String message,
                       int xPos,
                       int yPos)

Method to draw a message as a string on the buffered image

Parameters:

message - the message to draw on the buffered image

xPos - the leftmost point of the string in x

yPos - the bottom of the string in y

drawString

public void drawString(java.lang.String text,
                       int xPos,
                       int yPos)

Method to draw a string at the given location on the picture

Parameters:

text - the text to draw

xPos - the left x for the text

yPos - the top y for the text

getPictureWithHeight

public Picture getPictureWithHeight(int height)

Method to create a new picture of the passed height. The aspect ratio of the width and height will stay the same.

Parameters:

height - the desired height

Returns:

the resulting picture

loadPictureAndShowIt

public boolean loadPictureAndShowIt(java.lang.String fileName)

Method to load a picture from a file name and show it in a picture frame

Parameters:

fileName - the file name to load the picture from

Returns:

true if success else false

writeOrFail

public void writeOrFail(java.lang.String fileName)
                 throws java.io.IOException

Method to write the contents of the picture to a file with the passed name

Parameters:

fileName - the name of the file to write the picture to

Throws:

java.io.IOException

write

public boolean write(java.lang.String fileName)

Method to write the contents of the picture to a file with the passed name without throwing errors

Parameters:

fileName - the name of the file to write the picture to

Returns:

true if success else false

setMediaPath

public static void setMediaPath(java.lang.String directory)

Method to set the media path by setting the directory to use

Parameters:

directory - the directory to use for the media path

getMediaPath

public static java.lang.String getMediaPath(java.lang.String fileName)

Method to get the directory for the media

Parameters:

fileName - the base file name to use

Returns:

the full path name by appending the file name to the media directory

getTransformEnclosingRect

public java.awt.geom.Rectangle2D getTransformEnclosingRect(java.awt.geom.AffineTransform trans)

Method to get the coordinates of the enclosing rectangle after this transformation is applied to the current picture

Returns:

the enclosing rectangle

toString

public java.lang.String toString()

Method to return a string with information about this picture

Overrides:

toString in class java.lang.Object

Returns:

a string with information about the picture