Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt

Class Dimension

java.lang.Object
|
+--java.awt.geom.Dimension2D
   |
   +--java.awt.Dimension

All Implemented Interfaces:

Serializable, Cloneable


public class Dimension

extends Dimension2D

implements Serializable

This class holds a width and height value pair. This is used in plenty of windowing classes, but also has geometric meaning.

It is valid for a dimension to have negative width or height; but it is considered to have no area. Therefore, the behavior in various methods is undefined in such a case.

There are some public fields; if you mess with them in an inconsistent manner, it is your own fault when you get invalid results. Also, this class is not threadsafe.

Since:Authors:See Also:

Field Summary

intheight

The height of this object.
intwidth

The width of this object.

Constructor Summary

Dimension()

Create a new Dimension with a width and height of zero.
Dimension(java.awt.Dimension d)

Create a new Dimension with width and height identical to that of the specified dimension.
Dimension(int w, int h)

Create a new Dimension with the specified width and height.

Method Summary

booleanequals(java.lang.Object obj)

Tests this object for equality against the specified object.
doublegetHeight()

Gets the height of this dimension.
java.awt.DimensiongetSize()

Returns the size of this dimension.
doublegetWidth()

Gets the width of this dimension.
inthashCode()

Return the hashcode for this object.
voidsetSize(double w, double h)

Sets the size of this dimension.
voidsetSize(java.awt.Dimension d)

Sets the width and height of this object to match that of the specified object.
voidsetSize(int w, int h)

Sets the width and height of this object to the specified values.
java.lang.StringtoString()

Returns a string representation of this object.

Field Details

height

public int height

The height of this object.

See Also:


width

public int width

The width of this object.

See Also:


Constructor Details

Dimension

public Dimension()

Create a new Dimension with a width and height of zero.


Dimension

public Dimension(int w, int h)

Create a new Dimension with the specified width and height.

Parameters:


Dimension

public Dimension(java.awt.Dimension d)

Create a new Dimension with width and height identical to that of the specified dimension.

Parameters:

Throws:


Method Details

equals

public boolean equals(java.lang.Object obj)

Tests this object for equality against the specified object. This will be true if and only if the specified object is an instance of Dimension2D, and has the same width and height.

Parameters:

Returns:


getHeight

public double getHeight()

Gets the height of this dimension.

Returns:


getSize

public Dimension getSize()

Returns the size of this dimension. A pretty useless method, as this is already a dimension.

Since:Returns:

See Also:


getWidth

public double getWidth()

Gets the width of this dimension.

Returns:


hashCode

public int hashCode()

Return the hashcode for this object. It is not documented, but appears to be ((width + height) * (width + height + 1) / 2) + width.

Returns:


setSize

public void setSize(double w, double h)

Sets the size of this dimension. The values are rounded to int.

Since:Parameters:


setSize

public void setSize(int w, int h)

Sets the width and height of this object to the specified values.

Parameters:


setSize

public void setSize(java.awt.Dimension d)

Sets the width and height of this object to match that of the specified object.

Since:Parameters:

Throws:

See Also:


toString

public String toString()

Returns a string representation of this object. The format is: getClass().getName() + "[width=" + width + ",height=" + height + ']'.

Returns: