stanford.androidlib.graphics

Class GRect

java.lang.Object

stanford.androidlib.graphics.GObject

stanford.androidlib.graphics.GRect

All Implemented Interfaces:

GFillable, GResizable, GScalable

public class GRect
extends GObject
implements GFillable, GResizable, GScalable

The GRect class is a graphical object whose appearance consists of a rectangular box.

Constructor Summary

Constructors

Constructor and Description
GRect() Constructs a new 0x0 rectangle, positioned at the origin.
GRect(float width, float height) Constructs a new rectangle with the specified width and height, positioned at the origin.
GRect(float x, float y, float width, float height) Constructs a new rectangle with the specified bounds.

Method Summary

Modifier and Type	Method and Description
GRectangle	getBounds() Returns the bounding box of this object.
Paint	getFillColor() Returns the color used to display the filled region of this object.
float	getHeight() Returns the height of this object as a float-precision value, which is defined to be the height of the bounding box.
GDimension	getSize() Returns the size of this object as a GDimension.
float	getWidth() Returns the width of this object as a float-precision value, which is defined to be the width of the bounding box.
boolean	isFilled() Returns whether this object is filled.
void	paint(Canvas canvas) Implements the paint operation for this graphical object.
void	scale(float sf) Scales the object on the screen by the scale factor sf, which applies in both dimensions.
void	scale(float sx, float sy) Scales the object on the screen by the scale factors sx and sy.
void	setBounds(float x, float y, float width, float height) Changes the bounds of this object to the specified values.
void	setBounds(GRectangle bounds) Changes the bounds of this object to the values from the specified GRectangle.
void	setFillColor(Paint color) Sets the color used to display the filled region of this object.
void	setFilled(boolean fill) Sets whether this object is filled.
void	setSize(float width, float height) Changes the size of this object to the specified width and height.
void	setSize(GDimension size) Changes the size of this object to the specified GDimension.

Methods inherited from class stanford.androidlib.graphics.GObject

contains, contains, getBottomY, getCenterX, getCenterY, getColor, getGCanvas, getLocation, getPaint, getRightX, getX, getY, intersects, isVisible, moveBy, moveByPolar, moveTo, moveTo, moveToPolar, repaint, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setCanvas, setColor, setGCanvas, setLocation, setLocation, setPaint, setRightX, setVisible, setX, setY, toString, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

GRect

public GRect()

Constructs a new 0x0 rectangle, positioned at the origin.

Usage:

GRect grect = new GRect();

GRect

public GRect(float width,
             float height)

Constructs a new rectangle with the specified width and height, positioned at the origin.

Parameters:

width - The width of the rectangle in pixels

height - The height of the rectangle in pixels

Usage:

GRect grect = new GRect(width, height);

GRect

public GRect(float x,
             float y,
             float width,
             float height)

Constructs a new rectangle with the specified bounds.

Parameters:

x - The x-coordinate of the upper left corner

y - The y-coordinate of the upper left corner

width - The width of the rectangle in pixels

height - The height of the rectangle in pixels

Usage:

GRect grect = new GRect(x, y, width, height);

Method Detail

paint

public void paint(Canvas canvas)

Implements the paint operation for this graphical object. This method is not called directly by clients.

Specified by:

paint in class GObject

Noshow:

setFilled

public void setFilled(boolean fill)

Sets whether this object is filled.

Specified by:

setFilled in interface GFillable

Parameters:

fill - true if the object should be filled, false for an outline

Usage:

gobj.setFilled(fill);

isFilled

public boolean isFilled()

Returns whether this object is filled.

Specified by:

isFilled in interface GFillable

Returns:

The color used to display the object

Usage:

if (gobj.isFilled()) . . .

setFillColor

public void setFillColor(Paint color)

Sets the color used to display the filled region of this object.

Specified by:

setFillColor in interface GFillable

Parameters:

color - The color used to display the filled region of this object

Usage:

gobj.setFillColor(color);

getFillColor

public Paint getFillColor()

Returns the color used to display the filled region of this object. If none has been set, getFillColor returns the color of the object.

Specified by:

getFillColor in interface GFillable

Returns:

The color used to display the filled region of this object

Usage:

Color color = gobj.getFillColor();

setSize

public void setSize(float width,
                    float height)

Changes the size of this object to the specified width and height.

Specified by:

setSize in interface GResizable

Parameters:

width - The new width of the object

height - The new height of the object

Usage:

gobj.setSize(width, height);

setSize

public final void setSize(GDimension size)

Changes the size of this object to the specified GDimension.

Specified by:

setSize in interface GResizable

Parameters:

size - A GDimension object specifying the size

Usage:

gobj.setSize(size);

Noshow:

getSize

public GDimension getSize()

Returns the size of this object as a GDimension.

Overrides:

getSize in class GObject

Returns:

The size of this object

Usage:

GDimension size = gobj.getSize();

setBounds

public void setBounds(float x,
                      float y,
                      float width,
                      float height)

Changes the bounds of this object to the specified values.

Specified by:

setBounds in interface GResizable

Parameters:

x - The new x-coordinate for the object

y - The new y-coordinate for the object

width - The new width of the object

height - The new height of the object

Usage:

gobj.setBounds(x, y, width, height);

setBounds

public final void setBounds(GRectangle bounds)

Changes the bounds of this object to the values from the specified GRectangle.

Specified by:

setBounds in interface GResizable

Parameters:

bounds - A GRectangle specifying the new bounds

Usage:

gobj.setBounds(bounds);

getBounds

public GRectangle getBounds()

Returns the bounding box of this object.

Overrides:

getBounds in class GObject

Returns:

The bounding box for this object

Usage:

GRectangle bounds = gobj.getBounds();

getWidth

public float getWidth()

Returns the width of this object as a float-precision value, which is defined to be the width of the bounding box.

Overrides:

getWidth in class GObject

Returns:

The width of this object on the screen

Usage:

float width = gobj.getWidth();

getHeight

public float getHeight()

Returns the height of this object as a float-precision value, which is defined to be the height of the bounding box.

Overrides:

getHeight in class GObject

Returns:

The height of this object on the screen

Usage:

float height = gobj.getHeight();

scale

public void scale(float sx,
                  float sy)

Scales the object on the screen by the scale factors sx and sy.

Specified by:

scale in interface GScalable

Parameters:

sx - The factor used to scale all coordinates in the x direction

sy - The factor used to scale all coordinates in the y direction

Usage:

gobj.scale(sx, sy);

scale

public final void scale(float sf)

Scales the object on the screen by the scale factor sf, which applies in both dimensions.

Specified by:

scale in interface GScalable

Parameters:

sf - The factor used to scale all coordinates in both dimensions

Usage:

gobj.scale(sf);