stanford.androidlib.graphics

Class GDimension

java.lang.Object

stanford.androidlib.graphics.GDimension

All Implemented Interfaces:

Serializable

public class GDimension
extends Object
implements Serializable

This class is a double-precision version of the Dimension class in java.awt.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GDimension() Constructs a new dimension object with zero values for width and height.
GDimension(float width, float height) Constructs a new dimension object with the specified components.
GDimension(GDimension size) Constructs a new GDimension object from an existing one.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests whether two GDimension objects are equal.
float	getHeight() Returns the height of this GDimension.
GDimension	getSize() Returns a new GDimension object equal to this one.
float	getWidth() Returns the width of this GDimension.
int	hashCode() Returns an integer hash code for the dimension object.
void	setSize(float width, float height) Sets the components of the dimension object from the specified parameters.
void	setSize(GDimension size) Sets the width and height of one GDimension object equal to that of another.
String	toString() Converts this GDimension to its string representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GDimension

public GDimension()

Constructs a new dimension object with zero values for width and height.

Usage:

dim = new GDimension();

GDimension

public GDimension(float width,
                  float height)

Constructs a new dimension object with the specified components.

Parameters:

width - The width of the dimension object

height - The height of the dimension object

Usage:

dim = new GDimension(width, height);

GDimension

public GDimension(GDimension size)

Constructs a new GDimension object from an existing one.

Parameters:

size - An existing GDimension object specifying the size

Usage:

dim = new GDimension(size);

Method Detail

getWidth

public float getWidth()

Returns the width of this GDimension.

Returns:

The width of this GDimension

Usage:

width = dim.getWidth();

getHeight

public float getHeight()

Returns the height of this GDimension.

Returns:

The height of this GDimension

Usage:

height = dim.getHeight();

setSize

public void setSize(float width,
                    float height)

Sets the components of the dimension object from the specified parameters.

Parameters:

width - The new width of the dimension object

height - The new height of the dimension object

Usage:

dim.setSize(width, height);

setSize

public void setSize(GDimension size)

Sets the width and height of one GDimension object equal to that of another.

Parameters:

size - A GDimension object specifying the new size

Throws:

NullPointerException - if size is null

Usage:

dim.setSize(size);

getSize

public GDimension getSize()

Returns a new GDimension object equal to this one.

Returns:

A new GDimension object with the same size

Usage:

size = dim.getSize();

hashCode

public int hashCode()

Returns an integer hash code for the dimension object. The hash code for a GDimension is constructed from the hash codes from the float values of the width and height, which are the ones used in the equals method.

Overrides:

hashCode in class Object

Returns:

The hash code for this dimension object

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

Usage:

hash = dim.hashCode();

Noshow:

equals

public boolean equals(Object obj)

Tests whether two GDimension objects are equal. Because floating-point values are inexact, this method checks for equality by comparing the float values (rather than the float values) of the coordinates.

Overrides:

equals in class Object

Parameters:

obj - Any object

Returns:

true if the obj is a GDimension equal to this one, and false otherwise

See Also:

Object.hashCode(), HashMap

Usage:

if (dim.equals(obj)) . . .

Noshow:

toString

public String toString()

Converts this GDimension to its string representation.

Overrides:

toString in class Object

Returns:

A string representation of this dimension object

Usage:

str = dim.toString();

Noshow: