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(int width, int height) Constructs and shows a canvas with specific width and height.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(CanvasObject canvasObject) Adds a canvas object to the canvas at position (0, 0).
void	add(CanvasObject canvasObject, int x, int y) Adds a canvas object to the canvas at position (x, y).
void	addMouseListener(java.awt.event.MouseListener listener) Registers a java.awt.event.MouseMotionListener object to the canvas.
void	addMouseMotionListener(java.awt.event.MouseMotionListener listener) Registers a java.awt.event.MouseListener object to the canvas.
int	getCanvasHeight() Returns the height of the canvas.
int	getCanvasWidth() Returns the width of the canvas.
javax.swing.JPanel	getPanel() Gets the JPanel of the canvas.
void	remove(CanvasObject canvasObject) Removes a specific canvas object that is added to the canvas.
void	removeAll() Removes all canvas objects on the canvas.
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.

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(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.

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.

add

public void add(CanvasObject canvasObject)

Adds a canvas object to the canvas at position (0, 0).

Parameters:

canvasObject - The canvas object to be added (e.g. barcode, colorimage, text)

add

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

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

Parameters:

canvasObject - The canvas object to be added (e.g. barcode, colorimage, text).

x - The x position of the canvas object.

y - The y position of the canvas object.

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 canvas objects on the canvas. The canvas will show the default background color after removal.

remove

public void remove(CanvasObject canvasObject)

Removes a specific canvas object that is added to the canvas.

Parameters:

canvasObject - The canvas object to be removed from the canvas.

addMouseMotionListener

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

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

Parameters:

listener - the MouseListener object to be registered.

addMouseListener

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

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

Parameters:

listener - the MouseMotionListener object to be registered.

getPanel

public javax.swing.JPanel getPanel()

Gets the JPanel of the canvas.

Returns:

The JPanel of the canvas.