comp102x

Class Canvas

java.lang.Object

comp102x.Canvas

public class Canvas
extends java.lang.Object

The Canvas class provides method for showing images on a canvas area.

Author:

leofan

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT
static int	DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor and Description
Canvas() Constructs and shows a canvas with size 800 x 600.
Canvas(boolean isVisible) Constructs a canvas with size 800 x 600 with an option to set it visible or not.
Canvas(int width, int height) Constructs and shows a canvas with specific width and height.
Canvas(int width, int height, boolean isVisible) Constructs and shows a canvas with specific width and height.

Method Summary

Modifier and Type	Method and Description
void	add(CanvasObject canvasObject) Adds a CanvasObject instance to the canvas.
void	add(CanvasObject canvasObject, int x, int y) Adds a CanvasObject instance to the canvas at position (x, y).
void	addMouseListener(java.awt.event.MouseListener listener) Registers a java.awt.event.MouseListener instance to the canvas.
void	addMouseMotionListener(java.awt.event.MouseMotionListener listener) Registers a java.awt.event.MouseMotionListener instance to the canvas.
int	getCanvasHeight() Returns the height of the canvas.
int	getCanvasWidth() Returns the width of the canvas.
javax.swing.JFrame	getJFrame() Gets the JFrame of the Canvas.
javax.swing.JPanel	getJPanel() Gets the JPanel of the canvas.
void	remove(CanvasObject canvasObject) Removes a specific CanvasObject instance that is added to the canvas.
void	removeAll() Removes all CanvasObject instances on the canvas.
void	repaint() Calls the repaint method of the inner panel.
void	saveCanvasImage() Save a snapshot of the canvas to an image with save file dialog.
void	saveCanvasImage(java.lang.String filename) Save a snapshot of the canvas to an image with filename specified.
void	setComponentAtBottom(javax.swing.JComponent component) Adds a JComponent at the bottom of the canvas.
void	setComponentAtTop(javax.swing.JComponent component) Adds a JComponent at the top of the canvas.
void	setResizable(boolean isResizable) Sets if the canvas is resizable.
void	setVisible(boolean isVisible) Sets if the canvas is visible.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

Canvas

public Canvas()

Constructs and shows a canvas with size 800 x 600.

Canvas

public Canvas(boolean isVisible)

Constructs a canvas with size 800 x 600 with an option to set it visible or not.

Parameters:

isVisible - Whether the canvas is visible or not.

Canvas

public Canvas(int width,
              int height)

Constructs and shows a canvas with specific width and height.

Parameters:

width - The width of the canvas to be constructed.

height - The height of the canvas to be constructed.

Canvas

public Canvas(int width,
              int height,
              boolean isVisible)

Constructs and shows a canvas with specific width and height.

Parameters:

width - The width of the canvas to be constructed.

height - The height of the canvas to be constructed.

isVisible - Set if the canvas is visible by default.

Method Detail

getCanvasWidth

public int getCanvasWidth()

Returns the width of the canvas.

Returns:

The width of the canvas.

getCanvasHeight

public int getCanvasHeight()

Returns the height of the canvas.

Returns:

the height of the canvas.

setResizable

public void setResizable(boolean isResizable)

Sets if the canvas is resizable.

Parameters:

isResizable - Flag indicating whether the canvas is resizable.

setVisible

public void setVisible(boolean isVisible)

Sets if the canvas is visible.

Parameters:

isVisible - Flag indicating whether the canvas is visible.

add

public void add(CanvasObject canvasObject)

Adds a CanvasObject instance to the canvas. The position of which the instance is added is the current (x, y) position stored inside the instance. The default (x, y) position of a CanvasObject instance is (0, 0).

Parameters:

canvasObject - The CanvasObject instance to be added (e.g. barcode, colorimage, text)

add

public void add(CanvasObject canvasObject,
                int x,
                int y)

Adds a CanvasObject instance to the canvas at position (x, y).

Parameters:

canvasObject - The CanvasObject instance to be added (e.g. barcode, colorimage, text).

x - The x position on the canvas for adding the CanvasObject instance.

y - The y position on the canvas for adding the CanvasObject instance.

setComponentAtTop

public void setComponentAtTop(javax.swing.JComponent component)

Adds a JComponent at the top of the canvas.

Parameters:

component - The JComponent to be added.

setComponentAtBottom

public void setComponentAtBottom(javax.swing.JComponent component)

Adds a JComponent at the bottom of the canvas.

Parameters:

component - The JComponent to be added.

removeAll

public void removeAll()

Removes all CanvasObject instances on the canvas. The canvas will show the default background color after removal.

remove

public void remove(CanvasObject canvasObject)

Removes a specific CanvasObject instance that is added to the canvas.

Parameters:

canvasObject - The CanvasObject instance to be removed from the canvas.

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener listener)

Registers a java.awt.event.MouseMotionListener instance to the canvas.

Parameters:

listener - the MouseMotionListener instance to be registered.

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)

Registers a java.awt.event.MouseListener instance to the canvas.

Parameters:

listener - the MouseListener instance to be registered.

getJPanel

public javax.swing.JPanel getJPanel()

Gets the JPanel of the canvas.

Returns:

The JPanel of the canvas.

getJFrame

public javax.swing.JFrame getJFrame()

Gets the JFrame of the Canvas.

Returns:

The JFrame of the Canvas.

repaint

public void repaint()

Calls the repaint method of the inner panel.

saveCanvasImage

public void saveCanvasImage()

Save a snapshot of the canvas to an image with save file dialog.

saveCanvasImage

public void saveCanvasImage(java.lang.String filename)

Save a snapshot of the canvas to an image with filename specified.