CS2114

Class Shape

java.lang.Object

CS2114.Widget

CS2114.Shape

All Implemented Interfaces:

ClickAction

Direct Known Subclasses:

CircleShape, SquareShape, TextShape

public class Shape
extends Widget

Shape Class provides a definition for objects which can be displayed on a Window. This class is an abstract class for students to implement their graphics objects. The color, location, and size can be specified in constructors. The shapes are self contained and support clicking on them, dragging them, and changing the color, size, and location via methods on its interface.

Author:

mapq, maellis, loran

Constructor Summary

Constructors

Constructor and Description
Shape(int x, int y) Builds a Shape at the indicated x and y indices, of default size 50 and color orange.
Shape(int x, int y, java.awt.Color color) Builds a shape of the specified color and indices, with default size 50.
Shape(int x, int y, int size) Builds a shape of the specified size and indices, with default color orange.
Shape(int x, int y, int size, java.awt.Color color) Builds a shape of the specified size, color, and indicies.
Shape(int x, int y, int width, int height) Builds a shape of the specified size and indices, with default color orange.
Shape(int x, int y, int width, int height, java.awt.Color color)

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics2D graph) Draws this shape.
boolean	equals(java.lang.Object obj) Equals method for shapes.
int	getHeight() getter for the height of the shape
int	getWidth() getter for the width of the shape
void	move(int dx, int dy) Changes the Shape's location by the indicated amounts.
void	moveTo(int x, int y) Sets the Shape's location to be the indicated indices.
void	onClick(Command scl) onClick third version of this method, this one uses a listener object of type Command.
void	onClick(java.lang.Object object, java.lang.String methodName) onClick - another version of callOnClick, this one specifies the method to call in the parameter.
void	onTimer(int interval, Command cmd) Animate this Object.
void	onTimer(int interval, java.lang.Object obj, java.lang.String method) Animate this object.
void	remove()
void	stopTimer() Stops the timer on this shape, if it exists, and sets it to null.

Methods inherited from class CS2114.Widget

collidesWith, contains, getBackgroundColor, getBounds, getForegroundColor, getWindow, getX, getY, onClick, repaint, setBackgroundColor, setForegroundColor, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

Shape

public Shape(int x,
             int y)

Builds a Shape at the indicated x and y indices, of default size 50 and color orange.

Parameters:

x - the x index in pixels

y - the y index in pixels

Shape

public Shape(int x,
             int y,
             int size)

Builds a shape of the specified size and indices, with default color orange.

Parameters:

x - the x index in pixels

y - the y index in pixels

size - the width and height of the shape

Shape

public Shape(int x,
             int y,
             int width,
             int height)

Builds a shape of the specified size and indices, with default color orange.

Parameters:

x - - the x index in pixels

y - - the y index in pixels

width - - the width of the shape

height - - the height of the shape

Shape

public Shape(int x,
             int y,
             int width,
             int height,
             java.awt.Color color)

Shape

public Shape(int x,
             int y,
             java.awt.Color color)

Builds a shape of the specified color and indices, with default size 50.

Parameters:

x - the x index in pixels

y - the y index in pixels

color - the Color of the shape

Shape

public Shape(int x,
             int y,
             int size,
             java.awt.Color color)

Builds a shape of the specified size, color, and indicies.

Parameters:

x - the x index in pixels

y - the y index in pixels

size - the width and height of the shape

color - the Color of the shape

Method Detail

equals

public boolean equals(java.lang.Object obj)

Equals method for shapes. accepts other shapes as equivalent if they have the same (x, y) coordinate, the same width and height, and the same color. The argument here is if two distinct shapes had these factors in common, they would be indistingushable in the GUI.

Overrides:

equals in class java.lang.Object

Parameters:

obj - other Object to compare to

Returns:

true if equal, false otherwise

getWidth

public int getWidth()

getter for the width of the shape

Returns:

width

getHeight

public int getHeight()

getter for the height of the shape

Returns:

height

move

public void move(int dx,
                 int dy)

Changes the Shape's location by the indicated amounts.

Parameters:

dx - the amount in pixels to move along the x axis

dy - the amount in pixels to move along the y axis

moveTo

public void moveTo(int x,
                   int y)

Sets the Shape's location to be the indicated indices.

Parameters:

x - the x index in pixels

y - the y index in pixels

draw

public void draw(java.awt.Graphics2D graph)

Draws this shape. All of the Graphics2D package is available to draw the shape.

Parameters:

graph - graphics object from Swing

onClick

public void onClick(java.lang.Object object,
                    java.lang.String methodName)

Description copied from interface: ClickAction

onClick - another version of callOnClick, this one specifies the method to call in the parameter. All the caveats specified

Specified by:

onClick in interface ClickAction

Overrides:

onClick in class Widget

Parameters:

object - receives the call upon click, can't be null

methodName - name of method to be called, can't be null

See Also:

apply. if the method doesn't exist, this will generate an exception (NoSuchMethod).

onClick

public void onClick(Command scl)

onClick third version of this method, this one uses a listener object of type Command.

Specified by:

onClick in interface ClickAction

Overrides:

onClick in class Widget

Parameters:

scl - command object, can't be null

onTimer

public void onTimer(int interval,
                    java.lang.Object obj,
                    java.lang.String method)

Animate this object.

Parameters:

interval - The delay in milliseconds

obj - the Object to animate

method - the name of the method which provides the animation

onTimer

public void onTimer(int interval,
                    Command cmd)

Animate this Object.

Parameters:

interval - The delay in milliseconds

cmd - the Command to execute on Timer.

stopTimer

public void stopTimer()

Stops the timer on this shape, if it exists, and sets it to null.

remove

public void remove()

Specified by:

remove in class Widget