Class Shape

Object
   |
   +--Shape

Direct Known Subclasses:

Circle, Rectangle, Hexagon

class Shape

This is the basic Shape class. It can be considered an abstract class, even though no such thing really existing in JavaScript
Defined in test.js

Field Detail

border

int border

The border of this shape.

color

Color color

The color of this shape

Shape

Shape()

Construct a new Shape object.

Returns:
A new shape

Throws:
- MemoryException if there is no more memory
- GeneralShapeException rarely (if ever)

addReference

 <private> void addReference()

This is a private method, just used here as an example

clone

Shape clone()

Clone this shape

Returns:
A copy of this shape

Author: Gabriel Reid

getClassName

String getClassName()

This is an example of a function that is not given as a property of a prototype, but instead it is assigned within a constructor. For inner functions like this to be picked up by the parser, the function that acts as a constructor must be denoted with the @constructor tag in its comment.

getColor

Color getColor()

Get the color of this shape.

See:
- setColor()

getCoords

Coordinate getCoords()

Get the coordinates of this shape. It is assumed that we're always talking about shapes in a 2D location here.

Returns:
A Coordinate object representing the location of this Shape

Requires:
- The shape class

setColor

void setColor(<Color> color)

Set the color for this Shape

Parameters:
color - The color to set for this Shape
other - There is no other param, but it can still be documented if optional parameters are used

See:
- setColor()
Throws:
- NonExistantColorException (no, not really!)

setCoords

void setCoords(<Coordinate> coordinates)

Set the coordinates for this Shape

Parameters:
coordinates - The coordinates to set for this Shape